Patient

Base profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient

The data in the Resource covers the "who" information about the patient: its attributes are focused on the demographic information necessary to support the administrative, financial and logistic procedures.

Sample Response Object:

{
  "resourceType" : "Patient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for this patient
  "active" : <boolean>, // Whether this patient's record is in active use
  "name" : [{ HumanName }], // A name associated with the patient
  "telecom" : [{ ContactPoint }], // A contact detail for the individual
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date of birth for the individual
  // deceased[x]: Indicates if the individual is deceased or not. One of these 2:
  "deceasedBoolean" : <boolean>,
  "deceasedDateTime" : "<dateTime>",
  "address" : [{ Address }], // An address for the individual
  "maritalStatus" : { CodeableConcept }, // Marital (civil) status of a patient
  // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2:
  "multipleBirthBoolean" : <boolean>,
  "multipleBirthInteger" : <integer>,
  "photo" : [{ Attachment }], // Image of the patient
  "contact" : [{ // A contact party (e.g. guardian, partner, friend) for the patient
    "relationship" : [{ CodeableConcept }], // The kind of relationship
    "name" : { HumanName }, // A name associated with the contact person
    "telecom" : [{ ContactPoint }], // A contact detail for the person
    "address" : { Address }, // Address for the contact person
    "gender" : "<code>", // male | female | other | unknown
    "organization" : { Reference(Organization) }, // C? Organization that is associated with the contact
    "period" : { Period } // The period during which this contact person or organization is valid to be contacted relating to this patient
  }],
  "communication" : [{ // A language which may be used to communicate with the patient about his or her health
    "language" : { CodeableConcept }, // R!  The language which can be used to communicate with the patient about his or her health
    "preferred" : <boolean> // Language preference indicator
  }],
  "generalPractitioner" : [{ Reference(Organization|Practitioner|
   PractitionerRole) }], // Patient's nominated primary care provider
  "managingOrganization" : { Reference(Organization) }, // Organization that is the custodian of the patient record
  "link" : [{ // Link to another patient resource that concerns the same actual person
    "other" : { Reference(Patient|RelatedPerson) }, // R!  The other patient or related person resource that the link refers to
    "type" : "<code>" // R!  replaced-by | replaces | refer | seealso
  }]
}

Export

The GET: /Patient/$export endpoint is part of the FHIR Bulk Data Access specification, which allows large-scale export of data from a FHIR server. This endpoint supports exporting data in bulk for a set of patients, letting clients efficiently fetch large amounts of data for further processing or analysis. Here’s a general description:

Key Concepts

Asynchronous Request: The export operation is typically performed asynchronously. The server acknowledges the request and processes it in the background. Clients must periodically poll the server to check the status of the export.
Bulk Data Export: The response contains links to files that can be downloaded. These files include data related to patients, such as demographic information, medical histories, and other clinical data.
NDJSON Format: Data is generally exported in Newline Delimited JSON (NDJSON) format for efficient parsing and processing.

Request

GET [base]/Patient/$export

Query Parameters

_outputFormat (optional): Specifies the format of the generated files (e.g., application/fhir+ndjson).
_since (optional): Only include resource versions updated after this time.
_type (optional): Specifies the types of resources to be included in the export.
_typeFilter (optional): A parameter to filter the resources further.

Example Request

GET /Patient/$export?\_outputFormat=application/fhir+ndjson&\_since=2021-01-01T00:00:00Z&\_type=Patient,Observation

Initial Response

An initial response confirms that the export request has been received and provides a URL to check the status of the request.

202 Accepted  
Content-Location: [status_endpoint_URL]

Status Check

Clients can poll the Content-Location URL to check the status of their request. If the export is still processing, the server responds with status information.

GET [status_endpoint_URL]

Completed Response

When the export is complete, the status check URL provides the files for download.

200 OK  
{  
  "transactionTime": "2023-10-01T00:00:00Z",  
  "request": "/Patient/$export?\_outputFormat=application/fhir+ndjson&\_type=Patient,Observation",  
  "requiresAccessToken": true,  
  "output": \[  
    {  
      "type": "Patient",  
      "url": "[download_URL_for_Patient_data]"  
    },  
    {  
      "type": "Observation",  
      "url": "[download_URL_for_Observation_data]"  
    }  
  ]  
}

Error Handling

If there are any errors during the export process, the status check response will include details about the issues encountered.