Interconnect FHIR® Messaging Element Details
Introduction
The Interconnect FHIR product uses the clinically-oriented standard FHIR release 4 for structuring the message exchange. Surescripts Health Information Network requires that you set the Originator Home Community ID to your Home Community ID in the header. This section outlines the HTTP request header and FHIR resource requirements necessary for successful communication between systems.
Requirement Designation
Code | Description |
|---|---|
mandatory | The element must be used per the specification (e.g., XML schema validation). Note: The term mandatory applies to mandatory and required fields in the different standards. For example, FHIR uses the term required. |
conditional | The element must be used per the conditions specified. |
recommended | While optional to send, Surescripts Health Information Network recommends sending the element as a best practice. |
optional | Some fields do not have specific conditions. Data should be sent if available. |
HTTP Request Header Elements
Field | Code | Comment |
|---|---|---|
Accept | mandatory | The Accept request-header field can be used to specify certain media types which are acceptable for the response. Values: application/fhir+xml application/fhir+json application/pdf The FHIR R4 specifications state that documents should be returned based on how they were requested which could be either via Bundles with Base64 encoded contents within a bundle or streamed. The Accept header supports the requested return type:
Note: The use of the “_format” parameter in the retrieve request will override any content output types found in a message header’s Accept field. See the DocumentRetrieveRequest Element RequirementsDocumentRetrieveRequest Element Requirements section for more details. |
Content-Type | mandatory | The Content-Type header is to specify the media type of the content being sent. For more information see the Content Types and EncodingsContent Types and Encodings section below. Values : application/fhir+xml application/fhir+json application/pdf |
Originator-User-Name | mandatory | The name of the user that made or triggered the request. Example: John Smith |
Originator-User-Id | mandatory | The ID of the user making the request that is specific to requesting source system. Example: SMJO1234579 |
Originator-User-Role-Code | mandatory | Code to represent the health care role of the requesting user. Could represent Medical doctor, Pharmacist, etc. Defined by the NHIN specification to be a SNOMED-CT code within code system "2.16.840.1.113883.6.96". Example: 112247003 |
Originator-User-Npi | conditional | This is the National Provider Identifier (NPI) of the Health Care Provider who is triggering the request. When querying for Treatment or TEFCA-Required Treatment Purpose of Use, you must include NPI. Example: 1346792648 |
Originator-Organization-Name | recommended | Name of the organization requesting the patient match. This is needed for the recipient location to display who is making the request and used in HIPAA auditing by those providing patient documents. Example: ABC Medical Software |
Originator-Home-Community-Id | mandatory | Identifying OID for the sender of the patient match request. Many in Carequality use the IHE messaging standard. That standard defines the term Home Community ID. This OID is required on all IHE transactions. Example: urn:oid:1.3.840.86667.42.1 |
Originator-Patient-Identifier | mandatory | The patient identifier for the request’s subject of care. Example: 1002318246 |
Originator-Assigning-Authority | mandatory | The assigning authority for the request’s patient identifier. Example: 2.11.222.3.444444.5.666.7.2 |
Originator-Message-Id | mandatory | Used in message audit and highly valuable for support questions. Surescripts Health Information Network requires the message ID to be globally unique. A maximum length of 255 characters is permitted. Example: 3bb7cae9-e835-4844-a3ae-1c41abcea565 |
Purpose-Of-Use-Code (TEFCA-defined eXchange Purposes (XPs) | mandatory | Specifies the purpose or reason this patient data is being requested. Values are defined by the QHIN Exchange Purposes. The exchange purposes are TREATMENT, PAYMENT, HEALTHCARE OPERATIONS, PUBLIC HEALTH, INDIVIDUAL ACCESS SERVICES, and GOVERNMENT BENEFITS DETERMINATION. More values will be supported in future releases. Notes:
|
CSP | conditional | Field is required for messages with the Individual Access/T-IAS Purpose of use. Field includes the Business Name or URL of the Credentialing Service Provider that was used to identify proof the person that initiated the request. Example: “Credentialing Services Inc.” or “http://www.credentialingservicesing.com” |
Id-Token | conditional | Field is required for messages with the Individual Access/T-IAS Purpose of use. Field includes an encoded string of the OpenID JWT token that the Credentialing Service Provider created while verifying the identity of the person that initiated the request Example: “eyJraWQiOiIwNGI5YzNkNy00ODFiLTQyZjgtOGUwYS0wNDRjNDcxNzE5YzUiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhZGRyZXNzIjp7InN0cmVldF9hZGRyZXNzIjoiMTIzIE1haW4gU3QiLCJsb2NhbGl0eSI6IkFueXRvd24iLCJyZWdpb25hbGl0eSI6IkNBIiwicG9zdGFsX0NvZGUiOiIxMjM0NSIsImNvdW50cnkiOiJVU0EifSwiU1NO…” |
Validated-Attributes | conditional | Field is required for messages with the Individual Access/T-IAS Purpose of use. Field includes a comma or space separated list of codes indicating the user demographics and identifiers that were used to identity proof the person that initiated the request with the Credentialing Service Provider Supported demographic codes include:
Example: lname,fname,address,city,state,email,ssn |
Query-Auth-Grantor | conditional | Field is required for Delegate of Authority messages. Field includes the Home Community ID (ex: urn:oid:1.2.3…) of the Principal organization that has allowed a Delegate organization (whose Home Community ID is found in the Originator-Home-Community-Id field) to send messages using the Principal’s credentials. |
HTTP Request Header Examples
Accept: application/fhir+json
Content-Type: application/fhir+json; charset=UTF-8
Originator-User-Name: John Smith
Originator-User-Id: SMJO1234579
Originator-User-Role-Code: 112247003
Originator-User-Npi: 1346792648
Originator-Organization-Name: ABC Medical Software
Originator-Home-Community-Id: urn:oid:2.11.222.3.444444.5.666
Originator-Patient-Identifier: 1002318246
Originator-Assigning-Authority: 2.11.222.3.444444.5.666.7.2
Originator-Message-Id: 3bb7cae9-e835-4844-a3ae-1c41abcea565
Purpose-Of-Use-Code: T-TRTMNTContent-Type: application/fhir+json;
charset=UTF-8Content Types and Encodings
According to Section 3.1.0.1.9 of the FHIR specification Content Types and encodings,
“The formal MIME-type for FHIR® resources is application/fhir+json or application/fhir+xml. The correct mime type SHALL be used by clients and servers.” Later in that same section, “UTF-8 encoding SHALL be used for the mime type application/fhir. This MAY be specified as a MIME type parameter to the application/fhir mime type, but is not required.”
Because of these requirements, requests/responses will need to include a Content-Type in the HTTP header. Below is an example:
- Content-Type: application/fhir+json; charset=utf-8
Note: charset=utf-8 is not required by Surescripts Health Information Network, but is supported if sent.
Additionally, the Interconnect FHIR product also supports the use of the “_format” parameter as described in Section 3.1.0.1.11 of the FHIR® specification as a way for document requestors to specify their preference to receive requested documents in a format other than what is included in the HTTP header (for situations where a requesting application can control the contents of their requests, but not the HTTP header due to the use of 3rd party communication software or other limitations).
Interconnect FHIR Patient Search and Document Exchange Messaging
PatientSearchRequest Element Requirements
The PatientSearchRequest is a POST message that will use the FHIR® Patient Match operation.
Operation | API Endpoint Description | Description |
|---|---|---|
Patient Match | POST [base]/Patient/$match | Retrieves the patient match information using the included patient demographics. |
The FHIR Patient Match operation is used to perform a search for a patient in Interconnect.
FHIR Resource Hierarchy |
| Cardinality/Description |
|---|---|---|
Parameters |
| Input to a Patient Match is a Parameters resource. |
| Patient | Once fully populated Patient resource is the primary parameter sent in a Patient Match request. |
The table below outlines the requirements for the Parameters resource used in the PatientSearchRequest message.
Note: This guide includes data elements only where Surescripts Health Information Network has specific requirements or further explains the field usage. Refer to the Parameters FHIR resource for a complete list of fields.
Element | Code | Cardinality | Type | Comment |
|---|---|---|---|---|
Parameters | | | Resource | |
parameter | mandatory | 0..* | Backbone Element | A parameter passed to or received from the operation. |
name | mandatory | 1..1 | string | The name of the parameter (reference to the operation definition). Fixed value: resource |
resource | optional | 0..1 | Patient | Information about an individual receiving health care services. Alternate names: SubjectOfCare Client Resident Demographics and other administrative information about an individual receiving care or other health-related services. |
name | mandatory | 0..* | Human Name | A name associated with the patient. |
family | mandatory | 1..1 | string | Family name (often called ‘Surname’). |
given | mandatory | 1..* | string | Given names (not always ‘first’). Includes middle names. |
prefix | optional | 0..* | string | Parts that come before the name. |
suffix | optional | 0..* | string | Parts that come after the name. |
telecom | optional | 0..* | Contact Point | A contact detail for the individual. |
system | optional | 0..1 | code | Telecommunications form for contact point – what communications system is required to make use of the contact. Values: phone | fax | email | pager | url | sms | other |
value | optional | 0..1 | string | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
gender | mandatory | 1..1 | code | Administrative Gender – the gender that the patient is considered to have for administration and record keeping purposes. Values: male | female | other | unknown |
birthDate | mandatory | 1..1 | date | The date of birth of the individual. |
address | recommended | 1..* | Address | An address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods. |
line | recommended | 1..* | string | Street name, number, direction & P.O. Box etc. This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
city | recommended | 1..1 | string | The name of the city, town, suburb, village or other community or delivery center. |
state | recommended | 1..1 | string | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
postal Code | mandatory | 1..1 | string | Postal code for area. |
PatientSearchRequest Message Example
Accept: application/fhir+json
Accept-Encoding: gzip,deflate
Connection: keep-alive
Content-Type: application/fhir+json
Originator-Assigning-Authority: 2.11.222.3.444444.5.666.7.2
Originator-Home-Community-Id: urn:oid:aFRVAy
Originator-Message-Id: 3bb7cae9-e835-4844-a3ae-1c41abcea564
Originator-Organization-Name: ABC Medical Software
Originator-Patient-Identifier: 1002318246
Originator-User-Id: SMJO1234579
Originator-User-Name: ABC User
Originator-User-Role-Code: 106289002
Purpose-Of-Use-Code: TREATMENT
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.5)
X-SSL-Client-Cert-Issuer: ABC Cert Issuer
X-SSL-Client-Cert-Subject: ABC Cert Subject{
"resourceType": "Parameters",
"id": "example-PatientSearchRequest-Parameters",
"parameter": [
{
"name": "resource",
"resource": {
"resourceType": "Patient",
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/v2/0203",
"code": "MR"
}
]
}
}
],
"name": [
{
"family": "SubmittedData",
"given": [
"WillChangeIfFound"
]
}
],
"telecom": [
{
"system": "phone",
"value": "tel:+1-(833)-567-3094",
"use": "home"
}
],
"gender": "female",
"birthDate": "1998-01-15",
"address": [
{
"state": "ID",
"postalCode": "83301"
}
]
}
}
]
}PatientSearchResponse Element Requirements
A successful response body (0 or 1 patient match) returns a FHIR® Bundle resource. It will contain zero or one FHIR® Patient resource depending on whether a match was found or not. Listed below are links to the FHIR® documentation for the resources and web service API endpoint information.
PatientSearchResponse Sample Response Explained
Patient Match Found
FHIR Resource Hierarchy |
| Cardinality Description |
|---|---|---|
Bundle |
| Patient found response will be a Bundle with a single Patient resource. |
| Patient | A Patient resource populated with the Surescripts assigned patient identifier and demographics for the requested patient will be returned. |
No Patient Match Found
FHIR Resource Hierarchy | Cardinality Description |
|---|---|
Bundle | When no error occurs, but no patient match was found by any responder, an empty Bundle will be returned. |
Error Response
FHIR Resource Hierarchy | Cardinality Description |
|---|---|
OperationOutcome | When an error is encountered trying to process the Patient Match request, an OperationOutcome with a diagnostics value containing text with the error description will be returned. |
The table below outlines the requirements for the Bundle resource used in the PatientSearchResponse message.
Note: This guide includes data elements only where Surescripts Health Information Network has specific requirements or further explains the field usage. Refer to the Bundle FHIR resource for a complete list of fields.
Element | Code | Cardinality | Type | Comment |
|---|---|---|---|---|
Bundle | | | Resource | |
entry | mandatory | 0..* | Backbone Element | An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only). |
resource | mandatory | 0..1 | Patient | Information about an individual receiving health care services. Data type: Patient |
PatientSearchResponse Message Example
{
"resourceType": "Bundle",
"id": "example-PatientSearchResponse-Bundle",
"type": "searchset",
"entry": [
{
"resource": {
"resourceType": "Patient",
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/v2/0203",
"code": "MR"
}
]
},
"system": "2.16.840.1.113883.3.2054.2.1",
"value": "253283021"
}
],
"name": [
{
"family": "AmblerAlaska",
"given": [
"PatientFrom"
]
}
],
"telecom": [
{
"system": "phone",
"value": "4582065973",
"use": "home"
}
],
"gender": "female",
"birthDate": "1992-01-24",
"address": [
{
"line": [
"109 Redstone St"
],
"city": "Ambler",
"state": "AK",
"postalCode": "99786"
}
]
}
}
]
}DocumentSearchRequest Element Requirements
API Information
The DocumentSearchRequest is a GET message that will use the following web service API endpoint information.
Operation | API Endpoint Description | Description |
|---|---|---|
Document Search | GET [base]/DocumentReference/?patient= [Surescripts Patient ID]&assigningAuthority=[Surescripts Assinging Authority ID] | Returns a bundle of document references for the requested patient. |
FHIR DocumentSearchRequest URLs can also include parameters known as prefixes that can be used for date-specific searches like this R4 example that specifies a search for documents between 2023-01-01 and 2023-05-31.
https://shin.surescripts.net/fhir/R4/DocumentReference?patient=&period=ge2023-01-01T12:00:01&period=le2023-05-31T11:59:59
The following date-related FHIR prefixes are supported:
'eq', 'ge', 'gt', 'le', 'lt'
(equal, greater than or equal, greater than, less than or equal, less than)
DocumentSearchRequest Message Example
The following URL and HTTP header example would return a response in the JSON format.
https://shin-staging.surescripts.net/fhir/DocumentReference/?patient=33333333&assigningAuthority=2.16.840.1.113883.3.2054.2.1
Accept: application/fhir+json
Accept-Encoding: gzip,deflate
Connection: keep-alive
Content-Type: application/fhir+json
Originator-Assigning-Authority: 2.11.222.3.444444.5.666.7.2
Originator-Home-Community-Id: urn:oid:aFRVAy
Originator-Message-Id: 3bb7cae9-e835-4844-a3ae-1c41abcea564
Originator-Organization-Name: ABC Medical Software
Originator-Patient-Identifier: 1002318246
Originator-User-Id: SMJO1234579
Originator-User-Name: ABC User
Originator-User-Role-Code: 106289002
Purpose-Of-Use-Code: TREATMENT
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.5)
X-SSL-Client-Cert-Issuer: ABC Cert Issuer
X-SSL-Client-Cert-Subject: ABC Cert SubjectDocumentSearchResponse Element Requirements
The DocumentSearch Response uses the FHIR® Bundle, and DocumentReference resources. Listed below are links to the FHIR® documentation for the resources.
Document Search Response Sample Explained
When one or more documents are found for a patient, the Document Search response consists of the following resources.
FHIR Resource Hierarchy |
|
| Cardinality/Description |
|---|---|---|---|
Bundle |
|
| Response with document information will contain 1 bundle. |
| Document Reference |
| There will be one DocumentReference for each document found. |
|
| Patient (contained resource) | Each document will have a single Patient (subject of the document). |
|
| Organization (contained resource) | When author information is included for the document, there will be a single Organization resource with the name of the organization where the document was authored. |
When no documents are found, an OperationOutcome will be returned instead of a Bundle of DocumentReference resources.
The table below outlines the requirements for the Bundle resource used in the DocumentSearchResponse message.
Note: This guide includes data elements only where Surescripts Health Information Network has specific requirements or further explains the field usage. Refer to the Bundle FHIR resource for a complete list of fields.
Element | Code | Cardinality | Type | Comment |
|---|---|---|---|---|
Bundle | | | Resource | |
type | mandatory | 1..1 | code | Indicates the purpose of this bundle – how it is intended to be used. Fixed value: searchset |
entry | mandatory | 0..* | Backbone Element | An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only). |
resource | mandatory | 0..1 | Document Reference | A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text. Comments Usually, this is used for documents other than those defined by FHIR. Data type: DocumentReference |
id | mandatory | 1..1 | string | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
date | optional | 0..1 | instant | When the document reference was created. Comments Referencing/indexing time is used for tracking, organizing versions and searching. Do not use this for creation date of the document itself. For that, use the 'creation' field in the attachment. |
DocumentSearchResponse Message Example
{
"resourceType": "Bundle",
"id": "28728ce6-0b8e-4050-af2e-03eafc148b1a",
"type": "searchset",
"entry": [
{
"resource": {
"resourceType": "DocumentReference",
"id": "ea32197b-b7b4-4838-ac47-a5054762a824",
"contained": [
{
"resourceType": "Patient",
"id": "2009fe26-4210-43bd-a4ee-152432c81a03",
"identifier": [
{
"system": "2.16.840.1.113883.3.3569",
"value": "1200"
}
]
},
{
"resourceType": "Organization",
"id": "c3c0216b-03f8-462c-9b71-fa0b68131eb7",
"name": "Document Author Institution"
},
{
"resourceType": "Practitioner",
"id": "c79fcc02-275e-4a10-b52b-8ba044f7a4a2",
"name": [
{
"family": "Document AuthorPerson"
}
]
}
],
"masterIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "999999999_11561"
},
"identifier": [
{
"use": "official",
"system": "http://www.hl7.org/oid/",
"value": "urn:oid:1.3.6.1.4.1.21367.13.70.108"
}
],
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "56816-2",
"display": "Document Name"
}
]
},
"category": [
{
"coding": [
{
"system": "1.3.6.1.4.1.21367.100.1",
"code": "34117-2",
"display": "History & Physical"
}
]
}
],
"subject": {
"reference": "#2009fe26-4210-43bd-a4ee-152432c81a03"
},
"date": "2022-09-08T19:53:11.2+00:00",
"author": [
{
"reference": "#c3c0216b-03f8-462c-9b71-fa0b68131eb7"
},
{
"reference": "#c79fcc02-275e-4a10-b52b-8ba044f7a4a2"
}
],
"description": "Very Important Document Title",
"securityLabel": [
{
"coding": [
{
"system": "2.16.840.1.113883.5.25",
"code": "N",
"display": "Normal"
}
]
}
],
"content": [
{
"attachment": {
"contentType": "text/xml",
"url": "/Binary?documentId=999999999_11561&repositoryId=3.24.465.32.213.13321.31&homeCommunityId=1.3.6.1.4.1.21367.13.70.108",
"creation": "2022-04-04T00:00:00+00:00"
},
"format": {
"system": "1.3.6.1.4.1.19376.1.2.3",
"code": "urn:ihe:pcc:xphr:2007",
"display": "urn:ihe:pcc:xphr:2007"
}
}
],
"context": {
"period": {
"start": "2022-04-03T05:32:00+00:00",
"end": "2022-04-03T06:31:00+00:00"
}
}
}
}
]
}DocumentRetrieveRequest Element Requirements
API Information
The DocumentRetrieveRequest is a GET message that will use the following web service API endpoint information to retrieve a document through Surescripts.
Operation | API Endpoint Description | Description |
|---|---|---|
Document Retrieve | GET [base]/Binary?documentID=&repository Id>&homeCommunityId= | Returns the document in binary form. |
Note: As a responder you will be responsible for defining the endpoint information and URL for others to retrieve documents from your system. That information is returned in the DocumentSearchResponse from your system.
Content Types and Encodings
According to Section 3.1.0.1.9 of the FHIR® specification Content Types and encodings,
“The formal MIME-type for FHIR® resources is application/fhir+json or application/fhir+xml. The correct mime type SHALL be used by clients and servers.” Later in that same section, “UTF-8 encoding SHALL be used for the mime type application/fhir. This MAY be specified as a MIME type parameter to the application/fhir mime type, but is not required” because FHIR® uses UTF-8 for all request and response bodies. Since the HTTP specification (section 3.7.1) defines a default character encoding of ISO-8859-1, requests and responses SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header. Requests MAY also specify this charset parameter in the Accept header and/or use the Accept-Charset header.”
Because of these requirements, requests/responses will need to include a Content-Type in the HTTP header. Below is an example:
- Content-Type: application/fhir+json; charset=utf-8
Note: charset=utf-8 is not required by Surescripts, but is supported if sent.
Accept Header content v. the_format Request Parameter
The FHIR R4 specifications state that documents should be returned based on how they were requested which could be either via Bundles with Base64 encoded contents within a bundle or as streamed content. The Accept request-header field within a document retrieve request can be used to specify the media types that are acceptable for each response.
- If "application/fhir+xml" or "application/fhir+json" is specified in a request header’s Accept field, the document will be returned via FHIR bundles.
- Documents (ex: CCDAs, PLQs, binary files) that are returned to document requesters via bundles within the FHIR responses need to be Base64 encoded
- If other, ex: "application/pdf" (or other binary types), the requested document will be streamed directly to the requester
Alternatively, the FHIR® SHIN product also supports the use of the “_format” parameter as described in Section 3.1.0.1.11 of the FHIR® specification as a way for document requestors to specify their preference to receive requested documents in a format other than what is included in the HTTP header (for situations where a requesting application can control the contents of their requests, but not the HTTP header due to the use of 3rd party communication software or other limitations).
Request example with “_format” parameter:
https://shin.surescripts.net/fhir/R4/Binary?documentId=CCDA123&repositoryId=urn:
oid:44.5555.66=urn:oid:77.8888.99&
_format=application/fhir+json
Be sure to note that use of the “_format” parameter in the request overrides any media request types specified in a request’s message header Accept field.
DocumentRetrieveRequest Message Example
The following URL and HTTP header example would return a bundled response in the JSON format.
https://shin.surescripts.net/fhir/Binary?documentId=2.16.840.1.113883.3.2054.2.1.128118651&repositoryId=2.16.840.1.113883.3.2054.2.1&homeCommunityId=2.16.840.1.113883.3.2054.2.1
Accept: application/fhir+json
Accept-Encoding: gzip,deflate
Connection: keep-alive
Content-Type: application/fhir+json
Originator-Assigning-Authority: 2.11.222.3.444444.5.666.7.2
Originator-Home-Community-Id: urn:oid:aFRVAy
Originator-Message-Id: 3bb7cae9-e835-4844-a3ae-1c41abcea564
Originator-Organization-Name: ABC Medical Software
Originator-Patient-Identifier: 1002318246
Originator-User-Id: SMJO1234579
Originator-User-Name: ABC User
Originator-User-Role-Code: 106289002
Purpose-Of-Use-Code: TREATMENT
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.5)
X-SSL-Client-Cert-Issuer: ABC Cert Issuer
X-SSL-Client-Cert-Subject: ABC Cert SubjectDocumentRetrieveResponse Element Requirements
Documents will be returned based on how they were requested (see DocumentRetrieveRequest Element RequirementsDocumentRetrieveRequest Element Requirements) which could either be via Bundles with Base64 encoded contents within a bundle, or as content streamed directly to the requestor in the format (without encoding) that was specified by the contentType of the requested document.
The table below outlines the requirements for the Bundle resource used in the DocumentRetrieveResponse message.
Note: This guide includes data elements only where Surescripts Health Information Network has specific requirements or further explains the field usage. Refer to the Bundle FHIR resource for a complete list of fields.
Element | Code | Cardinality | Type | Comment |
|---|---|---|---|---|
Bundle | | | Resource | |
type | mandatory | 1..1 | code | Indicates the purpose of this bundle – how it is intended to be used. Fixed value: searchset |
entry | mandatory | 0..* | Backbone Element | An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only). |
resource | mandatory | 0..1 | Binary | A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc. Comments Typically, Binary resources are used for handling content such as:
Data type: Binary |
DocumentRetrieveResponse Message Example
{
"resourceType": "Bundle",
"id": "f98511eb-a5a2-4ecf-8ee9-c6d35bb3bb99",
"type": "searchset",
"entry": [
{
"resource": {
"resourceType": "Binary",
"id": "16dade3d-e45b-4be4-889b-c0ca65bc9367",
"contentType": "image/jpeg",
"data": "iVBORw0KGgoAAAANSUhEUgAAAmQAAAC0CAYAAAA6sDC6AAAACXBIWXMAAAsSAAALEgHS3X78AAAddUlEQVR4nO3dy3UbR9rGcWjO7IEvAnIiICYCwRGIXmFJKAJBO+wE7bgzFYHIJVcmIxAYgcEIREQwQAT8TslP2+UWLl3VdenL/3cOjz0ai0Bfquqt21tvXl9fBwAAAMjnX9x7AACAvAjIAAAAMiMgAwAAyIyADAAAIDMCMgAAgMwIyAAAADIjIAMAAMiMgAwAACAzAjIAAIDMCMgAAAAyIyADAADIjIAMAAAgMwIyAACAzAjIAAAAMiMgAwAAyIyADAAAIDMCMgAAgMwIyAAAADIjIAMAAMiMgAwAACAzAjIAAIDMCMgAAAAyIyADAADIjIAMAAAgMwIyAACAzAjIAAAAMiMgAwAAyIyADAAAIDMCMgAAgMz+zQPol9F0MRoMBmNdtP3vVWwHg8Fa/912e3+97vGtBAAgmDevr6/czY6xgi7zc65/mj+7iHSlT1awZn5eCNYAAKiOgKwDRtOFCbgm+jH/ftaQq3qygrTV9v76pQHfCQCAxiEga6HRdGFGvS6tIGzYkqvYmMBsMBg8KEDbNuA7AQCQHQFZS2gUbKZArCkjYHU9KTh7YPQMANBnBGQN1tEg7JDnwWBwo+CMkTMAQK8QkDWMFuSbAGwecRF+090NBoPb7f31qqfXDwDoGQKyhtC6sKWCsbasCYtto3vCqBkAoNMIyDIbTRcTjYa96/WNOG6n6cwbAjMAQBcRkGWiQMyM/rxN+A2elS9soN2OtmPTg+UEsvb/Hicc0SMwAwB0EgFZYgkCMTPN96IA60U/69gBjKZcz0vJaGMFawRmAIBOISBLxFojdhXwE3cKvNbFP5sWoOi6x1bS2pCBqLn+5fb++ibg7wQAIDkCssi0a3KunxCjRY8KvlZtPZ5Io4RFYtsQO0nNqOCMXZkAgLYiIItIgcdtzRxif2W3395fPzT+oh1pBK0I0OpubHhUYMY0JgCgVQjIItCo2G2NAGOnv3/bp0O6rRxsdYIzpjEBAK1DQBbYaLq4VDDlMz35qCCscyNhrhSczTTV6zPC+KTRMo5kAgA0HgFZIAogzKL9D46/cWONhhE87KGp35nHhoidgrLeB7gAgGYjIAtAZ07eOi5Qf1bahtvGXljDaL3ZzGODhDmKac7aMgBAUxGQ1TSaLmbKiVU1QHjSGid2BHry3Ln6rNGy3qzJAwC0BwFZDaPp4tZhGo1ALDCPwIwpTABAIxGQeVAgsKo4RUmOrMg8ArOP7MIEADQJAZkjh/VipF9IzPE0hLvt/fWsUzcAANBaBGQOFIytKozCfFEwxiLyDLQr86ZC0GymkS95TgCA3AjIKqqYX+xZu/mYnmyA0XQx14jZqWc2ISgDAOREQFaBdlJ+PfFfft7eXy8b8YXxF01j3p441JygDACQFQHZCRWCMdIptECF0TKCMgBANv/i1h9WIRj7okacYKzhtLliosBrH7PebKUdmwAAJMUI2QEngjHyWbWUAq6bIzsxGSkDACRHQLaHdlP+ceD/ftbOPM6dbLETJywQlAEAkmLKssRKbbHPnRpqgrGW0xmiE412ll0ceQcAAAiOETKLduStD4yasIuyg06cukDyWABAEoyQiRrmhwPB2HuCsW7StOREo59lV6PpgucOAIiOETIZTRcmGHtX+uOd1osxfdUDRw6Lf68pTgAAomCE7M+GeHkgGJsQjPWHpif3jZTdaG0hAABR9H6ETEci/V764x35xfrrQMoTdl4CAKLp9QiZdayOjWCs5zQ9+b50Fy72vCsAAATR9ynL8mHhBGP4QUHZ59LdeKfRMwAAgurtlKXWjX2y/ohgDD/Zs9DfvCdjctEBAELq5QiZFmh/Kv0xB4TjJ3sW+g+VHgUAgGD6OmVZXgv0nnMpcYiCMvtQ8gvykwEAQupdQKaG1M7K/oUcU6hgUgrK5toUAgBAbb0KyNSA2lOVj9v763nGr4SWULqLmXX25ZBdlwCAUPo2QmY3oBs1sEAlWmNovzNv2XUJAAihNwGZEsC+tf7okiSfcKW1hl+sv3ajc1CBTjEzCqPpYsJTBdLoTdqL0XRh0hSc6X9+3N5f32T+Smix0XSxttYifubweXSBOhembrws5Wh8GgwGS46SA+LpxQiZFvIXwdgjwRgCuLTWk31igT/aTumAXpR3b1i6HDO78E15+QBE0PmATD2+YuH+jnVjCEGJYe0NIYyQobVUT672BGJlV6Ppgo1QQAR9GCGbW5XMjHVjCEXpUh71664YJUOLzSsEY4Ul6yaB8DodkJVGxx5J/ooI5tbUJaNkaCuXmYOhpuwBBNT1EbKi18dUJaLQ1GURiDFKhrY6c/zevOdAYP/u+A290SLVLVOViMVsEinW4HDoOACbUod8q3hTnrb316Qa6alOB2QKwtgVhOhIe4GeoYMLBNbXw8UBAH97dLwXrMcFAiMgAwC4jPA+MjUPhEdABgA9p3Na31e4C89skALiICADABR59X4dDAabA3fjbjAYTNggBcTR9V2WAICKlKvxYTRdmDxjY/0tE4A9ME0JxEVABgD4hyIw464A6TBlCQAAkBkBGQAAQGYEZAAAAJn1bg2Zjrgxi1WL4ykOHVPxYv2stS0cDaZzJCc6Z694rrfaPRbznTrXOzXWZ+87588sjF4PWvA+jaaL8rUcOrdwZf3zpQ2LvnWMjbm2UYWyv9azatVidl3jxH52XT6Op/S+7rvO4nmu9DzZJbpHqWwU/ywr6rGt7uXK5TMqfodBX5/Tm9fX1wZ8jbjUYM5VWC9qfNiTFrpG2XE0mi4qJ2eMdVSPVZlXsfIpkKPpYuZwOPHRz1CAfannu+/Zfo5xr9QIzPTZrgczD3TgffEuZV88rV11xc/Q89ds1Og14poGf5f9Sz0r37If/Fnpe1XO53XqHdb7OD/0/Lb3128Cfp8Xn05OyM+w6nSf8vesI/VuQzT6FepM812vKv66TcXj/ryegU11Z1GHva3xq55V7m99O5pq++ald9ekWZn3KTDr9AiZCsqy5stme6uf30bTxVOE0ZdPDv9trLMTJ47fw6eHNHN8Jns/40AhjkrB5NIzCLMNVUlfjaaLjQ7CD9JAVKUKeR7wHp5Z17RTw3KTY4QpcNkvP6viuuo8q/MQ5T3gdbp8nyfPM4Jrf4YCsaVDgLOPCcx/M79nNF3cBHiWrnXmMWcVf5fvMwh1D20X+vngU5eNpotbfZfPuqatgkTze8bmHe9LUNbJNWTmhRtNFyudsB8qGCszv/fraLp4USONREwBNfddFVeSYMyMIOkzvwYIxsrO1ECsNVIVnT4n5j00v/PDYDD4bipcNQIprmsSuewXDWayZ7WPCaYVTMSs4xpFHbDvAQOJoZ6lqcPnHblNR0W4h2VFXWbu6VKdvoPUoSiCsYm+2/+s0c8L/XsvdC4gUyW5TlhJnSkwW2naABFZjVDooGgvNXxmmur3BJ9pfv/v5vNOVWS+dD23up5UI4tXCsxijermCFCiP6tDVM+sFfB2np7tOuAoVNlQsx7Jn2UqGqSIeQ/L7GD3WMflx1SvNSX/rJ8LjZQ9KjDrhU4FZBqpStnQ2Ewj8EfMRqfPVCmvUjZCavjMKNK7xLf+nUZgggb4amxWEXvHp3wyjUKE6xrrunIEKOZZJeuMqY77I1WHJDcr+Kyz9req4ll2KihLfA/Lhic6LhNNvxaK6c8vWo+W63tn0ZmATFH41wZ8lU9d7mnlYAUSyaZm1PCtMgX3AzW4oRv6hwZUbhe6riDT/JryWGW+rosUQZnuWRPquCSsQDtl8HnRpaDMqjtz1WOFQ53Mcr2+0SaawlgjZr3QiYBM61OipjZw9K5Pw6yRjVI3uFbDl7sSG4Zq6DVy25S1RsMQm1L0nL414DkNrGcVZa1c34IxlfvbTM+2S0HZQ0PKx0CBdXk92I8NW9Yavhct5v+gd/5dn47w6soIWa6Ce8hT7NxXPfIhcTDWlJHWQu2GXgFdqrUjVdVaqKtralqAMtTB3DEa8j4FYwNr6irn599k/PzaFOQ0acPHrtwRU0qjO20EMP9+qfVk73X/n9v+HFy0Pu2Fpix8XroiF826nIROjV+RZLBIIusS8PVmV0iXqJGvE0gX+Xi2pVQdEysRqU8jM1Qv0XekzGc06q/cW8p59I/8Qip351b5cLmupzr5vFQ+gyakDOhcz5rko+1n0pw0JqeeB59yvymV+79S1lhJ1cdWuXeZTt6bAmd7fz0bTRemvHzSkp/i/3pSgEYeshZxXYvyrGRzByt0vTQvdqWvkZNZhQXed2T1z2qjZ+cTpPuMtFbJt2W/R0VyTNfcXxdm2tE1ya0+z3VTwudTuZnK5ce6rlmFSrpuh6XuNEyRwLY4YaD8fIrO2KVjoGnqlllDMvs/6Tq6uvj/2DOclJ5hnXflxmwmaltQoOk+l+veqV082CHVPViV6rOjCYktm2N11/b+eq5lFUWnsxUnf4TWhYDMZceYCZa8FhOrl/SgCvvmQCO3Y3QsuceiktgXCFedPlJl4Dp69eTaAOu/LRJSzh2nEk3v8daxonJdy/irz4hAcV26tmPJc7/U6bB4PqfCswLNY42O3RlbqsFZVghqze/OlcDSHtX46ciZVDngEnnSMzz4jlrB2W2A5MfFuqdjwcTy2P+vAPFbxc97CnTMlUu53+jddQ6AVJZn1n0+VJ+dbHetgK+3Wh2QWedeVbEJESzppb3UZ5d76kvOSUtiZ2WDPlqJVHkearBc11jVOpJJ32up3EAuI3NLx1FhlzLyMcT0jAl4lLttWUpF8dMaEhfWcTmudiqbzmtR1OBcaoT80HPKFYydDE4Gf9dZbbdR58epwbbK2Y3qa5+RczN6Uzebf2ou5f6y7jti3edblRP7Pj+GPvOyq9q+qN9lTU3QYEkv2Lm1JffZp8KHMzMidm6CoYANjetz+xjqfEw1ppPSVu9jrhxHPKr+t7uQ768pa2YaQotzi2urey7d0nNKeVL32o48JzPqPk7cWG80kjlp8fomF2bR97hOo673caLf5WrYpl3zGq2qWk4eQy6xMXWy7vMX64+ZNaqo7QGZy26m4Ou6VMjHChJ46eLaqREKusjTY43VXejAWxWiy/vjEgxWnd6Lsu5R04MTVfzeGyb0nFwT2hbBWJBr0++xgzLvJRA1PCo46UsqgB/3OFSZ1/PyCcraVL+7DFTEKvdFZ+xzH9eC+erkWZapKUhgSDaeomGN0Qi5BDdBpr33UbDyWPE/v2pTjiQTyJgyUvPX+AQ+l6E32BRTmFoLlzoYuwvdIWm4KAGvfqdrstGLjq3Fi87UaaFmEvqiTwEZiVrbKegoh01Bjct7EXuNoEuwF/p9ftvwBse1Yf4cq5Nkfq9GAFLKMRqX0yby9XoF+BG+R260iw3S9oDMpXH8FOq4FiR1GzGNiMuW+E3sZL8a2q86Sla1InUZCXhoYlCmnY4u6Rs2HUwm2bclEVGnuVSnuE5dhtj9mIJLfXmhhfhogLYHZK4N9VeTU8Zxdybyijki5dI7TLVmp2rlWHXdm0vDdqHz5pYNmxJ17Uh1brczu7ejcJ1Oa0W7oXel6iahgZZAvDBgkV+rAzLPKQmzHfebXsAbgrNec3n2SXqRLuvkKr67rmVkqBQg/9Mh+fMGjJq5nlDQm7Pv4E8j0i4jyMMWrSNzLfdnGrDYmhEzk+alKwest0kXEsPeeey+GugF/KBDTAfK6bPWi7xmZ0i3aRqscgqFxKcvPFXMlzSuUPE+6Jw4H+/089toutiUykfKTSwuuaMeGU2Cg1vH8nEeezo1kAePEzoGqhOvijZ1NF08l8o9p9BE1IWA7NYzICt7q58fiSxLDdDeLPBoNZee7lPiC60aUJwcOTIdi9F04dtpsZ3p50clv6cTE+V4GQXOLhgdgwvXer1KJyg7JWc+dFqGi+KQ9yJA25XKPNkFAmp9QGZeiNF08ejZGzim3AAVZ6e1+bBZ/M2loTc7EF8beO+qBpXLAGf67VPuxBQH9j8EHGF2nTah44TK1H64/JU2TeOZjSC/B/6dQ6vcf1KAtiqO7mJ0up6upL2YaWdVTGfqJfyuefYb8tK0WhfWR1R6/xQcpdild6Hpn+/aPBNikbDTGk9GsuEhdtuRhQYOfJLguhhq0OKr1p3esi7bXycCMkXll447S+oYalTgu15AArP2cZ0Ka6LK0xFK2fE+4TW81SLhlLu3UpV/dIvLaG6r6g3lcku55OJKm+bIZuChM4lh1TMee2RgrutKqQI4OgmNliEoG1i7t1YJOi6MjiG21o2s1zjDs44im8ENuzWr61Smfh1saoKyz4l7y0PtRCPBHhpNQdl/M2xUeKuOC5nBgcQ0UvZrhulZM5OUojPWCZ08OknnZ43VK0gZmF0RlKHpdLak6TX/kjgwG2oNJgkogcTMmrLt/bUJjD4mDsyKhNMEZSd09ixLjZbNtPD5fcKpTBOUde3YFnSQzmScaMQsZeflxiOdRRUu+coAH63PT7m9v75RYParw1FtdQ11NBvTl0d0IQ/ZUVrwb0atisX3E20AmERIA1AwyWYfyNHSaCsa8D9p/eWPUSsFSpf6uYj0kUOVySpBGdvoEZtL56AzCcO1C/NHCictJSjaxrq5yw650G5v1yOreqPzAZlN2/9vi2Nw1PiM9SKOAzdAyxYdRovjdtv761707BScrYtKUzulJlYZCdWJMYcazyoc2O60UN98XzpCqEojNrE65q1hBWdz3RO7zIfsuJrcZbechLNfrwKyMqvxKQI0+0Wc1AzQTDLRMXmRGsvlufw4w66PlYiCm78CnFInpm6y2XmFM0Jd7/mkDZnU0RiunebO1wGaVXqwT72wOmbjAEnYZ4yS7dfrgKys/CIqQLtUw+ETnM0SJeSEO9dAeZLqgPEm29OJGes9n3kEZxenAl0d/bRz+N2XVPZwQEBWwZ6OWbGswedINgKyAzq7qD8EE6CZKRWl0vjFY2NAF5KPdpKCAJdF7Ew/76Edm3Ntnvns8Suq3FeXEa8LdnPBgVMaFqbD/6Qdmyaw+o/HxoAzFvfvR0BWkXakjR0T7LFovNlcKtcrKpHD1HlZasemS6BbJXhybQTpfeMkjfK4LGBPnXS88ZTN4NIj4TSDFXsQkLmbN+GIFkYBgnA9JJ7p5xM0pekSEFV5j12f0xXlAxW4lmfWAx+gzTkuI2V0bvfoTEBmRi9SjGBY68xyizWF1qdM6q7P8VObG/qEI3wua+1O3k9NL7uOTkTNBchoaXTjSLnqflByYtcZjCbU+84S1lku5Z4Rsj26NEK21BENKSrKJizsDB6Q6ZSBWLmnGkfBtesZb22tlE25SHLQt+5raK4B1rtY58sq8XOquqavhsodGfweK0DxCdhbt35MuyPXMYNbCzkDa+pEQKaX7oN1REPsl68J0X3QaRkFYz47ZtrOtWK+SHE8lnmHzYHcAX/lrRq5r7G/v+N7WWkaSFMirksFfgsdgOr3paxr+uwidOCr3/XgsSP4LlJHoyxknT6yyv0qQWfM5buzOWKProyQ2Y2qWaT5x2i6iLKw18pVVkXstWa1p2VM4zmaLtY9DcaKNU+u5zlGPbNUIzt/KJdd7UpUi5ft3EHm+6/VkYnB5Tu7NHI+7/vXUA2RnstX64/O1NARlMVzoZHd2u+q6u6V5yxAqpQ3ZwE72ktr00LRGXuIOIXJGbU1tT4gU+C1r4CZ9T4xpmhuHHpXrr0A13Uy7+oEBmpg1n2apjzA5x25UuUWsvd+rlGx36w/vqnzGfq7+wIZ88y/mfcn8EjrueNi6cplRLs4fQ5FrtUQaX3qQ+m5FIYEZdENrXfVqywooHvxrOs2idNd1B5M0Pv4Yc//9U4ju8vAddely5o80ofs1+qATBXspyP/yZkq4yCBmce0nutL57M2zQQGq6o9SDUu5niMFzUwHBvy56Jxnxxa79R7r7VWSdOT5t36vqdSG9bc3bk8sbXfvM/f1djVCir0912mg3YeFbNvOS4aopuqgZkC5KXK5bHs5ARlaVypvFV+V029qE7Otxp1Xerd1VcB2qtjHfWh2s0XBWa1OmQKxlwGBlIdaN46b15fX1v75VXQXHbK7IpM/Dq7q+rnzCo0bPv8n8u6AzXs+3rhVW10fS+ltTkj67ibkLnRPmvUwonjc/P6DB+auvUdLdwV56RWOS5LDcpEAUaVz/yP69FNCtK/ufwdjdKa61hVPfZLFfrsROdonzsll3SiRfX7ev+u17naU1bO9eNTVsw7MK9wPqfzs9neX79x/C5OHL/P0/b+2nkK0fN9POZQfWcf71X3oGyva7WpfHz3+Kt3ur6iDSmu6/LY2brqRLiWxUd91qpqPaM6bOlxlNL7KmWkj1p7dJKCF9cKc6helumBDFQpr1WgX6wRqrGCmDoHKvssAj00LVLVWYCGqs9maqR9nvdQ9/6D3q2n0js1sN4rn6D41mNnrc+aq4viHdSRRWtrpLf456hURnyDWK9A25wMoMa9zlT7RYSp+mKdzpozbJOIXd/tQqyL0vFfPn/1ynVtb4VZo0PeFYHVaLrYqNyvFQwW7/J5qcPiE+xuCMYOa/NZliFGTWJUygMVZOfvp4L7RIb/PEwjqobeNyizvQ38HH8s8K9amWlUt+67PSxdh09Ff8iXmoe1T2os0I7pjmCsM5Y131HbY4BDuasIkX/vTD8xvi/JtY9o8xqyWRMy5h8wr1GQcx77YkYMv2T8/OzUmDbiNIY9Kle2Ctxcc6ylsqn7nmv0eea5yD+WZxqcYJ4yv78msA6ZXDhV/sJZg494unNZKtRHrQ3I9GAnDauQB+r5ew/JapFzjkWPz7qfvU/up+c3aVhQtvM4CHnmuVkhpp3WwNR+zxQ8jxvSAP0oP4lyVfWC3t8cQZnX2sYTHlLUJ3r/Jg1cOE9npYJW77K0KuSmjOqYYCzES5d69O+OxuSfGtbYm9GCc5+t4toQ8UtDOi47vWfBpvSsBijraArlJ44MQVmMYKx4T6Me52V/lg78/tiQTiWdlYpan4dML99cjU6uxtO89L8GCsbsRiZ2YSq+94zC8jMz7by9vx5rlClHxbbR86lVmSmQy3kdAyuoDL6+SnWAaUR/TXx95rM+Un7i0rP9mOCjPsYIxgrqHLkmoa7zeTcq9zk7K2aQYkz5qKYzZ1maRkeN5/vEgdmdGpqgc+MJRmiifO8uUkWasmLbKHgah3o+ClqW1ohyqsBlp23u0XvIulfniQLPRz2fJKMefaf7/N9I9aEJkv6b6Flepmyf1KmcacAiZWBm7ukvoQYp+qLNuyz30vqfW+2Wm6kAhE5+WuQzC7kL5yf63WPllZkHuI4k37uLdL9m1rO4DJDjqOxROfKibQvXdcx1HZe6lhg7FYuF+w8pe8f6rKVylc1VB4R8TnfKNUem8cSKTmqNvJBlJjC6SZmGQe/nOFAuPZfPXSl58VJlInS5KDzqnlI+PLQ6MWxVCs4mNROjFjnLnJLKBryGkRrQ8rmEp+yUHuChSuOoPDZVMze/+AR2SihY9dgOr89IQe/VZY1cXM9Wnq+kgYtNz3xi5d3zDdCerGtpTOoHvW8zz+fkVH4cvlORy62S2A2c4/fZ+jzf0MlnlSH+0rHTXSQErpTAOSaVu6Xj9w/WabOSUxc/Ph1+u3xUTiqL/XoRkJVZQcep4GOtyqdx0b4K0/mRSnTlW3HC+5kUDcixhuTHu9T0HmTFaymSRjY2aN5H13YsAGnldTVdzNMATtSHxfNcN3Ut04nv/6J3MVVQfio4LxJeN/Z+tlUvAzIAQFopjmcC2qwzi/oBAADaioAMAAAgMwIyAACAzAjIAAAAMiMgAwAAyIyADAAAIDMCMgAAgMwIyAAAADIjIAMAAMiMgAwAACAzAjIAAIDMCMgAAAAyIyADAADIjIAMAAAgMwIyAACAzAjIAAAAMnvz+vrKMwAAAMiIETIAAIDMCMgAAAAyIyADAADIjIAMAAAgMwIyAACAzAjIAAAAMiMgAwAAyIyADAAAIDMCMgAAgMwIyAAAADIjIAMAAMiMgAwAACAzAjIAAIDMCMgAAAAyIyADAADIjIAMAAAgMwIyAACAzAjIAAAAchoMBv8PTipw3MLq0qYAAAAASUVORK5CYII="
}
}
]
}