AllegianceMD FHIR Server
US Core 6.1.0 Implementation Guide — RESTful FHIR R4 API
31Resources
84Endpoints
R4FHIR Version
System Level Operations
GET
/metadata
server-capabilities: Fetch the server FHIR CapabilityStatement
200 Success — Returns
application/fhir+json or application/fhir+xml
AllergyIntolerance
Base:
AllergyIntolerance
Supported: us-core-allergyintolerance
GET
/AllergyIntolerance/{id}
read-instance: Read AllergyIntolerance instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/AllergyIntolerance
search-type: Search for AllergyIntolerance instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who the sensitivity is for | optional |
clinical-status |
query | active | inactive | resolved | optional |
GET
/AllergyIntolerance/_search
search-type: Search for AllergyIntolerance instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who the sensitivity is for | optional |
clinical-status |
query | active | inactive | resolved | optional |
CarePlan
Base:
CarePlan
Supported: us-core-careplan
GET
/CarePlan/{id}
read-instance: Read CarePlan instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/CarePlan
search-type: Search for CarePlan instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | Who the care plan is for | optional |
category |
query | Type of plan | optional |
date |
query | Time period plan covers | optional |
status |
query | draft | active | on-hold | revoked | completed | entered-in-error | unknown | optional |
GET
/CarePlan/_search
search-type: Search for CarePlan instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | Who the care plan is for | optional |
category |
query | Type of plan | optional |
date |
query | Time period plan covers | optional |
status |
query | draft | active | on-hold | revoked | completed | entered-in-error | unknown | optional |
CareTeam
Base:
CareTeam
Supported: us-core-careteam
GET
/CareTeam/{id}
read-instance: Read CareTeam instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/CareTeam
search-type: Search for CareTeam instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who care team is for | optional |
role |
query | optional | |
status |
query | proposed | active | suspended | inactive | entered-in-error | optional |
GET
/CareTeam/_search
search-type: Search for CareTeam instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who care team is for | optional |
role |
query | optional | |
status |
query | proposed | active | suspended | inactive | entered-in-error | optional |
Condition
Base:
Condition
Supported: us-core-condition
Supported: us-core-condition-encounter-diagnosis
Supported: us-core-condition-problems-health-concerns
GET
/Condition/{id}
read-instance: Read Condition instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Condition
search-type: Search for Condition instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who has the condition? | optional |
abatement-date |
query | Date-related abatements (dateTime and period) | optional |
asserted-date |
query | optional | |
category |
query | The category of the condition | optional |
clinical-status |
query | The clinical status of the condition | optional |
code |
query | Code for the condition | optional |
encounter |
query | Encounter created as part of | optional |
onset-date |
query | Date related onsets (dateTime and Period) | optional |
recorded-date |
query | Date record was first recorded | optional |
GET
/Condition/_search
search-type: Search for Condition instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who has the condition? | optional |
abatement-date |
query | Date-related abatements (dateTime and period) | optional |
asserted-date |
query | optional | |
category |
query | The category of the condition | optional |
clinical-status |
query | The clinical status of the condition | optional |
code |
query | Code for the condition | optional |
encounter |
query | Encounter created as part of | optional |
onset-date |
query | Date related onsets (dateTime and Period) | optional |
recorded-date |
query | Date record was first recorded | optional |
Coverage
Base:
Coverage
Supported: us-core-coverage
GET
/Coverage/{id}
read-instance: Read Coverage instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Coverage
search-type: Search for Coverage instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | Retrieve coverages for a patient | optional |
GET
/Coverage/_search
search-type: Search for Coverage instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | Retrieve coverages for a patient | optional |
Device
Base:
Device
Supported: us-core-implantable-device
GET
/Device/{id}
read-instance: Read Device instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Device
search-type: Search for Device instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Patient information, if the resource is affixed to a person | optional |
status |
query | active | inactive | entered-in-error | unknown | optional |
type |
query | The type of the device | optional |
GET
/Device/_search
search-type: Search for Device instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Patient information, if the resource is affixed to a person | optional |
status |
query | active | inactive | entered-in-error | unknown | optional |
type |
query | The type of the device | optional |
DiagnosticReport
Base:
DiagnosticReport
Supported: us-core-diagnosticreport-note
Supported: us-core-diagnosticreport-lab
GET
/DiagnosticReport/{id}
read-instance: Read DiagnosticReport instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/DiagnosticReport
search-type: Search for DiagnosticReport instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The subject of the report if a patient | optional |
category |
query | Which diagnostic discipline/department created the report | optional |
code |
query | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result | optional |
date |
query | The clinically relevant time of the report | optional |
status |
query | The status of the report | optional |
GET
/DiagnosticReport/_search
search-type: Search for DiagnosticReport instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The subject of the report if a patient | optional |
category |
query | Which diagnostic discipline/department created the report | optional |
code |
query | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result | optional |
date |
query | The clinically relevant time of the report | optional |
status |
query | The status of the report | optional |
DocumentReference
Base:
DocumentReference
Supported: us-core-documentreference
GET
/DocumentReference/{id}
read-instance: Read DocumentReference instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/DocumentReference
search-type: Search for DocumentReference instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who/what is the subject of the document | optional |
category |
query | Categorization of document | optional |
date |
query | When this document reference was created | optional |
period |
query | Time of service that is being documented | optional |
status |
query | current | superseded | entered-in-error | optional |
type |
query | Kind of document (LOINC if possible) | optional |
POST
/DocumentReference
create-type: Create a new DocumentReference instance
200 Success — Returns
application/fhir+json or application/fhir+xml
GET
/DocumentReference/_search
search-type: Search for DocumentReference instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Who/what is the subject of the document | optional |
category |
query | Categorization of document | optional |
date |
query | When this document reference was created | optional |
period |
query | Time of service that is being documented | optional |
status |
query | current | superseded | entered-in-error | optional |
type |
query | Kind of document (LOINC if possible) | optional |
GET
/DocumentReference/$docref
GET: /DocumentReference/$docref
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | required | |
start |
query | optional | |
end |
query | optional | |
type |
query | optional |
POST
/DocumentReference/$docref
POST: /DocumentReference/$docref
200 Success — Returns
application/fhir+json or application/fhir+xml
Encounter
Base:
Encounter
Supported: us-core-encounter
GET
/Encounter/{id}
read-instance: Read Encounter instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Encounter
search-type: Search for Encounter instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
identifier |
query | Identifier(s) by which this encounter is known | optional |
patient |
query | The patient or group present at the encounter | optional |
class |
query | Classification of patient encounter | optional |
date |
query | A date within the period the Encounter lasted | optional |
discharge-disposition |
query | optional | |
location |
query | Location the encounter takes place | optional |
status |
query | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | optional |
type |
query | Specific type of encounter | optional |
GET
/Encounter/_search
search-type: Search for Encounter instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
identifier |
query | Identifier(s) by which this encounter is known | optional |
patient |
query | The patient or group present at the encounter | optional |
class |
query | Classification of patient encounter | optional |
date |
query | A date within the period the Encounter lasted | optional |
discharge-disposition |
query | optional | |
location |
query | Location the encounter takes place | optional |
status |
query | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | optional |
type |
query | Specific type of encounter | optional |
Goal
Base:
Goal
Supported: us-core-goal
GET
/Goal/{id}
read-instance: Read Goal instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Goal
search-type: Search for Goal instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | Who this goal is intended for | optional |
description |
query | optional | |
lifecycle-status |
query | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected | optional |
target-date |
query | Reach goal on or before | optional |
GET
/Goal/_search
search-type: Search for Goal instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
patient |
query | Who this goal is intended for | optional |
description |
query | optional | |
lifecycle-status |
query | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected | optional |
target-date |
query | Reach goal on or before | optional |
Group
Base:
Group
GET
/Group/{id}
read-instance: Read Group instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Group
search-type: Search for Group instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
identifier |
query | Unique id | optional |
member |
query | Reference to the group member | optional |
GET
/Group/_search
search-type: Search for Group instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
identifier |
query | Unique id | optional |
member |
query | Reference to the group member | optional |
Immunization
Base:
Immunization
Supported: us-core-immunization
GET
/Immunization/{id}
read-instance: Read Immunization instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Immunization
search-type: Search for Immunization instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The patient for the vaccination record | optional |
date |
query | Vaccination (non)-Administration Date | optional |
status |
query | Immunization event status | optional |
GET
/Immunization/_search
search-type: Search for Immunization instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The patient for the vaccination record | optional |
date |
query | Vaccination (non)-Administration Date | optional |
status |
query | Immunization event status | optional |
Location
Base:
Location
Supported: us-core-location
GET
/Location/{id}
read-instance: Read Location instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Location
search-type: Search for Location instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
address |
query | A (part of the) address of the location | optional |
address-city |
query | A city specified in an address | optional |
address-postalcode |
query | A postal code specified in an address | optional |
address-state |
query | A state specified in an address | optional |
name |
query | A portion of the location's name or alias | optional |
GET
/Location/_search
search-type: Search for Location instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
address |
query | A (part of the) address of the location | optional |
address-city |
query | A city specified in an address | optional |
address-postalcode |
query | A postal code specified in an address | optional |
address-state |
query | A state specified in an address | optional |
name |
query | A portion of the location's name or alias | optional |
Media
Base:
Media
GET
/Media/{id}
read-instance: Read Media instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
Medication
Base:
Medication
Supported: us-core-medication
GET
/Medication/{id}
read-instance: Read Medication instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
MedicationDispense
Base:
MedicationDispense
Supported: us-core-medicationdispense
GET
/MedicationDispense/{id}
read-instance: Read MedicationDispense instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/MedicationDispense
search-type: Search for MedicationDispense instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The identity of a patient to list dispenses for | optional |
status |
query | Returns dispenses with a specified dispense status | optional |
type |
query | Returns dispenses of a specific type | optional |
GET
/MedicationDispense/_search
search-type: Search for MedicationDispense instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The identity of a patient to list dispenses for | optional |
status |
query | Returns dispenses with a specified dispense status | optional |
type |
query | Returns dispenses of a specific type | optional |
MedicationRequest
Base:
MedicationRequest
Supported: us-core-medicationrequest
GET
/MedicationRequest/{id}
read-instance: Read MedicationRequest instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/MedicationRequest
search-type: Search for MedicationRequest instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Returns prescriptions for a specific patient | optional |
authoredon |
query | Return prescriptions written on this date | optional |
encounter |
query | Return prescriptions with this encounter identifier | optional |
intent |
query | Returns prescriptions with different intents | optional |
status |
query | Status of the prescription | optional |
GET
/MedicationRequest/_search
search-type: Search for MedicationRequest instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Returns prescriptions for a specific patient | optional |
authoredon |
query | Return prescriptions written on this date | optional |
encounter |
query | Return prescriptions with this encounter identifier | optional |
intent |
query | Returns prescriptions with different intents | optional |
status |
query | Status of the prescription | optional |
Observation
Base:
Observation
Supported: bp
Supported: bodyweight
Supported: resprate
Supported: bodyheight
Supported: heartrate
Supported: bodytemp
Supported: us-core-blood-pressure
Supported: us-core-body-temperature
Supported: us-core-pulse-oximetry
Supported: us-core-observation-sexual-orientation
Supported: us-core-bmi
Supported: us-core-heart-rate
Supported: us-core-respiratory-rate
Supported: us-core-observation-social-history
Supported: us-core-head-circumference
Supported: pediatric-bmi-for-age
Supported: us-core-smokingstatus
Supported: us-core-observation-survey
Supported: us-core-vital-signs
Supported: us-core-observation-clinical-test
Supported: us-core-body-weight
Supported: us-core-observation-sdoh-assessment
Supported: head-occipital-frontal-circumference-percentile
Supported: us-core-body-height
Supported: us-core-observation-imaging
Supported: us-core-observation-lab
Supported: pediatric-weight-for-height
Supported: us-core-observation-clinical-result
Supported: us-core-observation-occupation
Supported: us-core-observation-pregnancyintent
Supported: us-core-observation-pregnancystatus
Supported: us-core-observation-screening-assessment
GET
/Observation/{id}
read-instance: Read Observation instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Observation
search-type: Search for Observation instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
code |
query | The code of the observation type | optional |
patient |
query | The subject that the observation is about (if patient) | optional |
category |
query | The classification of the type of observation | optional |
date |
query | Obtained date/time. If the obtained element is a period, a date that falls in the period | optional |
status |
query | The status of the observation | optional |
GET
/Observation/_search
search-type: Search for Observation instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
code |
query | The code of the observation type | optional |
patient |
query | The subject that the observation is about (if patient) | optional |
category |
query | The classification of the type of observation | optional |
date |
query | Obtained date/time. If the obtained element is a period, a date that falls in the period | optional |
status |
query | The status of the observation | optional |
OperationDefinition
Base:
OperationDefinition
GET
/OperationDefinition/{id}
read-instance: Read OperationDefinition instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
Organization
Base:
Organization
Supported: us-core-organization
GET
/Organization/{id}
read-instance: Read Organization instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Organization
search-type: Search for Organization instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
address |
query | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | optional |
address-city |
query | A city specified in an address | optional |
address-postalcode |
query | A postal code specified in an address | optional |
address-state |
query | A state specified in an address | optional |
name |
query | A portion of the organization's name or alias | optional |
GET
/Organization/_search
search-type: Search for Organization instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
address |
query | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | optional |
address-city |
query | A city specified in an address | optional |
address-postalcode |
query | A postal code specified in an address | optional |
address-state |
query | A state specified in an address | optional |
name |
query | A portion of the organization's name or alias | optional |
Patient
Base:
Patient
Supported: us-core-patient
GET
/Patient/{id}
read-instance: Read Patient instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Patient
search-type: Search for Patient instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
address |
query | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | optional |
birthdate |
query | The patient's date of birth | optional |
death-date |
query | The date of death has been provided and satisfies this search value | optional |
email |
query | A value in an email contact | optional |
family |
query | A portion of the family name of the patient | optional |
gender |
query | Gender of the patient | optional |
given |
query | A portion of the given name of the patient | optional |
identifier |
query | A patient identifier | optional |
name |
query | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | optional |
phone |
query | A value in a phone contact | optional |
telecom |
query | The value in any kind of telecom details of the patient | optional |
GET
/Patient/_search
search-type: Search for Patient instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
address |
query | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | optional |
birthdate |
query | The patient's date of birth | optional |
death-date |
query | The date of death has been provided and satisfies this search value | optional |
email |
query | A value in an email contact | optional |
family |
query | A portion of the family name of the patient | optional |
gender |
query | Gender of the patient | optional |
given |
query | A portion of the given name of the patient | optional |
identifier |
query | A patient identifier | optional |
name |
query | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | optional |
phone |
query | A value in a phone contact | optional |
telecom |
query | The value in any kind of telecom details of the patient | optional |
Person
Base:
Person
GET
/Person/{id}
read-instance: Read Person instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
Practitioner
Base:
Practitioner
Supported: us-core-practitioner
GET
/Practitioner/{id}
read-instance: Read Practitioner instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Practitioner
search-type: Search for Practitioner instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
active |
query | Whether the practitioner record is active | optional |
address-city |
query | A city specified in an address | optional |
address-postalcode |
query | A postalCode specified in an address | optional |
address-state |
query | A state specified in an address | optional |
family |
query | A portion of the family name | optional |
given |
query | A portion of the given name | optional |
identifier |
query | A practitioner's Identifier | optional |
name |
query | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | optional |
GET
/Practitioner/_search
search-type: Search for Practitioner instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
active |
query | Whether the practitioner record is active | optional |
address-city |
query | A city specified in an address | optional |
address-postalcode |
query | A postalCode specified in an address | optional |
address-state |
query | A state specified in an address | optional |
family |
query | A portion of the family name | optional |
given |
query | A portion of the given name | optional |
identifier |
query | A practitioner's Identifier | optional |
name |
query | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | optional |
PractitionerRole
Base:
PractitionerRole
Supported: us-core-practitionerrole
GET
/PractitionerRole/{id}
read-instance: Read PractitionerRole instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/PractitionerRole
search-type: Search for PractitionerRole instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
specialty |
query | The practitioner has this specialty at an organization | optional |
practitioner |
query | Practitioner that is able to provide the defined services for the organization | optional |
GET
/PractitionerRole/_search
search-type: Search for PractitionerRole instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
specialty |
query | The practitioner has this specialty at an organization | optional |
practitioner |
query | Practitioner that is able to provide the defined services for the organization | optional |
Procedure
Base:
Procedure
Supported: us-core-procedure
GET
/Procedure/{id}
read-instance: Read Procedure instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Procedure
search-type: Search for Procedure instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Search by subject - a patient | optional |
code |
query | A code to identify a procedure | optional |
date |
query | When the procedure was performed | optional |
status |
query | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown | optional |
GET
/Procedure/_search
search-type: Search for Procedure instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Search by subject - a patient | optional |
code |
query | A code to identify a procedure | optional |
date |
query | When the procedure was performed | optional |
status |
query | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown | optional |
Provenance
Base:
Provenance
Supported: us-core-provenance
GET
/Provenance/{id}
read-instance: Read Provenance instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
QuestionnaireResponse
Base:
QuestionnaireResponse
GET
/QuestionnaireResponse/{id}
read-instance: Read QuestionnaireResponse instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/QuestionnaireResponse
search-type: Search for QuestionnaireResponse instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The patient that is the subject of the questionnaire response | optional |
authored |
query | When the questionnaire response was last changed | optional |
questionnaire |
query | The questionnaire the answers are provided for | optional |
status |
query | The status of the questionnaire response | optional |
GET
/QuestionnaireResponse/_search
search-type: Search for QuestionnaireResponse instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The patient that is the subject of the questionnaire response | optional |
authored |
query | When the questionnaire response was last changed | optional |
questionnaire |
query | The questionnaire the answers are provided for | optional |
status |
query | The status of the questionnaire response | optional |
ServiceRequest
Base:
ServiceRequest
Supported: us-core-servicerequest
GET
/ServiceRequest/{id}
read-instance: Read ServiceRequest instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/ServiceRequest
search-type: Search for ServiceRequest instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Search by subject - a patient | optional |
authored |
query | Date request signed | optional |
category |
query | Classification of service | optional |
code |
query | What is being requested/ordered | optional |
status |
query | draft | active | on-hold | revoked | completed | entered-in-error | unknown | optional |
GET
/ServiceRequest/_search
search-type: Search for ServiceRequest instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | Search by subject - a patient | optional |
authored |
query | Date request signed | optional |
category |
query | Classification of service | optional |
code |
query | What is being requested/ordered | optional |
status |
query | draft | active | on-hold | revoked | completed | entered-in-error | unknown | optional |
Specimen
Base:
Specimen
Supported: us-core-specimen
GET
/Specimen/{id}
read-instance: Read Specimen instance
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
id |
path | The resource ID | required |
GET
/Specimen
search-type: Search for Specimen instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The patient the specimen comes from | optional |
GET
/Specimen/_search
search-type: Search for Specimen instances
200 Success — Returns
application/fhir+json or application/fhir+xml
| Parameter | In | Description | Required |
|---|---|---|---|
_id |
query | The ID of the resource | optional |
patient |
query | The patient the specimen comes from | optional |