ApiDocumentation

Getting started

This documentation is intended to help you make the most of the Holy Name SMART on FHIR® API content. It will guide you through a series of working use cases to help you consume your health resources.

Terms and Conditions of Use

This section discusses the terms and conditions of using FHIR® API Server.

Documentation of the SMART on FHIR® API Server and materials including the support of the FHIR® Specification (referred to as the "Materials") have been made available for development and testing. The Materials are provided to developers as-is with no other warranties expressed or implied. Developers may use the Materials with adherence to the below terms and conditions:

The Holy Name SMART on FHIR® API Server has the most up-to-date documentation. Developers may keep copies of the Materials; however, they may not be distributed. Developers wishing to share the Materials may do so via linking other developers to the Materials hosted on the Holy Name SMART on FHIR® API Server.
Developers own developments using the Materials. Holy Name owns the Materials, as well as any improvements to or derivatives of the Materials, such as enhancements to the testing tools or documentation. A dynamic developer environment is encouraged. Any suggested improvements of the Materials may become part of the Materials without any obligation or notice to the submitter.
Developers are responsible for the products developed to consume the API. Developers are also responsible for complying with all applicable laws, including (but not limited to) those related to Holy Name's intellectual property rights. Resources available on the Holy Name SMART on FHIR® API portal may require a customer to license additional functionality or build additional workflows.
Developers interested in advertising products using Holy Name's SMART on FHIR® API, Holy Name's name, or Holy Name's logo must contact mskvarenina@holyname.org to obtain permission.
FHIR® is the registered trademark of Health Level Seven International and is used with the permission of HL7.
Dynamic FHIR® Server API works in conjunction with ConnectEHR version FHIR4-B.

Client Registration

Dynamic FHIR® Server API works in conjunction with ConnectEHR version FHIR4-B UI. Only the Vendor admins of the EHR have access to add the client app. The following are the required attributes to make a successful registration with FHIR®Authorization Server.

