FHIR® API Documentation Terms of Use Client Configuration FHIR® API Mapping API URLs Method API Parameters Responses Errors and Exceptions

FHIR API Documentation

Getting started

This documentation is intented to help you make the most of the EYEFINITY FHIR® API content. It will guide you through a series of working use-cases and 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 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:

  • EYEFINITY 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 FHIR® API Server.
  • Developers own developments using the Materials. EYEFINITY 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 EYEFINITY's intellectual property rights. Resources available on the EYEFINITY FHIR® API portal may require a customer to license additional functionality or build additional workflows.
  • Developers interested in advertising products using EYEFINITY's FHIR® API, EYEFINITY's name, or EYEFINITY's logo must contact info@DynamicHealthIt.com 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 4.0.


Client Configuration

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

Steps:

  1. Start your API client (ie, Postman v5.3.1)
  2. Enter any of the example URLs at right with HTTP Request as GET
  3. Click the Authorization Tab and select the "Type-Oauth 2.0" from the dropdown menu
  4. Click the "Get New Access Token" button
  5. Enter the configuration from the table below and click the "Request Token" Button
  6. Enter the registered username and password
  7. Click the "Use Token" button to use the Access Token
  8. Click the "Preview Request" button after selecting Request Headers
  9. A success message should be prompted
  10. 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

NAME DETAILS
Token Name FHIR_Token
Grant Type Authorization Code
Callback URL https://www.getpostman.com/oauth2/callback
Auth URL https://fhirauthority.eyefinity.com/core/connect/authorize?aud=https://fhirapi.eyefinity.com/fhir/eyefinity/base/r4
Access Token URL https://fhirauthority.eyefinity.com/core/connect/token
Client Id Sample_Client ID
Client Secret Sample_Secret Secret
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://fhirapi.eyefinity.com/fhir/eyefinity/base/r4

The FHIR Authorization root URL is https://fhirauthority.eyefinity.com/core

FHIR Metadata Information : https://fhirapi.eyefinity.com/fhir/eyefinity/base/r4/metadata

FHIR Authorization Server Information : https://fhirauthority.eyefinity.com/core/.well-known/openid-configuration

Ports that have been setup for FHIR Server & Authorization Server are:
  • 443 : FHIR Server Production port, pointing to the FHIR Server Website
  • 443 : 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 Base API URL (where 'PORT' will be either Production or Test):
You can find this API Documentation at - https://fhirapi.eyefinity.com/Home/ApiDocumentation


FHIR® Mapping

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

  • EYEFINITY FHIR® API allows other health IT applications to make read-only data requests for patient health information that is part of the Common Clinical Data Set.
  • §170.315(g)(7), §170.315(g)(8) and §170.315(g)(9) - 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 Common Clinical Data Set.
  • EYEFINITY FHIR® API assumes the use of a cumulative CCDA with patient data. For filtering CCDA data by section, it will use the latest cumulative CCDA document (by the document EffectiveDateTime) per patient. When handling requests for “all patient data,” it will look across all CCDAs that have been received.


EYEFINITY FHIR® API server maps FHIR® resources to USCDIs



FHIR® Mapping Table

USCDI FHIR® Resource Resource Reference Documentation
Patient Demographics Patient
Supported Interaction: SearchType
Supported Search: _id, identifier, name, birthdate, gender
Supported DataType: String
Implementation Notes: Demographic searches require only one criteria which is the patient ID. Other searches such as family with name and given with name are not supported.
URL Syntax:
  • GET [Base_URL]/Patient/_search?Patient=[id]
  • GET [Base_URL]/Patient?identifier={system|}[code]
  • GET [Base_URL]/Patient?name=[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": "11f0dca8-98aa-4faa-a0f6-10ef903dfe14",
  "meta": {
    "lastUpdated": "2020-09-09T21:13:17+00:00"
  },
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/Patient/101305"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://{Base_URL}/Patient/101305?_format=json",
      "resource": {
        "resourceType": "Patient",
        "id": "101305",
        "meta": {
          "versionId": "200007",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "language": "English- [en-US]",
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "text",
                "valueString": "WHITE"
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2108-9",
                  "display": "White European"
                }
              }
            ],
            "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": "2186-5",
                  "display": "Not Hispanic or Latino"
                }
              },
              {
                "url": "text",
                "valueString": "NOT 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",
                  "display": "Medical Record Number"
                }
              ],
              "text": "MRN"
            },
            "system": "urn:oid:1.1.1.1.1.1",
            "value": "new_dhit_amb_01"
          }
        ],
        "name": [
          {
            "use": "usual",
            "text": "Alice DhitNewPat1",
            "family": "DhitNewPat1",
            "given": [
              "Alice"
            ]
          },
          {
            "use": "official",
            "text": "Alicia DhitNewPat1",
            "family": "DhitNewPat1",
            "given": [
              "Alicia"
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "555-777-1234",
            "use": "mobile"
          },
          {
            "system": "phone",
            "value": "555-723-1544",
            "use": "home"
          }
        ],
        "gender": "female",
        "birthDate": "1970-05-01",
        "address": [
          {
            "use": "home",
            "line": [
              "1357, Amber Dr,"
            ],
            "city": "Beaverton",
            "state": "OR",
            "postalCode": "97006",
            "country": "USA",
            "period": {
              "start": "2015-06-22"
            }
          }
        ],
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en-US",
                  "display": "English (Region=United States)"
                }
              ],
              "text": "English (Region=United States)"
            }
          }
        ]
      }
    }
  ]
}

