FHIR Patient

Name:

id

required

Type:

path

Data Type:

string

Description:

The resource identifier of the Patient, which is part of the response when calling the Patient Search API.

Sample Value: IFAUCLJQGAYDAMJNHBAE6USJJ5HA

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Controls whether the response is returned in JSON or XML format. If not supplied, then defaults to json.

Sample Value: json

Name:

family

optional

Type:

query

Data Type:

string

Description:

The family name (last name) of the patient.

Sample Value: cardinal

Name:

given

optional

Type:

query

Data Type:

string

Description:

The given name (first name) of the patient.

Sample Value: jack

Name:

name

optional

Type:

query

Data Type:

string

Description:

The family name (last name) or the given name (first name) of the patient.

Sample Value: george

Name:

birthdate

optional

Type:

query

Data Type:

string

Description:

The patient's date of birth. The format of the birthdate value is yyyy-mm-dd.

Sample Value: 1949-11-12

Name:

gender

optional

Type:

query

Data Type:

string

Description:

Gender of the patient. Possible values are

• male
• female
• other
• unknown

Sample Value: female

Name:

identifier

optional

Type:

query

Data Type:

string

Description:

An identifier for the patient in the format, namespace|id

Sample Value: ORION|AAA-00001-8

Name:

Content-Type

required

Type:

header

Data Type:

string

Description:

Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded

Sample Value: application/x-www-form-urlencoded

Name:

family

optional

Type:

formData

Data Type:

string

Description:

The family name (last name) of the patient.

Sample Value: cardinal

Name:

given

optional

Type:

formData

Data Type:

string

Description:

Filters the results to patients with a matching given name (first name)

Sample Value: jono

Name:

name

optional

Type:

formData

Data Type:

string

Description:

The family name (last name) or the given name (first name) of the patient.

Sample Value: cardinal

Name:

birthdate

optional

Type:

formData

Data Type:

string

Description:

Filters the results to patients with a matching date of birth. The format of the birthdate value is yyyy-mm-dd

Sample Value: 1949-11-12

Name:

gender

optional

Type:

formData

Data Type:

string

Description:

Gender of the patient. Possible values are

• male
• female
• other
• unknown

Sample Value: male

Name:

identifier

optional

Type:

formData

Data Type:

string

Description:

An identifier for the patient in the format, namespace|id

Sample Value: ORION|AAA-00001-8

Name:

paramater

required

Type:

body

Data Type:

Description:

Filters the export of Bulk data

• parameter.name=_type : Defines the FHIR Resources to be included in the $export operation. This is a comma separated list of FHIR resource names.
• parameter.name=_since : Defines the last updated date for the resources that are exported.
• parameter.name=_outputFormat: Defines the format for the requested Bulk Data files to be generated. Only application/fhir+ndjson is supported
• parameter.name=patient: A required and repeatable parameter with Patient FHIR ID references. The value for the 'patient' parameter can be with or without the resource name. e.g both "Patient/GYZGCNDDMRSWMQCPJBBVA" and "GYZGCNDDMRSWMQCPJBBVA" are supported
• parameter.name=-include-sources : Defines for each FHIR resource which sources should be queried for the results. If -include-sources is specified, for the resource specified ONLY the specified sources will be searched. Note that the sources specified should be enabled.
• parameter.name=-exclude-sources : Defines for a specific FHIR resource which sources should NOT be queried for the results. If -exclude-sources is specified, for the resource specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Payload:

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "_outputFormat",
      "valueString": "application/fhir+ndjson"
    },
    {
      "name": "_type",
      "valueString": "Patient,Immunization,Procedure"
    },
    {
      "name": "_since",
      "valueInstant": "2022-01-01"
    },
    {
      "name": "patient",
      "valueString": "Patient/GYZGCNDDMRSWMQCPJBBVA"
    }
  ]
}

Name:

Accept

required

Type:

header

Data Type:

string

Description:

Specifies the format of the optional FHIR OperationOutcome resource response to the kick-off request. Only application/fhir+json is supported.

Sample Value: application/fhir+json

Name:

Prefer

required

Type:

header

Data Type:

string

Description:

Specifies whether the response is immediate or asynchronous. Only a value of respond-async is supported.

Sample Value: respond-async

Name:

jobid

required

Type:

query

Data Type:

string

Description:

The Unique id of the export job. The job id and the path to poll the job status were returned in the Content-Location of the $export response.

Sample Value: 7fc54d79-2701-417b-a790-0e9a739d37ff

Name:

jobid

required

Type:

query

Data Type:

string

Description:

The Unique id of the export job. The job id and the path to poll the job status were returned in the Content-Location of the $export response.

Sample Value: 7fc54d79-2701-417b-a790-0e9a739d37ff

Name:

jobid

required

Type:

query

Data Type:

string

Description:

The Unique id of the export job. The Full URL of the file to be downloaded contains the jobid and is provided in the $export-poll-status output or error array url links for completed jobs

Sample Value: 7fc54d79-2701-417b-a790-0e9a739d37ff

Name:

resource

required

Type:

query

Data Type:

string

Description:

The FHIR Resource type that is contained in the file to be downloaded

Sample Value: Procedure

Name:

file

required

Type:

query

Data Type:

string

Description:

The file name to be downloaded

Sample Value: Patient_1.ndjson