Client registration requires Application URL
Client registration requires Redirect URL
Client registration requires Logout URL
Client registration requires list of scopes that the app needs to access resources. e.g., openid, fhirUser, offline_access, patient/*.read etc.
Client registration requires Application name
Client registration requires OAuth 2.0 flow. e.g., Client Credential flow, Authorization code flow, Authorization code flow with PKCE(Proof Key for Code Exchange)

Client Configuration

Instructions to configure the Client - Postman to consume the FHIR®API

Steps:

Start your API client (i.e., Postman v5.3.1+)
Enter the example URL below and select GET as the HTTP verb
Ex: https://api.holyname.org/fhir/holyname/basepractice/r4/Condition/_search?Patient={Identifier}
Click the Authorization Tab and select "OAuth 2.0" from the Type dropdown menu
Enter the configuration details from the table below
Click the "Clear cookies" button
Click the "Get New Access Token" button
Enter the registered username and password
Review the consent screen then click the "Yes, Allow" button
Once successful, the Manage Access Tokens pop up will display along with the token details
Scroll down until you see the "patient" claim. This is the patient identifier. Copy this value.
Click the "Use Token" button to use the Access Token
Replace "{Identifier}" in the GET request URL with the patient identifier value you copied earlier.
Ex: https://api.holyname.org/fhir/holyname/basepractice/r4/Condition/_search?Patient=12345678
Click the "Send" button to retrieve the requested resources

For any previous versions of Postman client, please add the Access Token manually to the URL Header

Key: Authorization
Value: Bearer Access Token (E.g., bearer D5jkd3adf23aERsdgy312)

Postman Configuration for Authorization code flow

NAME	DETAILS
Token Name	FHIR®Token
Grant Type	Authorization Code
Callback URL	https://www.getpostman.com/oauth2/callback
Auth URL	https://apiconnect.holyname.org/core/connect/authorize?aud=https://api.holyname.org/fhir/holyname/basepractice/r4
Access Token URL	https://apiconnect.holyname.org/core/connect/token
Client Id	Sample Client ID
Client Secret	Sample Secret
Scope	openid patient/*.read
State	Any GUID ID (Recommended)
Client Authorization	Send as Basic Auth Header

Authorization Code flow with PKCE

Proof Key for Code Exchange (PKCE) is an industry standard that can help mitigate CSRF and other known security threats.

The Authorization Code flow with PKCE is similar to the regular Authorization Code flow, but with an additional step at the start and an additional verification at the end.

Postman Configuration for Authorization code flow with PKCE

NAME	DETAILS
Token Name	FHIR_Token
Grant Type	Authorization Code (With PKCE)
Callback URL	https://www.getpostman.com/oauth2/callback
Auth URL	https://apiconnect.holyname.org/core/connect/authorize?aud=https://api.holyname.org/fhir/holyname/basepractice/r4
Access Token URL	https://apiconnect.holyname.org/core/connect/token
Client Id	Sample Client ID
Client Secret	Sample Secret
Code Challenge Method	Sample Secret
Code Verifier	Postman client will generate this value automatically if left blank
Scope	openid patient/*.read
State	Any GUID ID (Recommended)
Client Authorization	Send as Basic Auth Header

API URLs

The FHIR® API Base URL is https://api.holyname.org/fhir/holyname/basepractice/r4

The FHIR® Authorization root URL is https://apiconnect.holyname.org/core

The FHIR® Metadata Information URL is https://api.holyname.org/fhir/holyname/basepractice/r4/metadata

The FHIR® Service Endpoints https://api.holyname.org/fhir/r4/endpoints

The FHIR® Authorization Server Information URL is https://apiconnect.holyname.org/core/.well-known/openid-configuration

Ports that have been setup for FHIR® Server &Authorization Server are:

44360 : FHIR® Server Production port, pointing to the FHIR® Server Website
44361 : FHIR® Authorization Server port, pointing to the FHIR® Authorization Server

The root URL and port are combined with the fixed URL parameters to yield the following FHIR® Presentation URL :

You can find this API Documentation at -

FHIR® Mapping

This section discusses the various FHIR® Sections mapped to the USCDI using the FHIR® API platform.

Holy Name SMART on FHIR® API allows other health IT applications to make read-only data requests for patient health information that is part of the USCDI.
§170.315(g)(7), §170.315(g)(9) and §170.315(g)(10) - API interface would allow a request for “all” the patient data, or specific “by specific data category.”
Available data via the API interface is limited by the data defined by the USCDI.
Holy Name FHIR® API assumes the use of a cumulative C-CDA with patient data. For filtering C-CDA data by section, it will use the latest cumulative C-CDA document (by the document EffectiveDateTime) per patient. When handling requests for “all patient data,” it will look across all C-CDAs that have been received.

Holy Name SMART on FHIR® API server maps FHIR® resources to USCDIs

FHIR® API Base URL:
https://api.holyname.org/fhir/holyname/basepractice/r4
FHIR® Metadata Information:
https://api.holyname.org/fhir/holyname/basepractice/r4/metadata
FHIR® Authorization Server Information:
https://apiconnect.holyname.org/core/.well-known/openid-configuration
FHIR® Server SMART-Configuration:
https://api.holyname.org/fhir/holyname/basepractice/r4/.well-known/smart-configuration

FHIR® Mapping Table

USCDI	FHIR® Resource	Resource Reference Documentation
Patient Demographics	Patient	Supported Interaction: SearchType Supported Search: _id [token], identifier [token], birthdate [date], gender [token], family [token], given [string], name [string], us-core-race [token], us-core-ethnicity [token] URL Syntax: GET [Base_URL]/Patient/_search?patient=[id] GET [Base_URL]/Patient/[id] GET [Base_URL]/Patient?identifier=[id] GET [Base_URL]/Patient?name=[string] GET [Base_URL]/Patient?family=[string] GET [Base_URL]/Patient?given=[string] GET [Base_URL]/Patient?us-core-race=[string] GET [Base_URL]/Patient?us-core-ethnicity=[string] GET [Base_URL]/Patient?birthdate=[date]&name=[string] GET [Base_URL]/Patient?gender={system\|}[code]&name=[string] Example: [Base_URL]/Patient?_id=245781 Example: [Base_URL]/Patient?identifier=245781 Example: [Base_URL]/Patient?name=Shaw Example: [Base_URL]/Patient?name=Shaw&birthdate=2007-03-20 Example: [Base_URL]/Patient?name=Shaw&gender=female Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "4155f6d4-8917-49a5-8b2d-59386303479e", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://r4devdatastore.dynamicfhirsandbox.com/fhir/dhithealth/practiceone/r4/Patient?_id=ec99fb97-1c8c-49d2-bdf4-7b3699493294" } ], "entry": [ { "fullUrl": "https://r4devdatastore.dynamicfhirsandbox.com/fhir/dhithealth/practiceone/r4/Patient/ec99fb97-1c8c-49d2-bdf4-7b3699493294", "resource": { "resourceType": "Patient", "id": "ec99fb97-1c8c-49d2-bdf4-7b3699493294", "meta": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/instance-name", "valueString": "Patient Example" }, { "url": "http://hl7.org/fhir/StructureDefinition/instance-description", "valueMarkdown": "This is a patient example for the US Core Patient Profile." } ], "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ] }, "text": { "status": "extensions", "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Example Div Text</div>" }, "extension": [ { "extension": [ { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2106-3", "display": "White" } }, { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1002-5", "display": "American Indian or Alaska Native" } }, { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2028-9", "display": "Asian" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1586-7", "display": "Shoshone" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2036-2", "display": "Filipino" } }, { "url": "text", "valueString": "Mixed" } ], "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" }, { "extension": [ { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2135-2", "display": "Hispanic or Latino" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2184-0", "display": "Dominican" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2148-5", "display": "Mexican" } }, { "url": "text", "valueString": "Hispanic or Latino" } ], "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" }, { "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode": "F" } ], "identifier": [ { "use": "usual", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] }, "system": "urn:oid:2.16.840.1.113883.3.1520.35718.16", "value": "100001" }, { "use": "usual", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR", "display": "Medical Record Number" } ], "text": "Medical Record Number" }, "system": "http://hospital.smarthealthit.org", "value": "ExternalId1234567" } ], "active": true, "name": [ { "use": "usual", "text": "Mrs. Rebecca Baily Larson Jr", "family": "Larson", "given": [ "Rebecca", "Baily" ], "prefix": [ "Mrs." ], "suffix": [ "Jr" ] }, { "use": "old", "text": "Becca Larson", "family": "Larson", "given": [ "Becca" ], "period": { "start": "2000-05-05", "end": "2022-01-01" } }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "unknown" } ] } ], "telecom": [ { "system": "phone", "value": "555-555-5555", "use": "home" }, { "system": "email", "value": "rebecca.larson@example.com" } ], "gender": "female", "birthDate": "1975-05-01", "address": [ { "line": [ "49 Meadow St" ], "city": "Mounds", "state": "OK", "postalCode": "74047", "country": "US", "period": { "start": "2016-12-06", "end": "2020-07-22" } }, { "line": [ "183 Mountain View St" ], "city": "Mounds", "state": "OK", "postalCode": "74048", "country": "US", "period": { "start": "2020-07-22" } } ] } } ] } For more info refer to Patient resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Problem List	Condition	Supported Interaction: SearchType Supported Search: patient [reference], subject [reference], category [token], clinical-status [token], code [token], onset-date [date], abatement-date [date] URL Syntax: GET [Base_URL]/Condition/[id] GET [Base_URL]/Condition?patient=[id] GET [Base_URL]/Condition?subject=[id] GET [Base_URL]/Condition?category=[code] GET [Base_URL]/Condition?clinical-status=[code] GET [Base_URL]/Condition?code=[code] GET [Base_URL]/Condition?onset-date=[date]&abatement-date=[date] URL Example: GET[Base_URL]/Condition?patient=101248&category=problem-list-item&onset-date=ge2011-12-31&abatement-date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "61549eab-dc22-4048-98fb-104f73f716de", "meta": { "lastUpdated": "2020-07-20T13:58:56-05:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ] }, "type": "searchset", "total": 5, "link": [ { "relation": "self", "url": "{Base_URL}/condition?Patient=101303&category=problem-list-item&_format=json" } ], "entry": [ { "fullUrl": "{Base_URL}/Condition/200005-Problem-10001", "resource": { "resourceType": "Condition", "id": "200005-Problem-10001", "meta": { "versionId": "R4" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.1.2.1" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "active", "display": "active" } ], "text": "active" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "confirmed" } ], "text": "confirmed" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "problem-list-item", "display": "Problem List Item" } ], "text": "Problem" } ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "236578006", "display": "CHRONIC REJECTION OF RENAL TRANSPLANT (DISORDER)" } ], "text": "Chronic rejection of renal transplant (disorder)" }, "subject": { "reference": "Patient/101303" }, "onsetDateTime": "2011-12-31", "asserter": { "reference": "Practitioner/200005-ProblemAsserter-10001", "display": "Dr. Davis Albert" } } } ] } For more info refer to Condition resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Procedures	Procedure	Supported Interaction: SearchType Supported Search: identifier [token], patient [reference], subject [reference], performer [reference], status [token], code [token], date [date] URL Syntax: GET [Base_URL]/Procedure/[id] GET [Base_URL]/Procedure?identifier=[id] GET [Base_URL]/Procedure?patient=[id] GET [Base_URL]/Procedure?subject=[id] GET [Base_URL]/Procedure?performer=[id] GET [Base_URL]/Procedure?status=[code] GET [Base_URL]/Procedure?code=[code] GET [Base_URL]/Procedure?date=[date] URL Example: GET [Base_URL]/Procedure?patient=101248 GET [Base_URL]/Procedure?patient=101248&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "63c43f18-b17f-4d56-9d55-d17cb5149f7e", "meta": { "lastUpdated": "2020-07-27T17:43:48+00:00" }, "type": "searchset", "total": 3, "link": [ { "relation": "self", "url": "{Base_URL}/Procedure?patient=101303" } ], "entry": [ { "fullUrl": "{Base_URL}/Procedure/200005-Procedure-10001", "resource": { "id": "200005-Procedure-10001", "meta": { "versionId": "200005", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:2b9a0162-4344-4593-85b3-5e037c8bcbe9" } ], "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "56251003", "display": "Nebulizer Therapy" } ], "text": "Nebulizer Therapy" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "performedPeriod": { "start": "2015-06-22", "end": "2015-06-22" }, "location": { "reference": "Location/200005-ProcedureLocation-10001", "display": "Neighborhood Physicians Practice 2472, Rocky place, Beaverton, OR, 97006 5555551002" }, "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "82094008", "display": "Lower Respiratory Tract Structure" } ], "text": "Lower Respiratory Tract Structure" } ] } } ] } For more info refer to Procedure resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Smoking Status	Observation	Supported Interaction: SearchType Supported Search: identifier [token], patient [reference], subject [reference], performer [reference], category [token], status [token], date [date] Required parameter: code [token] with value "72166-2" URL Syntax: GET [Base_URL]/Observation?patient=[id]&code=72166-2 URL Example: GET[Base_URL]/Observation?patient=101248&code=72166-2 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "4d759e5a-8b95-4385-9a5b-8b95a02a2d10", "meta": { "lastUpdated": "2020-07-27T17:43:48+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "{Base_URL}/Observation?code=72166-2&patient=Patient/101303" } ], "entry": [ { "fullUrl": "{Base_URL}/observation/200005-SocialHx-10001", "resource": { "resourceType": "Observation", "id": "200005-SocialHx-10001", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:25d5db5c-6e6d-4af8-b189-191d8c56d967" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "social-history", "display": "Social-History" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "72166-2" } ], "text": "Tobacco smoking status NHIS" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-22T00:00:00+00:00", "valueCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "449868002", "display": "Current every day" } ], "text": "Current every day" } } } ] } For more info refer to Observation resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Vital Signs	Observation	Supported Interaction: SearchType Supported Search: identifier [token], patient [reference], subject [reference], performer [reference], category [token], status [token], date [date] Required parameter: category [token] with value "vital-signs" URL Syntax: GET [Base_URL]/Observation?patient=[id]&category=vital-signs&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET[Base_URL]/Observation?patient=101248&category=vital-signs&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "978bae62-88f1-46f9-a217-a014863ab1ad", "meta": { "lastUpdated": "2020-07-20T13:58:56-05:00" }, "type": "searchset", "total": 9, "link": [ { "relation": "self", "url": "{Base_URL}/observation?Patient=101303&category=vital-signs&_format=json" } ], "entry": [ { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10001", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10001", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "29463-7", "display": "Weight" } ], "text": "Weight" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 88.0, "unit": "kg", "system": "http://unitsofmeasure.org", "code": "kg" } } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10002", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10002", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "3150-0", "display": "Inhaled Oxygen Concentration" } ], "text": "Inhaled Oxygen Concentration" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 36.0, "unit": "%", "system": "http://unitsofmeasure.org", "code": "%" } } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10003", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10003", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "59408-5", "display": "O2 % BldC Oximetry" }, { "system": "http://loinc.org", "code": "2708-6", "display": "Oxygen saturation in Arterial blood" } ], "text": "Oxygen saturation in Arterial blood" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 95.0, "unit": "%", "system": "http://unitsofmeasure.org", "code": "%" } } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10004", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10004", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "8302-2", "display": "Height" } ], "text": "Height" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 177.0, "unit": "cm", "system": "http://unitsofmeasure.org", "code": "cm" } } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10005", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10005", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "8310-5", "display": "Body Temperature" } ], "text": "Body Temperature" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 38.0, "unit": "Cel", "system": "http://unitsofmeasure.org", "code": "Cel" } } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10006", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10006", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "85354-9", "display": "Blood pressure" } ], "text": "Blood pressure" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "component": [ { "code": { "coding": [ { "system": "http://loinc.org", "code": "8462-4", "display": "Blood PressureDiastolic" } ], "text": "Blood PressureDiastolic" }, "valueQuantity": { "value": 88.0, "unit": "mm[Hg]", "system": "http://unitsofmeasure.org", "code": "mm[Hg]" } }, { "code": { "coding": [ { "system": "http://loinc.org", "code": "8480-6", "display": "Blood PressureSystolic" } ], "text": "Blood PressureSystolic" }, "valueQuantity": { "value": 145.0, "unit": "mm[Hg]", "system": "http://unitsofmeasure.org", "code": "mm[Hg]" } } ] } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10008", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10008", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "8867-4", "display": "Heart Rate" } ], "text": "Heart Rate" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 80.0, "unit": "/min", "system": "http://unitsofmeasure.org", "code": "/min" } } }, { "fullUrl": "{Base_URL}/Observation/200005-VitalSign-10009", "resource": { "resourceType": "Observation", "id": "200005-VitalSign-10009", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.6" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ], "text": "vital-signs" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "9279-1", "display": "Respiratory Rate" } ], "text": "Respiratory Rate" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "effectiveDateTime": "2015-06-22", "issued": "2015-06-21T19:00:00-05:00", "valueQuantity": { "value": 18.0, "unit": "/min", "system": "http://unitsofmeasure.org", "code": "/min" } } } ] } For more info refer to Vital Signs resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Laboratory Results	Observation	Supported Interaction: SearchType Supported Search: identifier [token], patient [reference], subject [reference], performer [reference], status [token], code [token], date [date] Required parameter: category [token] with value "laboratory" URL Syntax: GET [Base_URL]/Observation/[id] GET [Base_URL]/Observation?category=laboratory GET [Base_URL]/Observation?patient=[id]&category=laboratory&code={system\|}[code] GET [Base_URL]/Observation?patient=[id]&category=laboratory&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET[Base_URL]/Observation?patient=101248&category=laboratory GET[Base_URL]/Observation?patient=101248&category=laboratory&code=http://loinc.org\|2339-0 GET[Base_URL]/Observation?patient=101248&category=laboratory&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "c34bfb40-61b3-49c7-9b67-70021fc65a42", "meta": { "lastUpdated": "2020-09-09T21:13:17+00:00" }, "type": "searchset", "total": 10, "link": [ { "relation": "self", "url": "https://{Base_URL}/Observation?category=laboratory&patient=101305" } ], "entry": [ { "fullUrl": "https://{Base_URL}/observation/200007-Result-10001", "resource": { "resourceType": "Observation", "id": "200007-Result-10001", "meta": { "versionId": "200007" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:0db13e45-393e-4d16-9eb5-2e62d8c0fd0a" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "laboratory", "display": "Laboratory" } ] } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/ValueSet/observation-codes", "code": "5778-6", "display": "Color of Urine" } ], "text": "Color of Urine" }, "subject": { "reference": "Patient/101305", "display": "Alice DhitNewPat1" }, "effectiveDateTime": "2015-06-22T11:00:00-05:00", "issued": "2015-06-22T11:00:00+00:00", "valueString": "YELLOW", "interpretation": [ { "coding": [ { "system": "http://hl7.org/fhir/ValueSet/observation-interpretation", "code": "N", "display": "Normal" } ], "text": "Normal" } ], "referenceRange": [ { "text": "YELLOW" } ] } } ] } For more info refer to Observation resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Laboratory Tests	DiagnosticReport	Supported Interaction: SearchType Supported Search: patient [reference], status [token], code [token], date [date] Required parameter: category [token] with value "laboratory" URL Syntax: GET [Base_URL]/DiagnosticReport?category=laboratory GET [Base_URL]/DiagnosticReport?category=laboratory&patient=[id] GET [Base_URL]/DiagnosticReport?category=laboratory&patient=[id]&code={system\|}[code] GET [Base_URL]/DiagnosticReport?category=laboratory&patient=[id]&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET [Base_URL]/DiagnosticReport?category=laboratory GET [Base_URL]/DiagnosticReport?category=laboratory&patient=101248 GET [Base_URL]/DiagnosticReport?category=laboratory&patient=101248&code=http://loinc.org\|24323-8 GET [Base_URL]/DiagnosticReport?category=laboratory&patient=101248&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "c0ba28bb-d910-4db5-a847-c9bd6e1f5bdb", "meta": { "lastUpdated": "2020-09-09T21:13:17+00:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport" ] }, "type": "searchset", "total": 9, "link": [ { "relation": "self", "url": "https://{Base_URL}/diagnosticreport?Patient=101305" } ], "entry": [ { "fullUrl": "https://{Base_URL}/diagnosticreport/200007-DiagnosticLab-10001", "resource": { "resourceType": "DiagnosticReport", "id": "200007-DiagnosticLab-10001", "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:f13df6cc-f42c-4f5d-b0be-764690a6bc17" } ], "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0074", "code": "LAB", "display": "Laboratory" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "24357-6", "display": "Urinanalysis macro (dipstick) panel" } ], "text": "Urinanalysis macro (dipstick) panel" }, "subject": { "reference": "Patient/101305", "display": "Alice DhitNewPat1" }, "effectivePeriod": { "start": "2015-06-22T11:00:00-05:00", "end": "2015-06-22T12:00:00-05:00" }, "issued": "2015-06-22T16:00:00+00:00", "performer": [ { "reference": "Organization/200007-ResultOrg-10001", "display": "Neighborhood Physicians Practice" } ], "result": [ { "reference": "Observation/200007-Result-10001" } ], "conclusion": "YELLOW" } } ] } For more info refer to Diagnostic report resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Goals	Goal	Supported Interaction: SearchType Supported Search: identifier [token], patient [reference], subject [reference], category [token], lifecycle-status [token], start-date [date], target-date [date] URL Syntax: GET [Base_URL]/Goal/[id] GET [Base_URL]/Goal?patient=[id] URL Example: GET[Base_URL]/Goal/32768 GET[Base_URL]/Goal?patient=101248 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "3390eef1-9313-474c-904c-d5c67796fbf0", "meta": { "lastUpdated": "2020-07-27T17:43:48+00:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ] }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "{Base_URL}/Goal?patient=101303&_format=json" } ], "entry": [ { "fullUrl": "{Base_URL}/Goal/200005-Goal-10001", "resource": { "resourceType": "Goal", "id": "200005-Goal-10001", "meta": { "versionId": "200005", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ] }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\r\n <div>\r\n <h2 style=\"color: black;\">Generated Narrative with Details</h2>\r\n <p></p>\r\n </div>\r\n <div>\r\n <h1>Goal Details</h1>\r\n <table>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>id: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>Resident's overall goal established during assessment process</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Effective Time: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>20150622</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>lifecycle: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>58144-7</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Subject: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>Patient/123</span>\r\n </td>\r\n </tr>\r\n </table>\r\n </div>\r\n <div>\r\n <h2 style=\"color: black;\">Description</h2>\r\n <p>Resident's overall goal established during assessment process</p>\r\n </div>\r\n</div>" }, "lifecycleStatus": "active", "description": { "coding": [ { "system": "http://loinc.org", "code": "58144-7", "display": "Resident's overall goal established during assessment process" } ], "text": "Resident's overall goal established during assessment process" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "target": [ { "dueDate": "2015-06-22" } ], "statusDate": "2015-06-22" } }, { "fullUrl": "{Base_URL}/Goal/200005-Goal-10002", "resource": { "resourceType": "Goal", "id": "200005-Goal-10002", "meta": { "versionId": "200005", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ] }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\r\n <div>\r\n <h2 style=\"color: black;\">Generated Narrative with Details</h2>\r\n <p></p>\r\n </div>\r\n <div>\r\n <h1>Goal Details</h1>\r\n <table>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>id: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>Resident's overall goal established during assessment process</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Effective Time: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>20150622</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>lifecycle: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>58144-7</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Subject: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>Patient/123</span>\r\n </td>\r\n </tr>\r\n </table>\r\n </div>\r\n <div>\r\n <h2 style=\"color: black;\">Description</h2>\r\n <p>Resident's overall goal established during assessment process</p>\r\n </div>\r\n</div>" }, "lifecycleStatus": "active", "description": { "coding": [ { "system": "http://loinc.org", "code": "58144-7", "display": "Resident's overall goal established during assessment process" } ], "text": "Resident's overall goal established during assessment process" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "target": [ { "dueDate": "2015-06-22" } ], "statusDate": "2015-06-22" } } ] } For more info refer to Goal resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Immunizations Information	Immunization	Supported Interaction: SearchType Supported Search: identifier [token], patient [reference], performer [reference], status [token], date [date], vaccine-code [token] URL Syntax: GET [Base_URL]/Immunization/[id] GET [Base_URL]/Immunization?patient=[id]&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET [Base_URL]/Immunization/32768 GET[Base_URL]/Immunization?patient=101248&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "aedc2ed6-e80c-4998-af92-766bd0b500cc", "meta": { "lastUpdated": "2020-07-27T17:43:48+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "{Base_URL}/Immunization?patient=101303" } ], "entry": [ { "fullUrl": "{Base_URL}/Immunization/200005-Immunization-10001", "resource": { "resourceType": "Immunization", "id": "200005-Immunization-10001", "meta": { "versionId": "200005" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:b9f3447d-cb9d-491a-b4a7-09a1e3b30283" } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cvx", "code": "106", "display": "Tetanus and diphtheria toxoids" }, { "system": "http://hl7.org/fhir/sid/ndc", "code": "49281-0286-01", "display": "Tetanus and diphtheria toxoids" } ] }, "patient": { "reference": "Patient/101303", "display": "Alice Newman" }, "occurrenceDateTime": "2012-01-04T00:00:00+00:00", "primarySource": true, "manufacturer": { "display": "Immuno Inc." }, "lotNumber": "2", "performer": [ { "actor": { "reference": "Practitioner/200005-ImmunizationPerformer-10001" } } ] } } ] } For more info refer to Immunization resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Assessment and Plan of Treatment	Care Plan	Supported Interaction: SearchType Supported Search: patient [reference], category [token], status [token], date [date] URL Syntax: GET [Base_URL]/CarePlan/[id] GET [Base_URL]/CarePlan?patient=[id]&category=assess-plan&status={system\|}[code]&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET [Base_URL]/CarePlan/32768 GET [Base_URL]/CarePlan?patient=101248&category=assess-plan&status=active&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "caca1b2e-8b34-4fe3-aec9-74dacda537bd", "meta": { "lastUpdated": "2020-07-27T17:43:48+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "{Base_URL}/CarePlan?Patient=101303" } ], "entry": [ { "fullUrl": "{Base_URL}/CarePlan/200005-AssessPlan-9999", "resource": { "resourceType": "CarePlan", "id": "200005-AssessPlan-9999", "meta": { "versionId": "200005", "lastUpdated": "2020-07-27T17:43:48+00:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ] }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><br></br><strong>Assessment</strong> <br></br><p> The patient was found to have fever and Dr Davis is suspecting Anemia based on the patient history. So Dr Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health Hospitals if the fever does not subside within a day </p></div>" }, "status": "active", "intent": "plan", "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category", "code": "assess-plan", "display": "Assessment and Plan of Treatment" } ] } ], "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "period": { "start": "2015-06-22", "end": "2015-06-22" }, "careTeam": [ { "reference": "CareTeam/200005-careteam-9999", "display": "Care Team Members : Dr. Albert Davis ;" } ], "addresses": [ { "reference": "Condition/200005-Problem-10001", "display": "Chronic rejection of renal transplant (disorder)" }, { "reference": "Condition/200005-Problem-10002", "display": "Overweight (finding)" }, { "reference": "Condition/200005-Problem-10003", "display": "Fever (finding)" }, { "reference": "Condition/200005-Problem-10004", "display": "Essential hypertension (Disorder, )" }, { "reference": "Condition/200005-Problem-10005", "display": "Severe Hypothyroidism (Disorder)" }, { "reference": "Condition/200005-HealthConcerns-10001", "display": "Documented HyperTension problem" }, { "reference": "Condition/200005-HealthConcerns-10002", "display": "Watch Weight of patient" }, { "reference": "Condition/200005-HealthConcerns-10003", "display": "Documented HypoThyroidism problem" }, { "reference": "Condition/200005-HealthConcerns-10004", "display": "Chronically ill" } ], "goal": [ { "reference": "Goal/200005-Goal-10001", "display": "Resident's overall goal established during assessment process" }, { "reference": "Goal/200005-Goal-10002", "display": "Resident's overall goal established during assessment process" } ], "activity": [ { "detail": { "code": { "coding": [ { "system": "http://loinc.org", "code": "75324-4", "display": "Functional performance" } ], "text": "Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015" }, "status": "in-progress" } }, { "detail": { "code": { "coding": [ { "system": "http://loinc.org", "code": "24357-6", "display": "Urinanalysis macro (dipstick) panel" } ], "text": "Urinanalysis macro (dipstick) panel" }, "status": "in-progress" } }, { "detail": { "code": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "284215", "display": "Clindamycin 300mg" } ], "text": "Take Clindamycin 300mg three times a day as needed if pain does not subside" }, "status": "in-progress" } }, { "detail": { "code": { "coding": [ { "system": "http://loinc.org", "code": "36643-5", "display": "Chest X-Ray" } ], "text": "Get a Chest X-Ray done on 6/23/2015 showing the Lower Respiratory Tract Structure." }, "status": "in-progress" } }, { "detail": { "code": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "93010", "display": "EKG" } ], "text": "Get an EKG done on 6/23/2015." }, "status": "in-progress" } } ] } } ] } For more info refer to CarePlan resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Care Team Member(s)	Care Team	Supported Interaction: SearchType Supported Search: patient [reference], status [token] URL Syntax: GET [Base_URL]/CareTeam/[id] GET [Base_URL]/CareTeam?patient=[id]&status={system\|}[code] URL Example: GET [Base_URL]/CareTeam/32768 GET [Base_URL]/CareTeam?patient=101248&status=active Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "0017ede9-dc71-4e06-81ef-ece4e7f692c9", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://r4dev.dynamicfhirsandbox.com/fhir/CareTeam?patient=101305" } ], "entry": [ { "fullUrl": "200007-careteam-200007-careteam-10001", "resource": { "resourceType": "CareTeam", "id": "200007-careteam-10001", "status": "active", "subject": { "reference": "Patient/101305", "display": "Alice DhitNewPat1" }, "participant": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "446050000", "display": "PCP - Primary care physician" } ], "text": "PCP - Primary care physician" } ], "member": { "reference": "Practitioner/200007-CareTeamPerformer-10001" } }, { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "224891009", "display": "Healthcare services (qualifier value)" } ], "text": "Healthcare services (qualifier value)" } ], "member": { "reference": "Organization/200007-DocumentationOfOrg-10001" } }, { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "116153009", "display": "Patient" } ], "text": "Patient" } ], "member": { "reference": "Patient/101305", "display": "Alice DhitNewPat1" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "386661006", "display": "SNOMED-CT" } ], "text": "Fever" } ] } } ] } For more info refer to CarePlan resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Health Concerns	Condition	Supported Interaction: SearchType Supported Search: patient [reference], subject [reference], clinical-status [token], onset-date [date], abatement-date [date], code [token] Required parameter: category [token] with value "health-concern" URL Syntax: GET [Base_URL]/Condition?patient=[id]&category=health-concern&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET[Base_URL]/Condition?patient=101248&category=health-concern&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "fa954d07-d944-4d59-a12b-6a2a9644ebea", "meta": { "lastUpdated": "2020-07-27T17:43:48+00:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ] }, "type": "searchset", "total": 10, "link": [ { "relation": "self", "url": "{Base_URL}/Condition?patient=101303" } ], "entry": [ { "fullUrl": "{Base_URL}/Condition/200005-HealthConcerns-10001", "resource": { "resourceType": "Condition", "id": "200005-HealthConcerns-10001", "meta": { "versionId": "200005", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:cf2512e2-8edd-4ccd-9cff-09c06f523d58" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "resolved" } ], "text": "resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "confirmed" } ], "text": "confirmed" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/condition-category", "code": "health-concern", "display": "Health Concern" } ], "text": "Health Concern" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "75310-3", "display": "Health Concern" } ], "text": "DOCUMENTED HYPERTENSION PROBLEM" }, "subject": { "reference": "Patient/101303", "display": "Alice Newman" }, "asserter": { "reference": "Patient/101303", "display": "Alice Newman" } } } ] } For more info refer to Condition resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Medications	MedicationRequest	Supported Interaction: SearchType Supported Search: status [token], intent [token], patient [reference], encounter [reference], authoredon [date] URL Syntax: GET [Base_URL]/MedicationRequest?patient=[id]&intent={system\|}[code] GET [Base_URL]/MedicationRequest?patient=[id]&intent=order&status={system\|}[code] URL Example: GET[Base_URL]/MedicationRequest?patient=101248&intent=order GET[Base_URL]/MedicationRequest?patient=101248&intent=order&status=active Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "3213fdad-fd72-439f-9649-0d9672563d20", "meta": { "lastUpdated": "2020-09-09T21:13:17+00:00" }, "type": "searchset", "total": 4, "link": [ { "relation": "self", "url": "https://r4dev.dynamicfhirsandbox.com/fhir/MedicationRequest?patient=101305&_format=json" } ], "entry": [ { "fullUrl": "https://r4dev.dynamicfhirsandbox.com/fhir/MedicationRequest/200007-MedicationRequest-10001", "resource": { "resourceType": "MedicationRequest", "id": "200007-MedicationRequest-10001", "meta": { "versionId": "200007" }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\r\n <div>\r\n <h2 style=\"color: black;\">Generated Narrative with Details</h2>\r\n <p></p>\r\n </div>\r\n <div>\r\n <table>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Code: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>209459</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>CodeSystem: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>RXNORM</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Medication Name: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>Tylenol 500mg</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Start Date: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>2015-06-22</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>End Date: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>2015-07-02</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Route: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>Oral</span>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>\r\n <span>\r\n <b>Dose/Frequency: </b>\r\n </span>\r\n </td>\r\n <td>\r\n <span>1 Unit As needed</span>\r\n </td>\r\n </tr>\r\n </table>\r\n </div>\r\n</div>" }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:1.3.6.1.4.1.22812.18.99930.951951951.4.9" } ], "status": "completed", "intent": "order", "category": [ { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "outpatient", "display": "Outpatient" } ] } ], "reportedReference": { "reference": "Practitioner/200007-MedicationRequestPerformer-10001" }, "medicationCodeableConcept": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "209459", "display": "Tylenol 500mg" } ] }, "subject": { "reference": "Patient/101305", "display": "Alice DhitNewPat1" }, "encounter": { "reference": "Encounter/200007-Encounter-10001" }, "authoredOn": "2015-06-22T11:00:00+00:00", "requester": { "reference": "Practitioner/200007-MedicationRequestPerformer-10001" }, "dosageInstruction": [ { "text": "1 Unit As needed", "route": { "coding": [ { "system": "https://ncit.nci.nih.gov", "code": "C38288", "display": "Oral" } ] }, "maxDosePerAdministration": { "value": 1, "unit": "U" } } ], "dispenseRequest": { "validityPeriod": { "start": "2015-06-22T00:00:00+00:00", "end": "2015-07-02T00:00:00+00:00" } } } } ] } For more info refer to Medication Request resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Allergies and Intolerances	AllergyIntolerance	Supported Interaction: SearchType Supported Search: clinical-status [token], patient [reference] URL Syntax: GET [Base_URL]/AllergyIntolerance?patient=[id] URL Example: GET[Base_URL]/AllergyIntolerance?patient=101248 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "b57f7c1d-4036-40e7-b7ca-ae06504be901", "meta": { "lastUpdated": "2020-07-20T13:58:56-05:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "{Base_URL}/allergyintolerance?Patient=101303" } ], "entry": [ { "fullUrl": "{Base_URL}/allergyintolerance/200005-AllergyIntolerance-10001", "resource": { "resourceType": "AllergyIntolerance", "id": "200005-AllergyIntolerance-10001", "meta": { "versionId": "200005", "lastUpdated": "2020-07-20T13:58:56-05:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:f9af8325-ea1c-4d5a-a138-b765fe98bc18" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active" } ], "text": "active" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "unconfirmed" } ], "text": "unconfirmed" }, "type": "allergy", "category": [ "medication" ], "criticality": "unable-to-assess", "code": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "733", "display": "Ampicillin" } ] }, "patient": { "reference": "Patient/101303", "display": "Alice Newman" }, "onsetPeriod": { "start": "1980-05-10" }, "recorder": { "reference": "Practitioner/200005-AllergyPerformer-10001", "display": "Dr Albert Davis" }, "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "247472004", "display": "Hives" } ], "text": "Hives" } ], "onset": "1980-05-10", "severity": "moderate" } ] } } ] } For more info refer to AllergyIntolerance resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Unique Device Identifier(s) for a Patient’s Implantable Device(s)	Device	Supported Interaction: SearchType Supported Search: patient [reference], type [token] URL Syntax: GET [Base_URL]/Device?patient=[id] URL Example: GET[Base_URL]/Device?patient=101248 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "82a48e7f-4b81-413e-8a17-f89f571a2e31", "meta": { "lastUpdated": "2020-09-09T21:13:17+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "https://{Base_URL}/Device?patient=101305&_format=json" } ], "entry": [ { "fullUrl": "https://{Base_URL}/Device/200007-Device-10001", "resource": { "resourceType": "Device", "id": "200007-Device-10001", "meta": { "versionId": "200007", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device" ] }, "udiCarrier": [ { "deviceIdentifier": "76467872488631", "issuer": "FDA", "carrierHRF": "(01)76467872488631(11)630728(17)880811(10)866152787(21)400383619890213703" } ], "status": "active", "distinctIdentifier": "76467872488631", "manufactureDate": "1963-07-28", "expirationDate": "1988-08-11", "lotNumber": "866152787", "serialNumber": "400383619890213703", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "704708004", "display": "Cardiac resynchronization therapy implantable pacemaker" } ] }, "patient": { "reference": "Patient/101305", "display": "Alice DhitNewPat1" } } } ] } For more info refer to Device resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Clinical Summary Document as C-CDA	DocumentReference	Supported Interaction: SearchType Supported Search: _id [token], patient [reference], status [token], category [token], type [token], date [date], period [date] URL Syntax: GET [Base_URL]/DocumentReference?_id=[id] GET [Base_URL]/DocumentReference?patient=[id] GET [Base_URL]/DocumentReference?patient=[id]&category=clinical-note GET [Base_URL]/DocumentReference?patient=[id]&category=clinical-note&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET[Base_URL]/DocumentReference?_id=200007-DocRefClinicalNote-10001 GET[Base_URL]/DocumentReference?patient=101248 GET[Base_URL]/DocumentReference?patient=101248&category=clinical-note GET[Base_URL]/DocumentReference?patient=101248&category=clinical-note&created=ge2011-12-31&created=le2011-12-31 For more info refer to Binary resource on HL7.org Returns the Document Reference representation of all the data.
{ "resourceType": "Bundle", "id": "49fee07f-6c06-488a-9bb4-4418fd1e7723", "type": "searchset", "total": 5, "link": [ { "relation": "self", "url": "https://{Base_URL}/DocumentReference?patient=101305" } ], "entry": [ { "fullUrl": "https://{Base_URL}/DocumentReference/200007-DocRefClinicalNote-10001", "resource": { "resourceType": "DocumentReference", "id": "200007-DocRefClinicalNote-10001", "meta": { "versionId": "10001", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:10001" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "11488-4", "display": "Consultation Note" } ], "text": "Consultation Note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/101305", "display": "DhitNewPat1, Alice" }, "date": "2020-09-09T21:13:17+00:00", "author": [ { "reference": "Practitioner/200007-AuthorPerformer-10001", "display": "DrAlbertTestDavisTest" } ], "custodian": { "reference": "Organization/200007-CustodianOrg-9999" }, "description": "Consultation note", "content": [ { "attachment": { "contentType": "text/plain", "data": "Q2xpbmljYWwgTm90ZSBUZXh0OiBEciBBbGJlcnQgRGF2aXMgZGlhZ25vc2VkIE1zIEhhcHB5IEtpZCB0byBiZSBzdWZmZXJpbmcgZnJvbSBGZXZlciBhbmQgc3VzcGVjdGVkIFBuZXVtb25pYSBhbmQgcmVjb21tZW5kZWQgYWRtaXNzaW9uIHRvIHRoZSBDb21tdW5pdHkgSGVhbHRoIEhvc3BpdGFscy4=" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/200007-Encounter-10001" } ], "period": { "start": "2020-09-09T16:13:17-05:00" } } } }, { "fullUrl": "https://{Base_URL}/DocumentReference/200007-DocRefClinicalNote-10002", "resource": { "resourceType": "DocumentReference", "id": "200007-DocRefClinicalNote-10002", "meta": { "versionId": "10002", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:10002" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "18842-5", "display": "Discharge Summary" } ], "text": "Discharge Summary" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/101305", "display": "DhitNewPat1, Alice" }, "date": "2020-09-09T21:13:17+00:00", "author": [ { "reference": "Practitioner/200007-AuthorPerformer-10001", "display": "DrAlbertTestDavisTest" } ], "custodian": { "reference": "Organization/200007-CustodianOrg-9999" }, "description": "Discharge Summary note", "content": [ { "attachment": { "contentType": "text/plain", "data": "RGlzY2hhcmdlIFN1bW1hcnkgTm90ZSBUZXh0OiBEciBBbGJlcnQgRGF2aXMgZGlhZ25vc2VkIE1zIEhhcHB5IEtpZCB0byBiZSBzdWZmZXJpbmcgZnJvbSBGZXZlciBhbmQgc3VzcGVjdGVkIFBuZXVtb25pYSBhbmQgcmVjb21tZW5kZWQgYWRtaXNzaW9uIHRvIHRoZSBDb21tdW5pdHkgSGVhbHRoIEhvc3BpdGFscy4=" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/200007-Encounter-10001" } ], "period": { "start": "2020-09-09T16:13:17-05:00" } } } }, { "fullUrl": "https://{Base_URL}/DocumentReference/200007-DocRefClinicalNote-10003", "resource": { "resourceType": "DocumentReference", "id": "200007-DocRefClinicalNote-10003", "meta": { "versionId": "10003", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:10003" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "34117-2", "display": "History and Physical Note" } ], "text": "History and Physical Note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/101305", "display": "DhitNewPat1, Alice" }, "date": "2020-09-09T21:13:17+00:00", "author": [ { "reference": "Practitioner/200007-AuthorPerformer-10001", "display": "DrAlbertTestDavisTest" } ], "custodian": { "reference": "Organization/200007-CustodianOrg-9999" }, "description": "History and Physical Note", "content": [ { "attachment": { "contentType": "text/plain", "data": "SGlzdG9yeSBhbmQgUGh5c2ljYWwgTm90ZSBUZXh0OiBEciBBbGJlcnQgRGF2aXMgZGlhZ25vc2VkIE1zIEhhcHB5IEtpZCB0byBiZSBzdWZmZXJpbmcgZnJvbSBGZXZlciBhbmQgc3VzcGVjdGVkIFBuZXVtb25pYSBhbmQgcmVjb21tZW5kZWQgYWRtaXNzaW9uIHRvIHRoZSBDb21tdW5pdHkgSGVhbHRoIEhvc3BpdGFscy4=" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/200007-Encounter-10001" } ], "period": { "start": "2020-09-09T16:13:17-05:00" } } } }, { "fullUrl": "https://{Base_URL}/DocumentReference/200007-DocRefClinicalNote-10004", "resource": { "resourceType": "DocumentReference", "id": "200007-DocRefClinicalNote-10004", "meta": { "versionId": "10004", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:10004" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "28570-0", "display": "Procedure Note" } ], "text": "Procedure Note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/101305", "display": "DhitNewPat1, Alice" }, "date": "2020-09-09T21:13:17+00:00", "author": [ { "reference": "Practitioner/200007-AuthorPerformer-10001", "display": "DrAlbertTestDavisTest" } ], "custodian": { "reference": "Organization/200007-CustodianOrg-9999" }, "description": "Procedure Notes", "content": [ { "attachment": { "contentType": "text/plain", "data": "UHJvY2VkdXJlcyBOb3RlIFRleHQ6IERyIEFsYmVydCBEYXZpcyBkaWFnbm9zZWQgTXMgSGFwcHkgS2lkIHRvIGJlIHN1ZmZlcmluZyBmcm9tIEZldmVyIGFuZCBzdXNwZWN0ZWQgUG5ldW1vbmlhIGFuZCByZWNvbW1lbmRlZCBhZG1pc3Npb24gdG8gdGhlIENvbW11bml0eSBIZWFsdGggSG9zcGl0YWxzLg==" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/200007-Encounter-10001" } ], "period": { "start": "2020-09-09T16:13:17-05:00" } } } }, { "fullUrl": "https://{Base_URL}/DocumentReference/200007-DocRefClinicalNote-10005", "resource": { "resourceType": "DocumentReference", "id": "200007-DocRefClinicalNote-10005", "meta": { "versionId": "10005", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:10005" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "11506-3", "display": "Progress Note" } ], "text": "Progress Note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/101305", "display": "DhitNewPat1, Alice" }, "date": "2020-09-09T21:13:17+00:00", "author": [ { "reference": "Practitioner/200007-AuthorPerformer-10001", "display": "DrAlbertTestDavisTest" } ], "custodian": { "reference": "Organization/200007-CustodianOrg-9999" }, "description": "Progress Notes", "content": [ { "attachment": { "contentType": "text/plain", "data": "UHJvZ3Jlc3MgTm90ZSBUZXh0OiBEciBBbGJlcnQgRGF2aXMgZGlhZ25vc2VkIE1zIEhhcHB5IEtpZCB0byBiZSBzdWZmZXJpbmcgZnJvbSBGZXZlciBhbmQgc3VzcGVjdGVkIFBuZXVtb25pYSBhbmQgcmVjb21tZW5kZWQgYWRtaXNzaW9uIHRvIHRoZSBDb21tdW5pdHkgSGVhbHRoIEhvc3BpdGFscy4=" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/200007-Encounter-10001" } ], "period": { "start": "2020-09-09T16:13:17-05:00" } } } } ] } For more info refer to Device resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Consultation Note	DocumentReference	Supported Interaction: SearchType Supported Search: _id [token], patient [reference], status [token], category [token], type [token], date [date], period [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7C11488-4 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7C11488-4 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DocumentReference", "id": "206", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:uuid:eb75e932-f3b5-1482-e142-0e31c97b4f95" } ], "status": "superseded", "type": { "coding": [ { "system": "http://loinc.org", "code": "11488-4", "display": "Consultation note" } ], "text": "Consultation note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ] } ], "subject": { "reference": "Patient/85" }, "date": "1958-05-23T01:11:45.131-04:00", "author": [ { "reference": "Practitioner/88", "display": "Dr. Melvin857 Torp761" } ], "custodian": { "reference": "Organization/87", "display": "PCP87052" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/202" } ], "period": { "start": "1958-05-23T01:11:45-04:00", "end": "1958-05-23T01:26:45-04:00" } } } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Discharge Summary	DocumentReference	Supported Interaction: SearchType Supported Search: _id [token], patient [reference], status [token], category [token], type [token], date [date], period [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7C18842-5 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7C18842-5 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DocumentReference", "id": "152", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:uuid:95f2314e-8bd2-bb55-dc66-6d733185d60e" } ], "status": "superseded", "type": { "coding": [ { "system": "http://loinc.org", "code": "18842-5", "display": "Discharge summary" } ], "text": "Discharge summary" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ] } ], "subject": { "reference": "Patient/85" }, "date": "1947-01-22T01:11:45.131-05:00", "author": [ { "reference": "Practitioner/105", "display": "Dr. Willena258 Oberbrunner298" } ], "custodian": { "reference": "Organization/104", "display": "LOWELL GENERAL HOSPITAL" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "CjE5NDctMDEtMjIKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KCg==" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/150" } ], "period": { "start": "1947-01-22T01:11:45-05:00", "end": "1947-01-22T01:26:45-05:00" } } } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
History and Physical Note	DocumentReference	Supported Interaction: SearchType Supported Search: _id [token], patient [reference], status [token], category [token], type [token], date [date], period [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7C34117-2 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7C34117-2 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DocumentReference", "id": "156", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:uuid:d7130c41-5c6c-b632-dd67-1ba7468f17c2" } ], "status": "superseded", "type": { "coding": [ { "system": "http://loinc.org", "code": "34117-2", "display": "History and physical note" } ], "text": "History and physical note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ] } ], "subject": { "reference": "Patient/85" }, "date": "1947-03-21T00:11:45.131-05:00", "author": [ { "reference": "Practitioner/88", "display": "Dr. Melvin857 Torp761" } ], "custodian": { "reference": "Organization/87", "display": "PCP87052" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "CjE5NDctMDMtMjEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg==" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/153" } ], "period": { "start": "1947-03-21T00:11:45-05:00", "end": "1947-03-21T00:26:45-05:00" } } } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Procedure Note	DocumentReference	Supported Interaction: SearchType Supported Search: _id [token], patient [reference], status [token], category [token], type [token], date [date], period [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id] GET [Base_URL]/DocumentReference?patient=[id]&category={system\|}[code] GET [Base_URL]/DocumentReference?patient=[id]&code={system\|}[code] GET [Base_URL]/DocumentReference?patient=[id]&category={system\|}[code]&code={system\|}[code]&date=geYYYY-MM-DD&date=leYYYY-MM-DD URL Example: GET[Base_URL]/DocumentReference?patient=101248 GET[Base_URL]/DocumentReference?patient=101248&category=http://loinc.org%7CLP29684-5 GET[Base_URL]/DocumentReference?patient=101248&code=http://loinc.org\|24323-8 GET[Base_URL]/DocumentReference?patient=101248&category=http://loinc.org%7CLP29684-5&code=http://loinc.org\|24323-8&date=ge2011-12-31&date=le2011-12-31 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Bundle", "id": "b792cfc3-4308-4b7f-bfb6-caaf5e9ef91f", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://{Base_URL}/DocumentReference?patient=101305&type=http://loinc.org%7C34117-2" } ], "entry": [ { "fullUrl": "https://{Base_URL}/DocumentReference/200007-DocRefClinicalNote-10003", "resource": { "resourceType": "DocumentReference", "id": "200007-DocRefClinicalNote-10003", "meta": { "versionId": "10003", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "use": "official", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:10003" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "34117-2", "display": "History and Physical Note" } ], "text": "History and Physical Note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/101305", "display": "DhitNewPat1, Alice" }, "date": "2020-09-09T21:13:17+00:00", "author": [ { "reference": "Practitioner/200007-AuthorPerformer-10001", "display": "DrAlbertTestDavisTest" } ], "custodian": { "reference": "Organization/200007-CustodianOrg-9999" }, "description": "History and Physical Note", "content": [ { "attachment": { "contentType": "text/plain", "data": "SGlzdG9yeSBhbmQgUGh5c2ljYWwgTm90ZSBUZXh0OiBEciBBbGJlcnQgRGF2aXMgZGlhZ25vc2VkIE1zIEhhcHB5IEtpZCB0byBiZSBzdWZmZXJpbmcgZnJvbSBGZXZlciBhbmQgc3VzcGVjdGVkIFBuZXVtb25pYSBhbmQgcmVjb21tZW5kZWQgYWRtaXNzaW9uIHRvIHRoZSBDb21tdW5pdHkgSGVhbHRoIEhvc3BpdGFscy4=" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/200007-Encounter-10001" } ], "period": { "start": "2020-09-09T16:13:17-05:00" } } } } ] } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Progress Note	DocumentReference	Supported Interaction: SearchType Supported Search: _id [token], patient [reference], status [token], category [token], type [token], date [date], period [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7C11506-3 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7C11506-3 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DocumentReference", "id": "100", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:uuid:acc9d16d-da9b-9dc9-fbb4-9e6f950b11e6" } ], "status": "superseded", "type": { "coding": [ { "system": "http://loinc.org", "code": "11506-3", "display": "Progress note" } ], "text": "Progress note" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ] } ], "subject": { "reference": "Patient/85" }, "date": "1940-09-06T01:11:45.131-04:00", "author": [ { "reference": "Practitioner/88", "display": "Dr. Melvin857 Torp761" } ], "custodian": { "reference": "Organization/87", "display": "PCP87052" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg==" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/96" } ], "period": { "start": "1940-09-06T01:11:45-04:00", "end": "1940-09-06T01:26:45-04:00" } } } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Cardiology Report	DocumentReference	Supported Interaction: SearchType Supported Search: patient [reference], status [token], category [token], code [token], date [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7CLP29708-2 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7CLP29708-2 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DiagnosticReport", "id": "114", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note" ] }, "status": "final", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LP29708-2", "display": "Cardiology" } ], "text": "Cardiology" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "57133-1", "display": "Referral note" } ], "text": "Referral note" }, "subject": { "reference": "Patient/85" }, "encounter": { "reference": "Encounter/112" }, "effectiveDateTime": "1941-03-07T00:11:45-05:00", "issued": "1941-03-07T00:11:45.131-05:00", "performer": [ { "reference": "Practitioner/88", "display": "Dr. Melvin857 Torp761" } ], "presentedForm": [ { "contentType": "text/plain", "data": "CjE5NDEtMDMtMDcKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDExIG1vbnRoLW9sZCBub24taGlzcGFuaWMgd2hpdGUgbWFsZS4gUGF0aWVudCBoYXMgYSBoaXN0b3J5IG9mIG90aXRpcyBtZWRpYSwgYWN1dGUgdmlyYWwgcGhhcnluZ2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKIFBhdGllbnQgaGFzIG5ldmVyIHNtb2tlZCBhbmQgaXMgYW4gYWxjb2hvbGljLgoKUGF0aWVudCBjb21lcyBmcm9tIGEgaGlnaCBzb2Npb2Vjb25vbWljIGJhY2tncm91bmQuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuCgo=" } ] } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Pathology Report	DocumentReference	Supported Interaction: SearchType Supported Search: patient [reference], status [token], category [token], code [token], date [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7CLP7839-6 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7CLP7839-6 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DiagnosticReport", "id": "151", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note" ] }, "status": "final", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LP7839-6", "display": "Pathology" } ], "text": "Pathology" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "18842-5", "display": "Discharge summary" } ], "text": "Discharge summary" }, "subject": { "reference": "Patient/85" }, "encounter": { "reference": "Encounter/150" }, "effectiveDateTime": "1947-01-22T01:11:45-05:00", "issued": "1947-01-22T01:11:45.131-05:00", "performer": [ { "reference": "Practitioner/105", "display": "Dr. Willena258 Oberbrunner298" } ], "presentedForm": [ { "contentType": "text/plain", "data": "CjE5NDctMDEtMjIKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KCg==" } ] } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Radiology Report	DocumentReference	Supported Interaction: SearchType Supported Search: patient [reference], status [token], category [token], code [token], date [date] URL Syntax: GET [Base_URL]/DocumentReference?patient=[id]&type=http://loinc.org%7CLP29684-5 URL Example: GET[Base_URL]/DocumentReference?patient=101248&type=http://loinc.org%7CLP29684-5 Return Type: JSON or XML Returned Schema:
{ "resourceType": "DiagnosticReport", "id": "205", "meta": { "versionId": "1", "lastUpdated": "2021-03-23T19:36:17.299+00:00", "source": "#E1VolYkq84D3M96u", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note" ] }, "status": "final", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LP29684-5", "display": "Radiology" } ], "text": "Radiology" } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "11488-4", "display": "Consultation note" } ], "text": "Consultation note" }, "subject": { "reference": "Patient/85" }, "encounter": { "reference": "Encounter/202" }, "effectiveDateTime": "1958-05-23T01:11:45-04:00", "issued": "1958-05-23T01:11:45.131-04:00", "performer": [ { "reference": "Practitioner/88", "display": "Dr. Melvin857 Torp761" } ], "presentedForm": [ { "contentType": "text/plain", "data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK" } ] } For more info refer to Clinical Notes resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Practitioner	Practitioner	Supported Interaction: SearchType Supported Search: identifier [token], name [string], family [string], given [string], address [string], address-city [string], address-state [string], address-postalcode [string], address-country [string] URL Syntax: GET [Base_URL]/Practitioner/[id] GET [Base_URL]/Practitioner?name=[string] GET [Base_URL]/Practitioner?address=[string] URL Example: GET [Base_URL]/Practitioner/32768 GET [Base_URL]/Practitioner?name=Deiter GET [Base_URL]/Practitioner?address=1234%20Somewhere Return Type: JSON or XML Returned Schema:
{ "resourceType": "Practitioner", "id": "2dd93806-8739-480f-9718-44dbbb97d14a", "meta": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/instance-name", "valueString": "Practitioner 2 Example" }, { "url": "http://hl7.org/fhir/StructureDefinition/instance-description", "valueMarkdown": "This is a practitioner 2 example for the US Core Practitioner Profile." } ], "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ] }, "text": { "status": "generated", "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Example Div Text</div>" }, "identifier": [ { "system": "http://hl7.org.fhir/sid/us-npi", "value": "1245319599" }, { "system": "http://www.acme.org/practitioners", "value": "456789" } ], "name": [ { "family": "Kathy", "given": [ "Fielding" ], "prefix": [ "Dr" ] } ], "telecom": [ { "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct", "valueBoolean": true } ], "system": "email", "value": "Kathy.Fielding@direct.ExampleMedicalPractice.net", "use": "work" } ], "address": [ { "use": "work", "line": [ "1080 FIRST COLONIAL RD" ], "city": "Virginia Beach", "state": "VA", "postalCode": "21454-2406" } ] } For more info refer to Practitioner resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
PractitionerRole	PractitionerRole	Supported Interaction: SearchType Supported Search: identifier [token], practitioner [reference], organization [reference], role [token], specialty [token], active [token] URL Syntax: GET [Base_URL]/PractitionerRole/[id] GET [Base_URL]/PractitionerRole?practitioner=[id] URL Example: GET [Base_URL]/PractitionerRole/32768 GET [Base_URL]/PractitionerRole?practitioner=fc672610-b319-4158-b8c3-07f51bf01c60 Return Type: JSON or XML Returned Schema:
{ "resourceType": "PractitionerRole", "id": "example", "text": { "status": "generated", "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Example Div Text</div>" }, "identifier": [ { "system": "http://www.acme.org/practitioners", "value": "23" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "#PRACTITIONER1_REFERENCE#", "display": "Dr Adam Careful" }, "organization": { "reference": "#ORGANIZATION1_REFERENCE#" }, "code": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "408443003", "display": "General medical practice" } ] } ], "location": [ { "reference": "#LOCATION1_REFERENCE#", "display": "Health Level Seven International - Amherst" } ], "telecom": [ { "system": "phone", "value": "(03) 5555 6473", "use": "work" }, { "system": "email", "value": "adam.southern@example.org", "use": "work" } ], "availableTime": [ { "daysOfWeek": [ "mon", "tue", "wed" ], "availableStartTime": "09:00:00", "availableEndTime": "16:30:00" }, { "daysOfWeek": [ "thu", "fri" ], "availableStartTime": "09:00:00", "availableEndTime": "12:00:00" } ], "notAvailable": [ { "description": "Adam will be on extended leave during May 2017", "during": { "start": "2017-05-01", "end": "2017-05-20" } } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break" } For more info refer to PractitionerRole resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Encounter	Encounter	Supported Interaction: SearchType Supported Search: _id [token], identifier [token], patient [reference], class [token], type [token], status [token], date [date] Required parameter: URL Syntax: GET [Base_URL]/Encounter/[id] GET [Base_URL]/Encounter?patient=[reference] GET [Base_URL]/Encounter?date={gt\|lt\|ge\|le}[date]{&date={gt\|lt\|ge\|le}[date]&...}&patient=[reference] GET [Base_URL]/Encounter?identifier={system\|}[code] GET [Base_URL]/Encounter?class={system\|}[code]&patient=[reference] GET [Base_URL]/Encounter?patient=[reference]&type={system\|}[code] GET [Base_URL]/Encounter?patient=[reference]&status={system\|}[code] URL Example: GET[Base_URL]/Encounter/12354 GET[Base_URL]/Encounter?patient=1137192 GET[Base_URL]/Encounter?patient=example1&date=ge2019 GET[Base_URL]/Encounter?identifier=http://hospital.smarthealthit.org\|1032702 GET[Base_URL]/Encounter?patient=example1&class= http://terminology.hl7.org/CodeSystem/v3-ActCode code\|AMB GET[Base_URL]/Encounter?patient=1137192&type=http://www.ama-assn.org/go/cpt code\|99201 GET[Base_URL]/Encounter?patient=example1&status=finished Return Type: JSON or XML Returned Schema:
{ "resourceType": "Encounter", "id": "5edc918f-3dea-4d6a-b284-5cb86eeb363e", "meta": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/instance-name", "valueString": "Encounter 1036 Example" }, { "url": "http://hl7.org/fhir/StructureDefinition/instance-description", "valueMarkdown": "This is an encounter 1036 example for the Encounter Profile." } ], "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ] }, "text": { "status": "generated", "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Example Div Text</div>" }, "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "IMP", "display": "inpatient encounter" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "261665006", "display": "Unknown (qualifier value)" } ], "text": "Unknown (qualifier value)" } ], "subject": { "reference": "Patient/ec99fb97-1c8c-49d2-bdf4-7b3699493294" } } For more info refer to Encounter resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Location	Location	Supported Interaction: SearchType Supported Search: name [string], address [string], address-city [string], address-state [string], address-postalcode [string] Required parameter: URL Syntax: GET [Base_URL]/Location?name=[string] GET [Base_URL]/Location?address=[string] GET [Base_URL]/Location?address-city=[string] GET [Base_URL]/Location?address-state=[string] GET [Base_URL]/Location?address-postalcode=[string] URL Example: GET [Base_URL]/Location?name=Health GET [Base_URL]/Location?address=Arbor GET [Base_URL]/Location?address-city=Ann%20Arbor GET [Base_URL]/Location?address-state=LA GET [Base_URL]/Location?address-postalcode=48104 Return Type: JSON or XML Returned Schema:
{ "resourceType": "Location", "id": "hl7east", "meta": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/instance-name", "valueString": "HL7East Example" }, { "url": "http://hl7.org/fhir/StructureDefinition/instance-description", "valueMarkdown": "This is a HL7East example for the US Core Location Profile." } ], "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ] }, "text": { "status": "generated", "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Example Div Text</div>" }, "identifier": [ { "system": "http://www.acme.org/location", "value": "29" } ], "status": "active", "name": "Health Level Seven International - Amherst", "description": "HL7 Headquarters - East", "telecom": [ { "system": "phone", "value": "(+1) 734-677-7777" } ], "address": { "line": [ "3300 Washtenaw Avenue, Suite 227" ], "city": "Amherst", "state": "MA", "postalCode": "01002", "country": "USA" }, "position": { "longitude": -72.519854, "latitude": 42.373222 }, "managingOrganization": { "display": "Health Level Seven International" } } For more info refer to Location resource on HL7.org
USCDI	FHIR® Resource	Resource Reference Documentation
Organization	Organization	Supported Interaction: SearchType Supported Search: name [string], address [string] Required parameter: URL Syntax: GET [Base_URL]/Organization?name=[string] GET [Base_URL]/Organization?address=[string] URL Example: GET[Base_URL]/Organization?name=Health GET[Base_URL]/Organization?address=Arbor Return Type: JSON or XML Returned Schema:
{ "resourceType": "Organization", "id": "acme-lab", "meta": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/instance-name", "valueString": "Acme Lab Example" }, { "url": "http://hl7.org/fhir/StructureDefinition/instance-description", "valueMarkdown": "This is an acme lab example for the US Core Organization Profile." } ], "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ] }, "text": { "status": "generated", "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Example Div Text</div>" }, "identifier": [ { "use": "official", "system": "http://hl7.org/fhir/sid/us-npi", "value": "9856234700" }, { "system": "urn:oid:2.16.840.1.113883.4.7", "value": "12D4567890" } ], "active": true, "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/organization-type", "code": "prov", "display": "Healthcare Provider" } ] } ], "name": "Acme Labs", "telecom": [ { "system": "phone", "value": "(+1) 734-677-7777" }, { "system": "email", "value": "hq@acme.org" } ], "address": [ { "line": [ "3300 Washtenaw Avenue, Suite 227" ], "city": "Amherst", "state": "MA", "postalCode": "01002", "country": "USA" } ] } For more info refer to Location resource on HL7.org

Method

Supported request type

HTTP GET

Unsupported request types

HTTP POST
HTTP DELETE
HTTP PUT

API Parameters

GET fhir/{type}/_search

FhirResponse

Name	Type	Additional information
Messages	Collection of string	None.
Request	HttpRequestMessage	None.
IsValid	boolean	None.
HasBody	boolean	None.
StatusCode	HttpStatusCode	None.
Key	IKey	None.
Resource	Resource	None.

GET fhir/{type}/{id}

FhirResponse

Name	Type	Additional information
Messages	Collection of string	None.
Request	HttpRequestMessage	None.
IsValid	boolean	None.
HasBody	boolean	None.
StatusCode	HttpStatusCode	None.
Key	IKey	None.
Resource	Resource	None.

Responses

The FHIR® API is capable of providing the responses in both JSON & XML format

Application/JSON

https://api.holyname.org/fhir/Condition/_search?patient=tokenID&_format=JSON
This will provide a response in JSON format

Application/XML

https://api.holyname.org/fhir/Observation/_search?patient=tokenID&_format=XML
This request will provide a response in XML format

Error & Exception Handling

FHIR® Server handles the Errors & have valid Exception methods that provide an HTTP status code and a Meaningful message in both JSON/XML format.

Forbidden Request - HTTP Status Code - 403

A user trying to access another user's profile or data will be returned with a Forbidden Request Error.
XML/JSON response is returned from the FHIR® Server for the forbidden request

Bad Request - HTTP Status Code - 400

An invalid or a bad URL request to the server is returned with a HTTP - 400 response and message
XML/JSON response is returned from the FHIR® Server for the forbidden request

Response OK - HTTP Status Code - 200

A valid request to the FHIR® server is returned with a HTTP - 200 response and message
XML/JSON response is returned from the FHIR® Server for the forbidden request

Bulk Export Client Configuration

A client must first produce a JSON Web Token (JWT) that will be used to authenticate the client to the FHIR® authorization server before requesting an access token. The following claims MUST be included in the authentication JWT, and it MUST be signed using the client's private key (which SHOULD be an RS384 signature). See https://jwt.io for a practical reference on JWT, as well as debugging tools and client libraries.

Steps to create JWT token:

Authentication JWT Header Values

Key	Value
alg	RS384
kid	value
typ	JWT

Authentication JWT Claims

Key	Value
iss	client_id, determined during registration with the FHIR® authorization server
sub	client_id, determined during registration with the FHIR® authorization server
aud	https://apiconnect.holyname.org/core/connect/token
exp	Expiration time integer for this authentication JWT, expressed in seconds since the "Epoch" (1970-01-01T00:00:00Z UTC). This time SHALL be no more than five minutes in the future.
jti	A nonce string value that uniquely identifies this authentication JWT.

Instructions to configure the Bulk Export client - Postman to consume the FHIR® API

Steps:

Start your API client (i.e., Postman v5.3.1+)
Enter the following token endpoint https://apiconnect.holyname.org/core/connect/token
Select POST as the HTTP verb
Select the "Body" tab then select the x-www-form-urlencoded radio button for the format
Enter the configuration details from the table below and click the "Send" Button

Postman Configuration

Key	Value
scope	system/*.read
grant_type	client_credentials
client_assertion_type	urn:ietf:params:oauth:client-assertion-type:jwt-bearer
client_assertion	JWT client assertion token obtained above

After obtaining an access token, use the token to retrieve resources in ndjson format.

Bulk Data Kick-off Request:

This FHIR® Operation starts the asynchronous generation of data that the client is authorized to see - whether it's all patients, a subset (specified group) of patients, or all data in a FHIR® server.

Endpoint - All Patients:

GET [fhir base]/Patient/$export

Endpoint - Group of Patients

GET [fhir base]/Group/[id]/$export

Required Request Headers

Accept - application/fhir+json

Prefer - respond-async

Response - Success

HTTP Status Code of 202 Accepted

Content-Location header with the absolute URL of an endpoint for subsequent status requests (polling location)

Bulk Data Status Request

Following the start of a bulk data request, the client MAY poll the status URL specified in the Content-Location header.

Response - In-Progress Status

HTTP Status Code of 202 Accepted

Response - Error Status

HTTP status code of 4XX or 5XX

Content-Type - application/json

Response - Complete Status

HTTP status of 200 OK

Content-Type - application/json

File Request

A client can download the created bulk data files (one or more per resource type) using the URLs provided by the FHIR® server in the Complete Status response body within the time period set in the Expires header (if present).

Endpoint

GET [url from status request output field]

Headers

Accept - application/fhir+ndjson

Response - Success

HTTP status of 200 OK

Content-Type - application/fhir+ndjson

Response - Error

HTTP Status Code of 4XX or 5XX

FHIR® is the registered trademark of Health Level Seven International and is used with the permission of HL7.

FHIR® API Documentation

Getting started

Terms and Conditions of Use

Client Registration

Client Configuration

Steps:

Postman Configuration for Authorization code flow

Authorization Code flow with PKCE

Postman Configuration for Authorization code flow with PKCE

API URLs

FHIR® Mapping

FHIR® Mapping Table

Method

API Parameters

GET fhir/{type}/_search

GET fhir/{type}/{id}

Responses

Application/JSON

Application/XML

Error & Exception Handling

Forbidden Request - HTTP Status Code - 403

Bad Request - HTTP Status Code - 400

Response OK - HTTP Status Code - 200

Bulk Export Client Configuration

Steps to create JWT token:

Authentication JWT Header Values

Authentication JWT Claims

Steps:

Postman Configuration

Bulk Data Kick-off Request:

Endpoint - All Patients:

Endpoint - Group of Patients

Required Request Headers

Response - Success

Bulk Data Status Request

Response - In-Progress Status

Response - Error Status

Response - Complete Status

File Request

Endpoint

Headers

Response - Success

Response - Error