For more info refer to Patient resource on HL7.org
USCDI FHIR® Resource Resource Reference Documentation
Problem List Condition
Supported Interaction: SearchType
Supported Search: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge, date=le and category.
URL Syntax:
  • GET GET [Base_URL]/Condition?Patient=[id]&category=problem-list-item&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/Condition?Patient=101248&category=problem-list-item&date=ge2011-12-31&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 boolean
USCDI FHIR® Resource Resource Reference Documentation
Procedures Procedure
Supported Interaction: SearchType
Supported Search: patientID, date
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: combination of the patient and status search parameters, combination of the patient and code and date search parameters
URL Syntax:
  • GET GET [Base_URL]/Procedure?patient=[id]
  • GET GET [Base_URL]/Procedure?patient=[id]&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/Procedure?patient=101248
  • GET 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: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/Observation?patient=[id]&code=72166-2

URL Example:
  • GET 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: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/Observation?patient=[id]&category=vital-signs&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET 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: patientID, category, code and date
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: searching using the combination of the patient and category and status search parameters, combination of the patient and code and date search parameters
URL Syntax:
  • GET GET [Base_URL]/Observation?patient=[id]&category=laboratory
  • GET GET [Base_URL]/Observation?patient=[id]&code={system|}[code]
  • GET GET [Base_URL]/Observation?patient=[id]&category=laboratory&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/Observation?patient=101248&category=laboratory
  • GET GET [Base_URL]/Observation?patient=101248&code=http://loinc.org|2339-0
  • GET 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 boolean
USCDI FHIR® Resource Resource Reference Documentation
Laboratory Tests Diagnostic Report
Supported Interaction: SearchType
Supported Search: patientID, category, status and date
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: combination of the patient and status search parameters, combination of the patient and code and date search parameters
URL Syntax:
  • GET GET [Base_URL]/DiagnosticReport?patient=[id]
  • GET GET [Base_URL]/DiagnosticReport?patient=[id]&code={system|}[code]
  • GET GET [Base_URL]/DiagnosticReport?patient=[id]&category=LAB
  • GET GET [Base_URL]/DiagnosticReport?patient=[id]&category=LAB&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/DiagnosticReport?patient=101248
  • GET GET [Base_URL]/DiagnosticReport?patient=101248&code=http://loinc.org|24323-8
  • GET GET [Base_URL]/DiagnosticReport?patient=101248&category=LAB
  • GET GET [Base_URL]/DiagnosticReport?patient=101248&category=LAB&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: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/Goal?Patient=[id]

URL Example:
  • GET 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: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/Immunization?patient=[id]&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET 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: patientID and category
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID and category. Optional search parameters: date=ge, date=le and status.
URL Syntax:
  • GET GET [Base_URL]/CarePlan?patient=[id]&category=assess-plan&status={system|}[code]&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET 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: patientID and status
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/CareTeam?patient=[id]&status={system|}[code]&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/CareTeam?patient=101248&status=active&date=ge2011-12-31&date=le2011-12-31

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: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/Condition?Patient=[id]&category=health-concern&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET 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: patientID, intent and status
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/MedicationRequest?patient=[id]&intent={system|}[code]
  • GET GET [Base_URL]/MedicationRequest?patient=[id]&intent=order&status={system|}[code]

