HiMS API Documentation

The Document Reference resource is used to index a document, clinical note, and other binary objects to make them available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be displayed to the user), and has defined update management. The DocumentReference resource can be used with any document format that has a recognized mime type and that conforms to this definition.

The DocumentReference resource returns data classes and elements defined for Clinical Notes in United States Core Data for Interoperability (USCDI v2) Consultation Note, Discharge Summary Note, History and Physical, Procedure Note, and Progress Note. Example API requests for a specific document, as well as to see all of the documents associated with a particular patient, are shown below:

Get using DocumentReference ID

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/DocumentReference/{documentReferenceID}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/DocumentReference/83462
                    

Retrieve all document references related to a patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/DocumentReference?patient={patientId}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/DocumentReference?patient=29355
                    

Find by Patient ID, category and date search parameters

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/DocumentReference?patient={patientId}&category={system}|{code}&date={date}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/DocumentReference?patient=29355&category=http://loinc.org|11488-4&date=ge2022-01-01T00:00:00Z
                    

Response schema

{
  "resourceType": "string",
  "id": "string",
  "type": "string",
  "total": 0,
  "link": [
    {
      "relation": "string",
      "url": "string"
    }
  ],
  "entry": [
    {
      "fullUrl": "string",
      "resource": {
        "resourceType": "string",
        "id": "string",
        "meta": {
          "versionId": "string",
          "lastUpdated": "string",
          "profile": [
            "string"
          ]
        },
        "identifier": [
          {
            "system": "string",
            "value": "string"
          }
        ],
        "status": "string",
        "type": {
          "coding": [
            {
              "system": "string",
              "code": "string"
            }
          ],
          "text": "string"
        },
        "category": [
          {
            "coding": [
              {
                "system": "string",
                "code": "string"
              }
            ],
            "text": "string"
          }
        ],
        "subject": {
          "reference": "string"
        },
        "date": "string",
        "author": [
          {
            "reference": "string",
            "display": "string"
          }
        ],
        "custodian": {
          "reference": "string",
          "display": "string"
        },
        "content": [
          {
            "attachment": {
              "contentType": "string",
              "data": "string"
            },
            "format": {
              "system": "string",
              "code": "string",
              "display": "string"
            }
          }
        ],
        "context": {
          "encounter": [
            {
              "reference": "string"
            }
          ],
          "period": {
            "start": "string",
            "end": "string"
          }
        }
      }
    }
  ]
}