URL Example:
  • GET GET [Base_URL]/MedicationRequest?patient=101248&intent=order
  • GET 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: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: clinical-status={system|}[code]
URL Syntax:
  • GET GET [Base_URL]/AllergyIntolerance?Patient=[id]

URL Example:
  • GET 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) Implantable Device Tests
Supported Interaction: SearchType
Supported Search: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/Device?patient=[id]

URL Example:
  • GET 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 Document Reference
Supported Interaction: SearchType
Supported Search: patientID, _id, category and date
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: combination of the patient and status search parameters, combination of the patient and type and period search parameters
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?_id=[id]
  • GET GET [Base_URL]/DocumentReference?Patient=[id]
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&category=clinical-note
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&category=clinical-note&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/DocumentReference?_id=200007-DocRefClinicalNote-10001
  • GET GET [Base_URL]/DocumentReference?patient=101248
  • GET GET [Base_URL]/DocumentReference?patient=101248&category=clinical-note
  • GET 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 Consultation Note
Supported Interaction: SearchType
Supported Search: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7C11488-4

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7C11488-4

Return Type: JSON or XML
Returned Schema:

{
  "resourceType": "Bundle",
  "id": "3839b594-3ae1-41bb-a827-5e0177855ec9",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/DocumentReference?patient=101305&type=http://loinc.org%7C11488-4"
    }
  ],
  "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"
          }
        }
      }
    }
  ]
}

For more info refer to Clinical Notes resource on HL7.org
USCDI FHIR® Resource Resource Reference Documentation
Discharge Summary Discharge Summary
Supported Interaction: SearchType
Supported Search: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7C18842-5

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7C18842-5

Return Type: JSON or XML
Returned Schema:

{
  "resourceType": "Bundle",
  "id": "6e0ceb40-eb20-48bf-9c57-2347f9637f34",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/DocumentReference?patient=101305&type=http://loinc.org%7C18842-5"
    }
  ],
  "entry": [
    {
      "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"
          }
        }
      }
    }
  ]
}

For more info refer to Clinical Notes resource on HL7.org
USCDI FHIR® Resource Resource Reference Documentation
History and Physical Note History and Physical Note
Supported Interaction: SearchType
Supported Search: patientID
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: date=ge and date=le.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7C34117-2

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7C34117-2

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
Procedure Note Procedure Note
Supported Interaction: SearchType
Supported Search: patientID, category, code and date
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID. Optional search parameters: combination of the patient and status search parameters, combination of the patient and code and date search parameters
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&category={system|}[code]
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&code={system|}[code]
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&category={system|}[code]&code={system|}[code]&date=geYYYY-MM-DD&date=leYYYY-MM-DD

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248
  • GET GET [Base_URL]/DocumentReference?Patient=101248&category=http://loinc.org%7CLP29684-5
  • GET GET [Base_URL]/DocumentReference?Patient=101248&code=http://loinc.org|24323-8
  • GET 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 Progress Note
Supported Interaction: SearchType
Supported Search: patientID, type
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7C11506-3

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7C11506-3

Return Type: JSON or XML
Returned Schema:

{
  "resourceType": "Bundle",
  "id": "2931ea72-b674-448e-8022-777d2ea8e3d0",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/DocumentReference?patient=101305&type=http://loinc.org%7C11506-3"
    }
  ],
  "entry": [
    {
      "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 Clinical Notes resource on HL7.org
USCDI FHIR® Resource Resource Reference Documentation
Cardiology Report CardiologyReport
Supported Interaction: SearchType
Supported Search: patientID, type
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7CLP29708-2

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7CLP29708-2

Return Type: JSON or XML
Returned Schema:

{
  "resourceType": "Bundle",
  "id": "29535296-d3e7-49ca-b9ce-a353477f543e",
  "meta": {
    "lastUpdated": "2020-09-09T21:13:17+00:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport"
    ]
  },
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/diagnosticreport?Patient=101305"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://{Base_URL}/diagnosticreport/200007-DiagnosticLab-10010",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "200007-DiagnosticLab-10010",
        "identifier": [
          {
            "use": "official",
            "system": "urn:ietf:rfc:3986",
            "value": "urn:uuid:b6854481-a854-4d89-a26b-9cb59bda2d8d"
          }
        ],
        "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/101305",
          "display": "Alice DhitNewPat1"
        },
        "effectivePeriod": {
          "start": "2015-06-22T11:00:00-05:00",
          "end": "2015-06-22T12:00:00-05:00"
        },
        "issued": "2015-06-21T16:00:00+00:00",
        "performer": [
          {
            "reference": "Organization/200007-ResultOrg-10010",
            "display": "Neighborhood Physicians Practice"
          }
        ],
        "presentedForm": [
          {
            "contentType": "text/plain",
            "data": "Q2FyZGlvbG9neSBSZXBvcnQ="
          }
        ]
      }
    }
  ]
}

For more info refer to Clinical Notes resource on HL7.org
USCDI FHIR® Resource Resource Reference Documentation
Pathology Report Pathology Report
Supported Interaction: SearchType
Supported Search: patientID, type
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7CLP7839-6

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7CLP7839-6

Return Type: JSON or XML
Returned Schema:

{
  "resourceType": "Bundle",
  "id": "f46f9d00-9ee9-4735-a5fb-34ee4c5b6853",
  "meta": {
    "lastUpdated": "2020-09-09T21:13:17+00:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport"
    ]
  },
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/diagnosticreport?Patient=101305"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://{Base_URL}/diagnosticreport/200007-DiagnosticLab-10009",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "200007-DiagnosticLab-10009",
        "identifier": [
          {
            "use": "official",
            "system": "urn:ietf:rfc:3986",
            "value": "urn:uuid:71a8f3f3-acea-4d6a-85ff-3cba5dd5263d"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LP7839-6",
                "display": "Pathology Result"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "28570-0",
              "display": "Procedure Note"
            }
          ],
          "text": "Procedure Note"
        },
        "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-21T16:00:00+00:00",
        "performer": [
          {
            "reference": "Organization/200007-ResultOrg-10009",
            "display": "Neighborhood Physicians Practice"
          }
        ],
        "presentedForm": [
          {
            "contentType": "text/plain",
            "data": "UGF0aG9sb2d5IFJlc3VsdA=="
          }
        ]
      }
    }
  ]
}

For more info refer to Clinical Notes resource on HL7.org
USCDI FHIR® Resource Resource Reference Documentation
Radiology Report RadiologyReport
Supported Interaction: SearchType
Supported Search: patientID, type
Supported DataType: String
Implementation Notes: Standard patient identifier. The parameter being passed is the patient ID.
URL Syntax:
  • GET GET [Base_URL]/DocumentReference?Patient=[id]&type=http://loinc.org%7CLP29684-5

URL Example:
  • GET GET [Base_URL]/DocumentReference?Patient=101248&type=http://loinc.org%7CLP29684-5

Return Type: JSON or XML
Returned Schema:

{
  "resourceType": "Bundle",
  "id": "29535296-d3e7-49ca-b9ce-a353477f543e",
  "meta": {
    "lastUpdated": "2020-09-09T21:13:17+00:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport"
    ]
  },
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://{Base_URL}/diagnosticreport?Patient=101305"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://{Base_URL}/diagnosticreport/200007-DiagnosticLab-10010",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "200007-DiagnosticLab-10010",
        "identifier": [
          {
            "use": "official",
            "system": "urn:ietf:rfc:3986",
            "value": "urn:uuid:b6854481-a854-4d89-a26b-9cb59bda2d8d"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LP29684-5",
                "display": "Radiology Result"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "28570-0",
              "display": "Procedure Note"
            }
          ],
          "text": "Procedure Note"
        },
        "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-21T16:00:00+00:00",
        "performer": [
          {
            "reference": "Organization/200007-ResultOrg-10010",
            "display": "Neighborhood Physicians Practice"
          }
        ],
        "presentedForm": [
          {
            "contentType": "text/plain",
            "data": "UmFkaW9sb2d5IFJlc3VsdA=="
          }
        ]
      }
    }
  ]
}

For more info refer to Clinical Notes 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

GET fhir/{type}/{id}

FhirResponse
NameDescriptionTypeAdditional 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://fhirapi.eyefinity.com/fhir/Condition/_search?Patient=tokenID&_format=JSON
  • This will provide a response in JSON format
Application/XML
  • https://fhirapi.eyefinity.com/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 provides a HTTP status code and a Meaningful messages in both JSON/XML format.

Forbidden Request - HTTP Status Code - 403
  • A user trying to access another users 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
  • An 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



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