Supported FHIR R4 Resources

The Veradigm FHIR API supports the following FHIR R4 resources. For information on FHIR resources supported by Altera EHR products and Altera’s Developer Program, contact Altera at ADP@alterahealth.com. Veradigm EHR version 26.0 supports these FHIR resources. For versions earlier than 26.0, consult the Capability Statement.

FHIR Resource Catalog

AllergyIntolerance resource

The AllergyIntolerance resource contains a record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.

AllergyIntolerance supported profiles

AllergyIntolerance supported searches

Name	Type	Description	Syntax
id	token	AllergyIntolerance resource ID	GET [base]/AllergyIntolerance/[id]
patient	reference	who the sensitivity is for	GET [base]/AllergyIntolerance?patient=[patient]
patient+clinical-status	reference+token	who the sensitivity is for and a status of active, inactive, or resolved	GET [base]/AllergyIntolerance?patient=[patient]&clinical-status=[system]\|[code]
clinical-status	token	a status of active, inactive, or resolved	GET [base]/AllergyIntolerance?clinical-status=[system]\|[code]
_revinclude		Provenance:target	GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target
_include		AllergyIntolerance:encounter	GET /AllergyIntolerance?[parameters]&_include=AllergyIntolerance:encounter
_include		AllergyIntolerance:patient	GET /AllergyIntolerance?[parameters]&_include=AlleryIntolerance:patient

AllergyIntolerance resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	external IDs for this item
clinicalStatus	CodeableConcept	0..1	active \| inactive \| resolved
verificationStatus	CodeableConcept	1..1	unconfirmed \| confirmed \| refuted \| entered-in-error
type	code	0..1	allergy \| intolerance - Underlying mechanism (if known)
category	code	0..*	food \| medication \| environment \| biologic
criticality	code	0..1	low \| high \| unable-to-assess
code	CodeableConcept	1..1	code that identifies the allergy or intolerance
patient	Reference	1..1	who the sensitivity is for (Patient)
encounter	Reference	0..1	encounter when the allergy or intolerance was asserted (Encounter)
onsetDateTime	dateTime	0..1	when allergy or intolerance was identified
onsetAge	Age	0..1	when allergy or intolerance was identified
onsetPeriod	Period	0..1	when allergy or intolerance was identified
onsetRange	Range	0..1	when allergy or intolerance was identified
onsetString	string	0..1	when allergy or intolerance was identified
recordedDate	dateTime	0..1	date first version of the resource instance was recorded
recorder	Reference	0..1	who recorded the sensitivity (Practitioner, PractitionerRole, Patient, or RelatedPerson)
asserter	Reference	0..1	source of the information about the allergy (Practitioner, PractitionerRole, Patient, or RelatedPerson)
lastOccurrence	dateTime	0..1	date(/time) of last known occurrence of a reaction
note	Annotation	0..*	additional text not captured in other fields
reaction	BackboneElement	0..*	adverse reaction events linked to exposure to substance
reaction.substance	CodeableConcept	0..1	specific substance or pharmaceutical product considered to be responsible for event
reaction.manifestation	CodeableConcept	1..*	clinical symptoms/signs associated with the event
reaction.description	string	0..1	description of the event as a whole
reaction.onset	dateTime	0..1	date(/time) when manifestations showed
reaction.severity	code	0..1	mild \| moderate \| severe (of event as a whole)
reaction.exposureRoute	CodeableConcept	0..1	how the subject was exposed to the substance
reaction.note	Annotation	0..*	text about event not captured in other fields

AllergyIntolerance sample response


"resourceType": "AllergyIntolerance",
"id": "113",
"meta": {
	"lastUpdated": "2021-01-18T18:53:38.308+05:30",
 	"source": "{{FhirURL}}",
	"profile": [
		"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
                   ],
                    
	"clinicalStatus": {
		"coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ]
                },
	"type": "allergy",
	"category": [
                    "food"
                ],
	"code": {
		"coding": [
                        {
                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                            "code": "1008298",
                            "display": "acetaminophen / caffeine / chlorpheniramine / hydrocodone / phenylephrine"
                        }
                    ]
                },
	"patient": {
		"reference": "{{FhirURL}}/Patient/150",
		"type": "Patient",
		"display": "Smith, Jane"
                },
	"recordedDate": "2019-12-19T00:13:29+05:30",
	"lastOccurrence": "2019-12-19T00:13:29+05:30"

CarePlan resource

The CarePlan resource describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

CarePlan supported profiles

CarePlan supported searches

Name	Type	Description	Syntax
id	token	CarePlan resource with the given ID	GET [base]/CarePlan/[id]
patient	reference	who the care plan is for	GET [base]/CarePlan?patient=[patient]
patient+status	reference+token	who the care plan is for and plan status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown)	GET [base]/CarePlan?patient=[id]&status={system}\|[code]
patient+category	reference+date	who the care plan is for and type of plan	GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]
patient+date	reference+date	who the care plan is for and time period plan covers	GET [base]/CarePlan?patient=[id]&date=[date]
patient+category+status	reference+token+token	who the care plan is for and type of plan and plan status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown)	GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]&status=[status]
patient+category+status+date	reference+token+token+date	who the care plan is for and type of plan and plan status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown) and time period plan covers	GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]&status=[status]&date=[date]
patient+category+date	reference+token+date	who the care plan is for and type of plan and time period plan covers	GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]&date=[date]
category	token	type of plan	GET [base]/CarePlan?category=[system]\|[code]
date	date	time period plan covers	GET [base]/CarePlan?date=[date]
status	token	plan status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown)	GET [base]/CarePlan?status=[status]
status+category	token+token	plan status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown) and type of plan	GET [base]/CarePlan?category&status
category+date	token+date	type of plan and time period plan covers	[base]/CarePlan?category&date
status+category+date	token+token+date	plan status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown) and type of plan and time period plan covers	GET [base]/CarePlan?category&status&date
_revinclude		Provenance:target	GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target
_include		CarePlan:encounter	GET /CarePlan?[parameters]&_include=CarePlan:encounter
_include		CarePlan:subject	GET /CarePlan?[parameters]&_include=CarePlan:subject
_include		CarePlan:goal	GET /CarePlan?[parameters]&_include=CarePlan:goal
_include		CarePlan:addresses	GET /CarePlan?[parameters]&_include=CarePlan:addresses
_include		CarePlan:activity.outcomeReference	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference
_include		CarePlan:activity.outcomeReference.documentReference	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.documentReference
_include		CarePlan:activity.outcomeReference.procedure	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.procedure
_include		CarePlan:activity.outcomeReference.medication	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.medication
_include		CarePlan:activity.outcomeReference.observation	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.observation
_include		CarePlan:activity.outcomeReference.immunization	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.immunization
_include		CarePlan:activity.outcomeReference.condition	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.condition
_include		CarePlan:activity.outcomeReference.diagnosticReport	GET /CarePlan?[parameters]&_include=CarePlan:activity.outcomeReference.diagnosticReport
_include		CarePlan:activity.reference.medicationRequest	GET /CarePlan?[parameters]&_include=CarePlan:activity.reference.medicationRequest
_include		CarePlan:activity.reference	GET /CarePlan?[parameters]&_include=CarePlan:activity.reference

CarePlan resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	external IDs for this plan
instantiatesUri	canonical	0..*	instantiates FHIR protocol or definition
basedOn	Reference	0..*	a care plan that is fulfilled in whole or in part by this care plan (CarePlan)
replaces	Reference	0..*	a care plan replaced by this care plan (CarePlan)
partOf	Reference	0..*	part of referenced care plan (CarePlan)
status	code	1..1	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown
intent	code	1..1	proposal \| plan \| order \| option
category	CodeableConcept	0..*	type of plan
title	string	0..1	human-friendly name for the care plan
description	string	0..1	summary of the nature of the plan
subject	Reference	1..1	who the care plan is for (Patient, Group)
encounter	Reference	0..1	encounter created as part of (Encounter)
period	Period	0..1	time period the plan covers
created	dateTime	0..1	date record was first recorded
author	Reference	0..1	who is the designated responsible party (Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam)
contributor	Reference	0..*	who provided the content of the care plan party (Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam)
careTeam	Reference	0..*	who is involved in the plan (CarePlan)
addresses	Reference	0..*	health issue this plan addresses (Condition)
supportingInfo	Reference	0..*	information considered as part of the plan
goal	Reference	0..*	desired outcome of the plan (Goal)
activity	BackboneElement	0..*	action to occur as part of plan
activity.outcomeCodeableConcept	CodeableConcept	0..*	Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). This should not duplicate the activity status (for example, completed or in progress).
activity.outcomeReference	Reference	0..*	Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.
activity.progress	Annotation	0..*	Notes about the adherence/status/progress of the activity. Can be used to capture information about adherence, progress, concerns, etc. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.
activity.reference	Reference	0..1	activity details defined in specific resource (MedicationRequest, ServiceRequest )
activity.detail	BackboneElement	0..1	simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
note	Annotation	0..*	general notes about the care plan not covered elsewhere

CarePlan sample response


"resourceType": "CarePlan",
                "id": "1007",
                "meta": {
                    "lastUpdated": "2021-02-16T15:07:23.665+05:30",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
                    ]
                },
                
                "status": "active",
                "intent": "proposal",
                "category": [
                    {
                        "coding": [
                            {
                                "extension": [
                                    {
                                        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                        "valueCode": "unknown"
                                    }
                                ]
                            },
                            {
                                "system": "http://icdcodes.in",
                                "code": "771082000",
                                "display": "Acute medicine care plan"
                            }
                        ],
                        "text": "Acute medicine care plan"
                    }
                ],
                "subject": {
                    "reference": "{{FhirURL}}/Patient/7003",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "DL",
                                    "display": "Driver's license number"
                                }
                            ],
                            "text": "Driver's license number"
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "700270027002",
                        "period": {
                            "start": "2020-07-16T13:09:01+05:30",
                            "end": "2020-07-18T13:09:01+05:30"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/7001",
                            "type": "Organization"
                        }
                    },
                    "display": "Smith, James"
                },
                "period": {
                    "start": "2020-07-16T16:37:01+05:30",
                    "end": "2020-07-16T16:37:55+05:30"
                },
                "contributor": [
                    {
                        "reference": "{{FhirURL}}/Patient/7003",
                        "type": "Patient",
                        "identifier": {
                            "use": "official",
                            "type": {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                        "code": "DL",
                                        "display": "Driver's license number"
                                    }
                                ],
                                "text": "Driver's license number"
                            },
                            "system": "http://mockehr/CodeSystem/identifier",
                            "value": "700270027002",
                            "period": {
                                "start": "2020-07-16T13:09:01+05:30",
                                "end": "2020-07-18T13:09:01+05:30"
                            },
                            "assigner": {
                                "reference": "https:{{FhirURL}}/Organization/7001",
                                "type": "Organization"
                            }
                        },
                        "display": "Smith, James"
                    },
                    {
                        "reference": "{{FhirURL}}/RelatedPerson/30001",
                        "type": "RelatedPerson",
                        "display": "RelatedPerson summary"
                    }
                ],
                "note": [
                    {
                        "extension": [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                "valueCode": "unknown"
                            }
                        ]
                    }
                ]

CareTeam resource

The CareTeam resource describes all the people, teams, and organizations who plan to participate in the coordination and delivery of care for a single patient or a group (such as a married couple in therapy or a support group).

CareTeam supported profiles

CareTeam supported searches

Name	Type	Description	Syntax
id	token	CareTeam resource with the given ID	GET [base]/CareTeam/[id]
patient	reference	who the care team is for	GET [base]/CareTeam?patient=[id]
subject	reference	who the care team is for	GET [base]/CareTeam?subject=[reference]
encounter	reference	encounter created as part of	GET [base]/CareTeam?encounter=[reference]
category	token	type of team	GET [base]/CareTeam?category={system}\|[code]?
participant	reference	member of the team	GET [base]/CareTeam?Participant=[reference]
status	token	team status	GET [base]/CareTeam?status={system}\|[code]?
patient+participant	reference+reference	who the care team is for and member of the team	GET [base]/CareTeam?patient=[id]&Participant=[reference]
patient+category	reference+token	who the care team is for and type of team	GET [base]/CareTeam?patient=[id]&category={[system]}\|[code]
subject+category	reference+token	who the care team is for and type of team	GET [base]/CareTeam?subject=[reference]&status={[system]}\|[code]
patient+status	reference+token	who the care team is for and team status	GET [base]/CareTeam?patient=[id]&status={[system]}\|[code]
patient+role	reference+token	who the care team is for and type of involvement	GET [base]/CareTeam?patient={Type/}[id]&role={system\|}[code]}
_revinclude		Provenance:target	GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target
_include		CareTeam:subject	GET /CareTeam?[parameters]&_include=CareTeam:subject
_include		CareTeam:encounter	GET /CareTeam?[parameters]&_include=CareTeam:encounter
_include		CareTeam:participant.member	GET /CareTeam?[parameters]&_include=CareTeam:participant.member
_include		CareTeam:participant.member.patient	GET /CareTeam?[parameters]&_include=CareTeam:participant.member.patient
_include		CareTeam:participant.member.organization	GET /CareTeam?[parameters]&_include=CareTeam:participant.member.organization
_include		CareTeam:participant.member.participant	GET /CareTeam?[parameters]&_include=CareTeam:participant.member.participant
_include		CareTeam:participant:PractitionerRole	GET [base]/CareTeam?[paramete]&_include=CareTeam:participant:PractitionerRole
_include		CareTeam:participant:Practitioner	GET [base]/CareTeam?[paramete]&_include=CareTeam:participant:Practitioner
_include		CareTeam:participant:RelatedPerson	GET [base]/CareTeam?[paramete]&_include=CareTeam:participant:RelatedPerson

CareTeam resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	external IDs for this team
status	code	0..1	proposed \| active \| suspended \| inactive \| entered-in-error
category	CodeableConcept	0..*	type of team
name	string	0..1	name of the team, such as crisis assessment team
subject	Reference	1..1	who the care team is for (Patient)
encounter	Reference	0..1	encounter created as part of (Encounter)
period	Period	0..1	time period team covers
participant	BackboneElement	1..*	members of team
participant.id	string	0..1	unique ID for inter-element referencing
participant.role	CodeableConcept	1..1	type of involvement
participant.member	Reference	1..1	who is involved (Practitioner, Organization, Patient, PractitionerRole, CareTeam, or RelatedPerson)
participant.onBehalfOf	Reference	0..1	organization of the practitioner (Organization)
participant.period	Period	0..1	time period of the participant
reasonCode	CodeableConcept	0..*	why the care team exists
reasonReference	Reference	0..*	why the care team exists (Condition)
managingOrganization	Reference	0..*	organization responsible for the care team
telecom	ContactPoint	0..*	a contact detail for the care team (that applies to all members)
note	Annotation	0..*	comments made about the care team

CareTeam sample response


"resourceType": "CareTeam",
                "id": "1542",
                "meta": {
                    "lastUpdated": "2025-03-25T13:03:01.083+05:30",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
                    ]
                },
                
                
                "status": "active",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "LA27976-2",
                                "display": "Encounter-focused care team"
                            },
                            {
                                "system": "http://loinc.org",
                                "code": "LA27978-8",
                                "display": "Condition-focused care team"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "{{FhirURL}}/Patient/1400",
                    "type": "Patient",
                    "display": "Smith, James"
                },
                "encounter": {
                    "reference": "{{FhirURL}}/Encounter/1321",
                    "type": "Encounter"
                },
                "participant": [
                    {
                        "role": [
                            {
                                "coding": [
                                    {
                                        "system": "http://nucc.org/provider-taxonomy",
                                        "code": "102X00000X",
                                        "display": "Poetry Therapist"
                                    }
                                ]
                            }
                        ],
                        "member": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ]
                        },
                        "period": {
                            "start": "2021"
                        }

Condition resource

The Condition resource describes a clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Condition supported profiles

Condition supported searches

Name	Type	Description	Syntax
id	token	Condition resource with the given ID	GET [base]/Condition/[id]
patient	reference	who has the condition	GET [base]/Condition?patient=[patient]
clinical-status	token	clinical status of the condition	GET [base]/Condition?clinical-status=[system]\|[code]
category	token	category of the condition	GET [base]/Condition?category=[system]\|[code]
code	token	identification of the condition, problem or diagnosis	GET [base]/Condition?code=[system]\|[code]
onset-date	date	when the condition began	GET [base]/Condition?onset-date=[onset-date]
recorded-date	date	date condition was first recorded	GET [base]/Condition?patient={Type/}[id]&recorded-date={gt\|lt\|ge\|le}[date]
abatement-date	date	date when in resolution/remission	GET [base]/Condition?patient={Type/}[id]&abatement-date={gt\|lt\|ge\|le}[date]
encounter	reference	encounter created as part of	GET [base]/Condition?encounter={Type/}[id]
patient+code	reference+token	who has the condition and identification of the condition, problem or diagnosis	GET [base]/Condition?patient=[patient]&code=[system]\|[code]
patient+category	reference+token	who has the condition and category of the condition	GET [base]/Condition?patient=[patient]&category=[system]\|[code]
patient+clinical-status	reference+token	who has the condition and clinical status of the condition	GET [base]/Condition?patient=[patient]&clinical-status=[system]\|[code]
patient+onset-date	reference+date	who has the condition and when the condition began	GET [base]/Condition?patient=[patient]&onset-date={gt\|lt\|ge\|le}[date]
patient+recorded-date	reference+date	who has the condition and when the condition was first recorded	GET [base]/Condition?patient=[patient]&recorded-date={gt\|lt\|ge\|le}[date]
patient+abatement-date	reference+date	who has the condition and when the condition was resolved or in remission	GET [base]/Condition?patient=[patient]&abatement-date={gt\|lt\|ge\|le}[date]
patient+encounter	reference+reference	who has the condition and encounter created as part of	GET [base]/Condition?patient=[patient]&encounter={Type/}[id]
clinical-status+category	token+token	clinical status of the condition and category of the condition	GET [base]/Condition?clinical-status=[system]\|[code]&category=[system]\|[code]
category+encounter	token+reference	category of the condition and encounter created as part of	GET [base]/Condition?category=[system]\|[code]&encounter={Type/}[id]
_revinclude		Provenance:target	GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target

Condition resource contents

Name	Type	Cardinality	Description
assertedDate	dateTime	0..1	date the condition was first asserted
identifier	Identifier	0..*	external IDs for the condition
clinicalStatus	CodeableConcept	0..1	active \| recurrence \| relapse \| inactive \| remission \| resolved
verficationStatus	CodeableConcept	0..1	unconfirmed \| provisional \| differential \| confirmed \| refuted \| entered-in-error
category	CodeableConcept	1..*	category codes (Binding: ConditionCategoryCodes)
severity	CodeableConcept	0..1	subjective severity of condition
code	CodeableConcept	0..1	identification of the condition, problem, or diagnosis
bodySite	CodeableConcept	0..*	anatomical location, if relevant
subject	Reference	1..1	who has the condition (Patient or Group)
encounter	Reference	0..1	encounter created as part of (Encounter)
onsetDateTime	dateTime	0..1	estimated or actual date, date-time, or age
onsetAge	Age	0..1	estimated or actual date, date-time, or age
onsetPeriod	Period	0..1	estimated or actual date, date-time, or age
onsetRange	Range	0..1	estimated or actual date, date-time, or age
onsetString	string	0..1	estimated or actual date, date-time, or age
abatementDateTime	dateTime	0..1	when in resolution/remission
abatementAge	Age	0..1	when in resolution/remission
abatementPeriod	Period	0..1	when in resolution/remission
abatementRange	Range	0..1	when in resolution/remission
abatementString	string	0..1	when in resolution/remission
recordedDate	dateTime	0..1	date condition was first recorded
recorder	Reference	0..1	who recorded the condition (Practitioner, PractitionerRole, Patient, or RelatedPerson)
asserter	Reference	0..1	person who asserts this condition (Practitioner, PractitionerRole, Patient, or RelatedPerson)
stage	BackboneElement	0..*	stage/grade, usually assessed formally
stage.summary	CodeableConcept	0..1	simple summary (disease specific)
stage.assessment	Reference	0..*	formal record of assessment (DiagnosticReport or Observation)
stage.type	CodeableConcept	0..1	kind of staging
evidence	BackboneElement	0..*	supporting evidence
evidence.code	CodeableConcept	0..*	manifestation/symptom
evidence.detail	Reference	0..*	supporting information found elsewhere (can refer to any resource)
note	Annotation	0..*	additional information about the condition

Condition sample response


"resourceType": "Condition",
                "id": "300036",
                "meta": {
                    "lastUpdated": "2020-11-04T11:43:28.626+05:30",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
                    ]
                },
                
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                            "code": "inactive",
                            "display": "Inactive"
                        }
                    ]
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ]
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://term|inology.hl7.org/CodeSystem/condition-category",
                                "code": "enc,ounter-diagnosis",
                                "display": "Encounter Diagnosis"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "118623005",
                            "display": "Hallux valgus AND bunion",
                            "userSelected": false
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/45,405",
                    "type": "Patient",
                    "display": "Smith, James"
                },
                "recordedDate": "2019-09-23T22:13:24+05:30"

Coverage resource

The Coverage resource is intended to provide the high-level identifiers and descriptors of an insurance plan, typically the information which would appear on an insurance card, which may be used to pay, in part or in whole, for the provision of health care products and services. This resource may also be used to register 'SelfPay' where an individual or organization other than an insurer is taking responsibility for payment for a portion of the health care costs. Selfpay should not be confused with being a guarantor of the patient's account.

Coverage supported profiles

US Core 6.1.0 Coverage profile

Coverage supported searches

Name	Type	Description	Syntax
id	token	Coverage resource with the given ID	GET [base]/Coverage/[id]
patient	reference	Coverages for a patient	GET [base]/Coverage?patient=[patient]
_revinclude		Provenance:target	GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:target

Coverage resource contents

Name	Type	Cardinality	Description
identifier:memberid	Identifier	0..1	Member ID
identifier.type	Identifier	0..1	Member ID
status	code	1..1	active \| cancelled \| draft \| entered-in-error
type	CodeableConcept	0..1	Coverage category such as medical or accident
subscriberId	string	0..1	ID assigned to the subscriber
beneficiary	Reference	1..1	Plan beneficiary (Patient)
relationship	CodeableConcept	1..1	Beneficiary relationship to the subscriber
period	Period	0..1	Coverage start and end dates
payor	Reference	1..1	Issuer of the policy (Organization, Patient, or RelatedPerson)
class	BackboneElement	0..*	Additional coverage classifications. Can be sliced by group or plan
class.type	CodeableConcept	1..1	Type of class such as 'group' or 'plan'
class.value	string	1..1	(USCDI) Group Number or (USCDI) Plan Number
class.name	string	0..1	(USCDI) Group Name or (USCDI) Plan Name
order	positiveInt	0..1	Relative order of the coverage
network	string	0..1	Insurer network
costToBeneficiary	BackboneElement	0..*	Patient payments for services/products
costToBeneficiary.type	CodeableConcept	0..1	Cost category
costToBeneficiary.valueQuantity	SimpleQuantity	1..1
costToBeneficiary.valueMoney	Money	1..1
costToBeneficiary.exception	BackboneElement	0..*	Exceptions for patient payments
costToBeneficiary.exception.type	CodeableConcept	1..1	Exception category
costToBeneficiary.period	Period	0..1	The effective period of the exception
subrogation	boolean	0..1	Reimbursement to insurer
contract	Reference	0..*	Contract details

Coverage sample response



                "resourceType": "Coverage",
                "id": "2001",
                "meta": {
                    "versionId": "1.0.1",
                    "lastUpdated": "2025-08-22T01:43:51.298-04:00",
                    "source": {{FhirURL}},
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage"
                    ],
                    "security": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                            "version": "1",
                            "code": "R",
                            "display": "restricted",
                            "userSelected": true
                        }
                    ],
                    "tag": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/common-tags",
                            "code": "actionable",
                            "display": "Actionable",
                            "userSelected": true
                        }
                    ]
                },
               
                "status": "active",
                "type": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                            "code": "DENTPRG",
                            "display": "dental program"
                        }
                    ]
                },
                "policyHolder": {
                    "reference": "{{FhirURL}}/Patient/4006",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "TAX",
                                    "display": "Tax ID number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "T2301"
                    },
                    "display": "Smith, Jane"
                },
                "beneficiary": {
                    "reference": "{{FhirURL}}/Patient/4006",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "TAX",
                                    "display": "Tax ID number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "T2301"
                    },
                    "display": "Smith, Jane"
                },
                "relationship": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                            "code": "child",
                            "display": "Child"
                        }
                    ],
                    "text": "The Beneficiary is a child of the Subscriber"
                },
                "payor": [
                    {
                        "reference": "{{FhirURL}}/Patient/4006",
                        "type": "Patient",
                        "identifier": {
                            "use": "official",
                            "type": {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                        "code": "TAX",
                                        "display": "Tax ID number"
                                    }
                                ]
                            },
                            "system": "http://mockehr/CodeSystem/identifier",
                            "value": "T2301"
                        },
                        "display": "Smith, Jane"
                    }
                ],
                "class": [
                    {
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                                    "code": "group",
                                    "display": "Group"
                                }
                            ],
                            "text": "An employee group"
                        },
                        "value": "GrpValue123",
                        "name": "Group"
                    }
                ],
                "order": 1,
                "costToBeneficiary": [
                    {
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/coverage-copay-type",
                                    "code": "copay",
                                    "display": "Copay Amount"
                                }
                            ]
                        },
                        "valueQuantity": {
                            "value": 10.0,
                            "unit": "mmg"
                        },
                        "exception": [
                            {
                                "type": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/ex-coverage-financial-exception",
                                            "code": "foster",
                                            "display": "Foster child"
                                        }
                                    ],
                                    "text": "Foster Child"
                                }
                            }
                        ]
                    }
                ],
                "contract": [
                    {
                        "reference": "{{FhirURL}}/Contract/4006",
                        "type": "Contract",
                        "display": "Summary"
                    }
                ]
            }
        },

Device resource

The Device resource describes a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Device supported profiles

Device supported searches

Name	Type	Description	Syntax
id	token	Device resource with the given ID	GET [base]/Device/[id]
type	token	type of device	GET [base]/Device?type=[system]\|[code]
patient	reference	who received the device	GET [base]/Device?patient=[patient]
status	token	status of the device	GET [base]/Device?status={system\|}[code]
type+patient	token+reference	type of device and patient	GET [base]/Device?patient=[patient]&type=[system]\|[code]
patient+status	reference+token	patient and device status	GET [base]/Device?patient={Type/}[id]&status={system\|}[code]
_revinclude		Provenance:target	GET [base]/Device?[parameter=value]&_revinclude=Provenance:target

Device resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	instance identifier
definition	Reference	0..1	reference to the definition for the device (DeviceDefinition)
udiCarrier	BackboneElement	0..*	Unique Device Identifier (UDI) barcode string
udiCarrier.id	string	0..1	unique ID for inter-element referencing
udiCarrier.deviceIdentifier	string	1..1	mandatory fixed portion of UDI
udiCarrier.issuer	uri	0..1	UDI issuing organization
udiCarrier.jurisdiction	uri	0..1	regional UDI authority
udiCarrier.carrierAIDC	base64Binary	0..1	UDI machine readable barcode string
udiCarrier.carrierHRF	string	0..1	UDI human readable barcode string
udiCarrier.entryType	code	0..1	barcode \| rfid \| manual +
status	code	0..1	active \| inactive \| entered-in-error \| unknown
statusReason	CodeableConcept	0..*	online \| paused \| standby \| offline \| not-ready \| transduc-discon \| hw-discon \| off
distinctIdentifier	string	0..1	distinct identification string
manufacturer	string	0..1	name of device manufacturer
manufactureDate	dateTime	0..1	date when the device was made
expirationDate	dateTime	0..1	date and time of expiry of this device (if applicable)
lotNumber	string	0..1	lot number of manufacture
serialNumber	string	0..1	serial number assigned by the manufacturer
deviceName	BackboneElement	0..*	name of the device as given by the manufacturer
deviceName.id	string	0..1	unique ID for inter-element referencing
deviceName.name	string	1..1	name of the device
deviceName.type	code	1..1	udi-label-name \| user-friendly-name \| patient-reported-name \| manufacturer-name \| model-name \| other
modelNumber	string	0..1	model number for the device
partNumber	string	0..1	part number of the device
type	CodeableConcept	1..1	kind or type of device
specialization	BackboneElement	0..*	capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
specialization.id	string	0..1	unique ID for inter-element referencing
specialization.systemType	CodeableConcept	1..1	standard that is used to operate and communicate
specialization.version	string	0..1	version of the standard that is used to operate and communicate
version	BackboneElement	0..*	actual design of the device or software version running on the device
version.id	string	0..1	unique ID for inter-element referencing
version.type	CodeableConcept	0..1	type of the device version
version.component	Identifier	0..1	single component of the device version
version.value	string	1..1	version text
property	BackboneElement	0..*	actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
property.id	string	0..1	unique ID for inter-element referencing
property.type	CodeableConcept	1..1	code that specifies the property DeviceDefinitionPropetyCode
property.valueQuantity	Quantity	0..*	property value as a quantity
property.valueCode	CodeableConcept	0..*	property value as a code, e.g., NTP4 (synced to NTP)
patient	Reference	1..1	patient to whom device is affixed (Patient)
owner	Reference	0..1	organization responsible for device (Organization)
contact	ContactPoint	0..*	details for human/organization for support
location	Reference	0..1	where the device is found (Location)
uri	uri	0..1	network address to contact device
note	Annotation	0..*	device notes and comments
safety	CodeableConcept	0..*	safety characteristics of device
parent	Reference	0..1	parent device (Device)

Device sample response



"resourceType": "Device",
                "id": "2000",
                "meta": {
                    "lastUpdated": "2020-08-12T07:34:12.067-04:00",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
                    ]
                },
                
                "udiCarrier": [
                    {
                        "deviceIdentifier": "09504000059118",
                        "issuer": "https://mockEHR.allscripts.com/issuer",
                        "jurisdiction": "https://mockEHR.allscripts.com/jurisdiction",
                        "carrierAIDC": "MDEwMDExMDE=",
                        "carrierHRF": "(01)09504000059118(17)141120(10)7654321D(21)10987654d321",
                        "entryType": "barcode"
                    }
                ],
                "distinctIdentifier": "cellular and tissue-based product",
                "manufacturer": "ACME Biomedical",
                "manufactureDate": "2000-06-06T12:00:40-04:00",
                "expirationDate": "2022-04-01T12:00:40-04:00",
                "lotNumber": "7654321D",
                "serialNumber": "10987654d321",
                "type": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "6097006",
                            "display": "T-tube"
                        }
                    ],
                    "text": "T-tube"
                },
                "patient": {
                    "reference": "{{FhirURL}}/Patient/1000",
                    "type": "Patient",
                    "display": "Smith, James - Summary display"
                }

DiagnosticOrder resource

DSTU2

The DiagnosticOrder resource records a request for a set of diagnostic investigations to be performed.

DiagnosticReport resource

The DiagnosticReport resource describes the findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

DiagnosticReport supported profiles:

DiagnosticReport supported searches

Name	Type	Description	Syntax
id	token	DiagnosticReport resource with the given ID	GET [base]/DiagnosticReport/[id]
patient	reference	subject of the report if a patient	GET [base]/DiagnosticReport?patient=[patient]
patient+category	reference+token	subject of the report if a patient and which diagnostic discipline/department created the report	GET [base]/DiagnosticReport?patient=[patient]&category=[system]\|[code]
patient+code	reference+token	subject of the report if a patient and 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	GET [base]/DiagnosticReport?patient=[patient]&code=[system]\|[code]
patient+date	reference+date	subject of the report if a patient and clinically relevant time of the report	GET [base]/DiagnosticReport?patient=[patient]&date=[date]
patient+category+date	reference+token+date	subject of the report if a patient and which diagnostic discipline/department created the report and clinically relevant time of the report	GET [base]/DiagnosticReport?patient=[patient]&category=[system]\|[code]&date=[date]
patient+status	reference+token	subject of the report if a patient and status of the report	GET [base]/DiagnosticReport?patient=[patient]&status=[status]
patient+code+date	reference+token+date	subject of the report if a patient and code for the report and clinically relevant time of the report	GET [base]/DiagnosticReport?patient=[patient]&code=[system]\|[code]&date=[date]
status	token	status of the report	GET [base]/DiagnosticReport?status=[status]
category	token	which diagnostic discipline/department created the report	GET [base]/DiagnosticReport?category=[system]\|[code]
category+date	token+date	which diagnostic discipline/department created the report and clinically relevant time of the report	GET [base]/DiagnosticReport?category=[system]\|[code]&date=[date]
code+date	token+date	code for the report and clinically relevant time of the report	GET [base]/DiagnosticReport?code=[system]\|[code]&date=[date]
code	token	code for the report	GET [base]/DiagnosticReport?code=[system]\|[code]
date	date	clinically relevant time of the report	GET [base]/DiagnosticReport?date=[date]
_revinclude		Provenance:target	GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target

DiagnosticReport resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	instance identifier
basedOn	Reference	0..*	what was requested (CarePlan, MedicationRequest, or ServiceRequest)
status	code	1..1/td>	registered \| partial \| preliminary \| final
category	CodeableConcept	0..*	service category (Binding)
category:LaboratorySlice	CodeableConcept	1..1	service category
category:LaboratorySlice.id	string	0..1	unique ID for inter-element referencing
category:LaboratorySlice.coding	Coding	1..*	code defined by a terminology system
category:LaboratorySlice.coding.id	string	0..1	unique ID for inter-element referencing
category:LaboratorySlice.coding.system	uri	1..1	identity of the terminology system
category:LaboratorySlice.coding.version	string	0..1	version of the system if relevant
category:LaboratorySlice.coding.code	code	1..1	symbol in syntax defined by the system
category:LaboratorySlice.coding.display	string	0..1	representation defined by the system
category:LaboratorySlice.coding.userSelected	boolean	0..1	if this coding was chosen directly by the user
category:LaboratorySlice.text	string	0..1	plain text representation of the concept
code	CodeableConcept	1..1	report code (Binding for non lab codes)
subject	Reference	1..1	subject of the report - usually, but not always, the patient (Patient)
encounter	Reference	0..1	health care event when test ordered (Encounter)
effective[x]		0..1	diagnostically relevant time (typically the time of the procedure)
effectiveDateTime	dateTime
effectivePeriod	Period
issued	instant	0..1	dateTime this version was made
performer	Reference	0..*	responsible diagnostic service (Practitioner, Organization, PractitionerRole, or CareTeam)
resultsInterpreter	Reference	0..*	primary result interpreter (Practitioner, PractitionerRole, Organization, or CareTeam)
specimen	0..*	Reference	specimens this report is based on (Specimen)
result	Reference	0..*	observations (Observation)
imagingStudy	Reference	0..*	reference to full details of imaging associated with the diagnostic report (ImagingStudy)
media	BackboneElement	0..*	key images associated with this report
media.id	string	0..1	unique ID for inter-element referencing
media.comment	string	0..1	comment about the image; explanation
media.link	Reference	1..1	reference to the image source (Media)
conclusion	string	0..1	clinical conclusion (interpretation) of test results
conclusionCode	CodeableConcept	0..*	codes for the clinical conclusion of test results
presentedForm	Attachment	0..*	entire report as issued

DiagnosticReport sample response



"resourceType": "DiagnosticReport",
                "id": "2000",
                "meta": {
                    "lastUpdated": "2020-09-18T02:21:39.857-04:00",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
                    ]
                },
                
                "status": "amended",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                "version": "V2.3",
                                "code": "LAB",
                                "display": "Laboratory",
                                "userSelected": true
                            }
                        ],
                        "text": "Laboratory"
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "version": "V2.3",
                            "code": "1004-1",
                            "display": "Direct antiglobulin test.complement specific reagent [Presence] on Red Blood Cells",
                            "userSelected": true
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/66903",
                    "type": "Patient",
                    "display": "Generic Obs, Observation-Vital-TW-AA - Summary Display"
                },
                "effectivePeriod": {
                    "start": "2020-07-23T02:49:43-04:00",
                    "end": "2020-09-18T02:21:18-04:00"
                },
                "issued": "2020-08-28T04:14:39.585-04:00",
                "performer": [
                    {
                        "reference": "{{FhirURL}}/Practitioner/68",
                        "type": "Practitioner",
                        "display": "Terry"
                    }
                ],
                "result": [
                    {
                        "reference": "{{FhirURL}}/Observation/20002",
                        "type": "Observation",
                        "identifier": {
                            "use": "secondary",
                            "type": {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                        "code": "PPN",
                                        "display": "Passport number"
                                    }
                                ],
                                "text": "Passport number"
                            },
                            "system": "http://mockehr/CodeSystem/identifier",
                            "value": "2000020000",
                            "period": {
                                "start": "2020-06-09T02:38:05-04:00",
                                "end": "2020-06-12T02:38:05-04:00"
                            },
                            "assigner": {
                                "reference": "{{FhirURL}}/Organization/7001",
                                "type": "Organization"
                            }
                        },
                        "display": "Lab Results Summary Display"
                    }

DocumentReference

The DocumentReference resource describes a reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

DocumentReference supported profiles

DocumentReference supported searches

Name	Type	Description	Syntax
id	token	DocumentReference resource with the given ID	GET [base]/DocumentReference/[id]
patient	reference	subject of the document	GET [base]/DocumentReference?patient=[id]
patient+category	reference+token	subject of the document and categorization of document	GET [base]/DocumentReference?patient=[id]&category={[system]}\|[code]
patient+category+date	reference+token+date	subject of the document and categorization of document and when this document reference was created	GET [base]/DocumentReference?patient=[id]&category={system}\|[code]?&date={gt\|ge\|le\|lt}
patient+date	reference+date	subject of the document and when this document reference was created	GET [base]/DocumentReference?patient=[id]?&date={gt\|ge\|le\|lt}
patient+type	reference+token	subject of the document and kind of document	GET [base]/DocumentReference?patient=[id]&type={[system]}\|[code]
patient+status	reference+token	subject of the document and document status (current \| superseded \| entered-in-error)	GET [base]/DocumentReference?patient=[id]&status={[system]}\|[code]
patient+period	reference+date	subject of the document and time of service that is being documented	GET[base]/DocumentReference?patient=[id]?&period={gt\|ge\|le\|lt}[date]{&period={gt\|ge\|le\|lt}\|[date]&...}?
patient+type+period	reference+token+date	subject of the document and kind of document and time of service that is being documented	GET[base]/DocumentReference?patient=[id]&type={system}\|[code]?&period={gt\|ge\|le\|lt}[date]{&period={gt\|ge\|le\|lt}\|[date]&...}?
status	token	document status (current \| superseded \| entered-in-error)	GET [base]/DocumentReference?status=[token]
category	token	categorization of document	GET [base]/DocumentReference?category=[token]
type	token	kind of document	GET [base]/DocumentReference?type=[token]
date	date	when this document reference was created	GET [base]/DocumentReference?date={gt\|ge\|le\|lt}[date](&date={gt\|ge\|le\|lt}[date]}
period	date	time of service that is being documented	GET [base]/DocumentReference?period={gt\|ge\|le\|lt}[date](&period={gt\|ge\|le\|lt}[date]}?
category+date	token+date	categorization of document and when this document reference was created	GET [base]/DocumentReference?category={system}\|[code]?&date={gt\|ge\|le\|lt}[date](&date={gt\|ge\|le\|lt}[date]}
type+period	token+date	kind of document and time of service that is being documented	GET[base]/DocumentReference?type={system}\|[code]?&period={gt\|ge\|le\|lt}[date]{&period={gt\|ge\|le\|lt}\|[date]&...}?
_revinclude		Provenance:target	GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target

DocumentReference resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	instance identifier
status	code	1..1	current \| superseded \| entered-in-error
docStatus	code	0..1	preliminary \| final \| amended \| entered-in-error
type	CodeableConcept	1..1	kind of document (Binding)
category	CodeableConcept	1..*	categorization of document
category:uscore	CodeableConcept	0..*	categorization of document (Binding)
subject	Reference	1..1	who is the subject of the document (Patient)
date	instant	0..1	when this document reference was created
author	Reference	0..*	who authored the document (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson, or Device)
authenticator	Reference	0..1	who authenticated the document (Practitioner, PractitionerRole, or Organization)
custodian	Reference	0..1	organization which maintains the document
relatesTo	BackboneElement	0..*	relationships to other documents
relatesTo.id	string	0..1	unique ID for inter-element referencing
relatesTo.code	code	1..1	replaces \| transforms \| signs \| appends
relatesTo.target	Reference	1..1	target of the relationship (DocumentReference)
description	string	0..1	human-readable description
securityLabel	CodeableConcept	0..*	document security tags (Binding)
content	BackboneElement	1..*	document referenced
content.id	string	0..1	unique ID for inter-element referencing
content.attachment	Attachment	1..1	where to access the document
content.attachment.id	string	0..1	unique ID for inter-element referencing
content.attachment.contentType	code	0..1	mime type of the content, with charset etc (Binding)
content.attachment.language	code	0..1	human language of the content
content.attachment.data	base64Binary	0..1	data inline, base64ed
content.attachment.url	url	0..1	uri where the data can be found
content.attachment.size	unsignedInt	0..1	number of bytes of content (if url provided)
content.attachment.hash	base64Binary	0..1	hash of the data (sha-1, base64ed)
content.attachment.title	string	0..1	label to display in place of the data
content.attachment.creation	dateTime	0..1	date attachment was first created
content.format	Coding	0..1	format/content rules for the document (Binding)
context	BackboneElement	0..1	clinical context of document
context.id	string	0..1	unique ID for inter-element referencing
context.encounter	Reference	0..1	context of the document content (Encounter)
context.event	CodeableConcept	0..*	main clinical acts documented
context.period	Period	0..1	time of service that is being documented
context.facilityType	CodeableConcept	0..1	kind of facility where patient was seen
context.practiceSetting	CodeableConcept	0..1	additional details about where the content was created (e.g. clinical specialty)
context.sourcePatientInfo	Reference	0..1	patient demographics from source (Patient)
context.related	Reference	0..*	related identifiers or resources

DocumentReference sample response



"resourceType": "DocumentReference",
                "id": "616",
                "meta": {
                    "lastUpdated": "2021-05-07T14:14:19.301+05:30",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
                    ]
                },
                
                "masterIdentifier": {
                    "use": "usual",
                    "type": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                "version": "V1.0",
                                "code": "DL",
                                "display": "Driver's license number",
                                "userSelected": true
                            }
                        ],
                        "text": "Driver's license number"
                    },
                    "system": "http://mockehr/CodeSystem/identifier",
                    "value": "8003Abcd",
                    "period": {
                        "start": "2021-05-06T15:42:27+05:30",
                        "end": "2021-05-29T15:42:27+05:30"
                    },
                    "assigner": {
                        "reference": "{{FhirURL}}/Organization/01",
                        "type": "Organization"
                    }
                },
                "identifier": [
                    {
                        "use": "usual",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "version": "V1.0",
                                    "code": "DL",
                                    "display": "Driver's license number",
                                    "userSelected": true
                                }
                            ],
                            "text": "Driver's license number"
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "8003Abcd",
                        "period": {
                            "start": "2021-05-06T15:56:16+05:30",
                            "end": "2021-05-28T15:56:16+05:30"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/01",
                            "type": "Organization"
                        }
                    }
                ],
                "status": "current",
                "docStatus": "amended",
                "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": "{{FhirURL}}/Patient/1104",
                    "type": "Patient",
                    "display": "Smith, James"
                },
                "date": "2021-05-06T17:11:23.399+05:30",
                "author": [
                    {
                        "reference": "{{FhirURL}}/Practitioner/200",
                        "type": "Practitioner",
                        "display": "Practitioner Summary"
                    }
                ],
                "authenticator": {
                    "reference": "{{FhirURL}}/Practitioner/2000",
                    "type": "Practitioner",
                    "display": "Practitioner Summary"
                },
                "custodian": {
                    "reference": "{{FhirURL}}/Organization/01",
                    "type": "Organization"
                },
                "relatesTo": [
                    {
                        "code": "appends",
                        "target": {
                            "reference": "{{FhirURL}}/DocumentReference/602",
                            "type": "DocumentReference",
                            "identifier": {
                                "use": "usual",
                                "type": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                            "version": "V1.0",
                                            "code": "DL",
                                            "display": "Driver's license number",
                                            "userSelected": true
                                        }
                                    ],
                                    "text": "Driver's license number"
                                },
                                "system": "http://mockehr/CodeSystem/identifier",
                                "value": "8003Abcd",
                                "period": {
                                    "start": "2021-05-06T15:56:16+05:30",
                                    "end": "2021-05-28T15:56:16+05:30"
                                },
                                "assigner": {
                                    "reference": "{{FhirURL}}/Organization/01",
                                    "type": "Organization"
                                }
                            }
                        }
                    }
                ],
                "description": "Summary of episode note",
                "content": [
                    {
                        "attachment": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ]
                        },
                        "format": {
                            "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                            "version": "V2.0",
                            "code": "urn:hl7-org:sdwg:ccda-structuredBody:1.1",
                            "display": "For documents following C-CDA 1.1 constraints using a structured body.",
                            "userSelected": true
                        }
                    }
                ],
                "context": {
                    "period": {
                        "start": "2021-05-28T13:16:04+05:30"
                    }
                }

Encounter resource

The Encounter resource describes an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Encounter supported profiles:

Encounter supported searches

Name	Type	Description	Syntax
id	token	Encounter resource with the given ID	GET [base]/Encounter/[id]
patient	reference	patient or group present at the encounter	GET [base]/Encounter?patient=[id]
identifier	token	identifier(s) by which this encounter is known	GET [base]/Encounter?identifier=[token]
class	token	classification of patient encounter	GET [base]/Encounter?class=[code]
date	date	date within the period the encounter lasted	GET [base]/Encounter?date={gt\|ge\|le\|lt}[date](&date={gt\|ge\|le\|lt}[date]}
status	token	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled	GET [base]/Encounter?status=[code]
type	token	specific type of encounter	GET [base]/Encounter?type=[code]
patient+date	reference+date	patient or group present at the encounter and date within the period the encounter lasted	GET [base]/Encounter?patient=[id]&date={gt\|ge\|le\|lt}[date](&date={gt\|ge\|le\|lt}[date]}
class+patient	token+reference	classification of patient encounter and patient or group present at the encounter	GET [base]/Encounter?patient=[id]&class={[system]}\|[code]
patient+type	reference+token	patient or group present at the encounter and specific type of encounter	GET [base]/Encounter?patient=[id]&type={[system]}\|[code]
patient+location	reference+reference	patient or group present at the encounter and location the encounter takes place	GET [base]/Encounter?patient={Type/}[id]&location={Type/}[id]
patient+status	reference+token	patient or group present at the encounter and encounter status (planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled)	GET [base]/Encounter?patient={Type/}[id]&status={system\|}[code]
patient+discharge-disposition	reference+token	patient or group present at the encounter and category or kind of location after discharge	GET [base]/Encounter?patient={Type/}[id]&discharge-disposition={system\|}[code]
_revinclude		Provenance:target	GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target

Encounter resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	identifier(s) by which this encounter is known
identifier.id	string	0..1	unique ID for inter-element referencing
identifier.use	code	0..1	usual \| official \| temp \| secondary \| old (If known)
identifier.type	CodeableConcept	0..1	description of identifier (Binding)
identifier.system	uri	1..1	namespace for the identifier value
identifier.value	string	1..1	value that is unique
identifier.period	Period	0..1	time period when ID is/was valid for use
identifier.assigner	Reference	0..1	organization that issued ID (Organization)
status	code	1..1	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled
statusHistory	BackboneElement	0..*	past encounter statuses
statusHistory.id	string	0..1	unique ID for inter-element referencing
statusHistory.status	code	1..1	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled
statusHistory.period	Period	1..1	time that the episode was in the specified status
class	Coding	1..1	classification of patient encounter (Binding)
classHistory	BackboneElement	0..*	past encounter classes
classHistory.id	string	0..1	unique ID for inter-element referencing
classHistory.class	Coding	1..1	inpatient \| outpatient \| ambulatory \| emergency
classHistory.period	Period	1..1	time that the episode was in the specified class
type	CodeableConcept	1..*	specific type of encounter (Binding)
serviceType	CodeableConcept	0..1	specific type of service
priority	CodeableConcept	0..1	indicates the urgency of the encounter
subject	Reference	1..1	patient or group present at the encounter (Patient)
episodeOfCare	Reference	0..*	episode(s) of care that this encounter should be recorded against (EpisodeOfCare)
basedOn	Reference	0..*	ServiceRequest resource that initiated this encounter
participant	BackboneElement	0..*	participants involved in the encounter
participant.id	string	0..1	unique ID for inter-element referencing
participant.type	CodeableConcept	0..*	role of participant in encounter (Binding)
participant.period	Period	0..1	period of time during the encounter that the participant participated
participant.individual	Reference	0..1	persons involved in the encounter other than the patient (Practitioner, PractitionerRole, or RelatedPerson)
appointment	Reference	0..*	appointment that scheduled this encounter
period	Period	0..1	start and end time of the encounter
length	Duration	0..1	quantity of time the encounter lasted (less time absent)
reasonCode	CodeableConcept	0..*	coded reason the encounter takes place
reasonReference	Reference	0..*	reason the encounter takes place (Condition, Procedure, Observation, or ImmunizationRecommendation
diagnosis	BackboneElement	0..*	list of diagnosis relevant to this encounter
diagnosis.id	string	0..1	unique ID for inter-element referencing
diagnosis.condition	Reference	1..1	diagnosis or procedure relevant to the encounter (Condition or Procedure)
diagnosis.use	CodeableConcept	0..1	role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
diagnosis.rank	positiveInt	0..1	ranking of the diagnosis (for each role type)
account	Reference	0..*	set of accounts that may be used for billing for this encounter
hospitalization	BackboneElement	0..1	details about the admission to a healthcare service
hospitalization.id	string	0..1	unique ID for inter-element referencing
hospitalization.preAdmissionIdentifer	Identifier	0..1	pre-admission identifier
hospitalization.origin	Reference	0..1	location/organization from which the patient came before admission (Location or Organization
hospitalization.admitSource	CodeableConcept	0..1	from where patient was admitted (physician referral, transfer)
hospitalization.reAdmission	CodeableConcept	0..1	type of hospital re-admission that has occurred (if any); if the value is absent, then this is not identified as a readmission
hospitalization.dietPreference	CodeableConcept	0..*	diet preferences reported by the patient
hospitalization.specialCourtesy	CodeableConcept	0..*	special courtesies (VIP, board member)
	CodeableConcept	0..*	wheelchair, translator, stretcher, etc
hospitalization.destination	Reference	0..1	location/organization to which the patient is discharged (Location or Organization)
hospitalization.dischargeDisposition	CodeableConcept	0..1	category or kind of location after discharge
location	BackboneElement	0..*	locations where the patient has been
location.id	string	0..1	unique ID for inter-element referencing
location.location	Reference	1..1	location the encounter takes place
location.status	code	0..1	planned \| active \| reserved \| completed
location.physicalType	CodeableConcept	0..1	physical type of the location (usually the level in the location hierachy - bed room ward etc.)
location.period	Period	0..1	time period during which the patient was present at the location
serviceProvider	Reference	0..1	organization (facility) responsible for this encounter (Organization)
partOf	Reference	0..1	another encounter this encounter is part of (Encounter)

Encounter sample response



"resourceType": "Encounter",
                "id": "1393",
                "meta": {
                    "lastUpdated": "2021-04-29T15:36:54.299+05:30",
                    "source": "{{FhirURL}}/fhir-Std232",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
                    ]
                },
                
                "status": "arrived",
                "class": {
                    "system": "HTTP://terminology.hl7.org/CodeSystem/v3-ActCode",
                    "code": "PRENC",
                    "display": "pre-admission"
                },
                "type": [
                    {
                        "coding": [
                            {
                                "system": "HTTP://www.ama-assn.org/go/cpt",
                                "code": "10004",
                                "display": "Surgery-ATP"
                            }
                        ],
                        "text": "Surgery-ATP"
                    }
                ],
                "subject": {
                    "reference": "{{FhirURL}}/Patient/1300",
                    "type": "Patient",
                    "display": "Smith, James"
                },
                "period": {
                    "end": "2021-06-04T15:32:23+05:30"
                }
            }

Goal resource

The Goal resource describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, or meeting a process improvement objective.

Goal supported profiles

Goal supported searches

Name	Type	Description	Syntax
id	token	Goal resource with the given ID	GET [base]/Goal/[id]
patient	reference	who this goal is intended for	GET [base]/Goal?patient=[patient]
lifecycle-status	token	proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, or rejected	GET [base]/Goal?lifecycle-status=[system]\|[code]
target-date	date	date to reach the goal on or before	GET [base]/Goal?target-date=[target-date]
patient+lifecycle-status	reference+token	who this goal is intended for and one of the following: proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, or rejected	GET [base]/Goal?patient=[patient]&lifecycle-status=[system]\|[code]
patient+target-date	reference+date	who this goal is intended for and date to reach the goal on or before	GET [base]/Goal?patient=[patient]&target-date=[target-date]
patient+description	reference+token	who this goal is intended for and code or text describing the goal	GET [base]/Goal?patient={Type/}[id]&description={system\|}[code]
_revinclude		Provenance:target	GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target

Goal resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	identifier(s) by which this goal is known
lifecycleStatus	code	1..1	proposed \| planned \| accepted \| active \| on-hold \| completed \| cancelled \| entered-in-error \| rejected
achievementStatus	CodeableConcept	0..1	in-progress \| improving \| worsening \| no-change \| achieved \| sustaining \| not-achieved \| no-progress \| not-attainable
category	CodeableConcept	0..*	goal category such as treatment, dietary, or behavioral
priority
description	CodeableConcept	1..1	code or text describing goal
subject	Reference	1..1	who the goal is intended for (Patient)
start[x]		0..1	when goal pursuit begins
startDate	date
startCodeableConcept	CodeableConcept
target	BackboneElement	0..*	target outcome for the goal
target.id	string	0..1	unique ID for inter-element referencing
target.measure	CodeableConcept	0..1	parameter whose value is being tracked
target.detail[x]		0..1	target value to be achieved
target.detailQuantity	Quantity
target.detailRange	Range
target.detailCodeableConcept	CodeableConcept
target.detailString	string
target.detailBoolean	boolean
target.detailInteger	integer
target.detailRatio	Ratio
target.due[x]		0..1	reach goal on or before
target.dueDate	date
target.dueDuration	Duration
statusDate	date	0..1	when goal status took effect
statusReason	string	0..1	reason for current status
expressedBy	Reference	0..1	who's responsible for creating goal (Patient, Practitioner, PractitionerRole, or RelatedPerson)
addresses	Reference	0..*	issues addressed by this goal (Condition, Observation, MedicationStatement, NutritionOrder, ServiceRequest, or RiskAssessment)
note	Annotation	0..*	comments about the goal
outcomeCode	CodeableConcept	0..*	what result was achieved regarding the goal?
outcomeReference	Reference	0..*	observation that resulted from goal (Observation)

Goal sample response



"resourceType": "Goal",
                "id": "4001",
                "meta": {
                    "lastUpdated": "2020-09-10T05:12:24.79-04:00",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
                    ]
                },
                
                "lifecycleStatus": "planned",
                "description": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "version": "4.0.1",
                            "code": "568005",
                            "display": "Tic disorder",
                            "userSelected": true
                        }
                    ],
                    "text": "Habit disorder"
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/10004",
                    "type": "Patient",
                    "display": "Smith, James"
                },
                "expressedBy": {
                    "reference": "{{FhirURL}}/Patient/10004",
                    "type": "Patient",
                    "display": "Smith, James"
                }

Group resource

The Group resource describes a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; for example, a collection of entities that isn't an organization.

Group supported searches

Name	Type	Description	Syntax
characteristic	token	kind of group characteristic	GET [base]/Group?characteristic=[token]
type	token	type of resources the group contains	GET [base]/Group?type=[token]
member	reference	reference to the group member	GET [base]/Group?member=[reference]

Group resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	identifier(s) by which this group is known
active	boolean	0..1	whether this group's record is in active use
type	code	1..1	person \| animal \| practitioner \| device \| medication \| substance
actual	boolean	1..1	descriptive or actual
code	CodeableConcept	0..1	kind of group members
name	string	0..1	label for group
quantity	unsignedInt	0..1	Number of members
managingEntity	Reference	0..1	entity that is the custodian of the group's definition (Organization, RelatedPerson, Practitioner, PractitionerRole)
characteristic	BackboneElement	0..*	include or exclude group members by trait
characteristic.code	CodeableConcept	1..1	kind of characteristic
characteristic.value[x]		1..1	value held by characteristic
characteristic.valueCodeableConcept	CodeableConcept
characteristic.valueBoolean	Boolean
characteristic.valueQuantity	Quantity
characteristic.valueRange	Range
characteristic.valueReference	Reference
characteristic.exclude	boolean	1..1	group includes or excludes
characteristic.period	Period	0..1	period over which characteristic is tested
member	BackboneElement	0..*	who or what is in group
member.entity	Reference	1..1	reference to the group member (Patient, Practitioner, PractitionerRole, Device, Medication, or Group)
member.period	Period	0..1	period member belonged to the group
member.inactive	boolean	0..1	if member is no longer in group

Group sample response



"resourceType": "Group",
                "id": "8000",
                               
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "DL",
                                    "display": "Driver's license number"
                                }
                            ]
                        },
                        
                "active": true,
                "type": "device",
                "actual": true,
                "quantity": 1,
                "managingEntity": {
                    "reference": "{{FhirURL}}/Practitioner/100",
                    "type": "Practitioner",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "DL",
                                    "display": "Driver's license number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "value123",
                        "period": {
                            "start": "2021-05-30T01:02:15-04:00",
                            "end": "2021-06-10T01:02:15-04:00"
                        }
                    },
                    "display": "s display"
                }

Immunization resource

The Immunization resource describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Immunization supported profiles

Immunization supported searches

Name	Type	Description	Syntax
id	token	Immunization resource with the given ID	GET [base]/Immunization/[id]
patient	reference	patient for the vaccination record	GET [base]/Immunization?patient=[reference]
status	token	immunization event status	GET [base]/Immunization?status=[status]
date	date	vaccination (non)-administration date	GET [base]/Immunization?date=[date]
patient+date	reference+date	patient for the vaccination record and vaccination (non)-administration date	GET [base]/Immunization?patient=[reference]&date={gt\|lt\|ge\|le}[date]
patient+status	reference+token	patient for the vaccination record and immunization event status	GET [base]/Immunization?patient=[reference]&status={system\|}[code]
patient+vaccine-code+date	reference+token+date	patient for the vaccination record and vaccine product administered and vaccination (non)-administration date	GET [base]/Immunization?patient=[id]&vaccineCode={[system]}\|[code]&date={gt\|ge\|le\|lt}[date](&date={gt\|ge\|le\|lt}[date]}
vaccine-code+date	token+date	vaccine product administered and vaccination (non)-administration date	GET [base]/Immunization?vaccineCode={[system]}\|[code]&date={gt\|ge\|le\|lt}[date]
_revinclude		Provenance:target	GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target

Immunization resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	identifier(s) by which this immunization is known
status	code	1..1	completed \| entered-in-error \| not-done
statusReason	CodeableConcept	0..1	reason not done
vaccineCode	CodeableConcept	1..1	vaccine product type (Binding)
patient	Reference	1..1	who was immunized (Patient)
encounter	Reference	0..1	encounter immunization was part of (Encounter)
occurrence[x]		1..1	vaccine administration date
occurrenceDateTime	dateTime
occurrenceString	string
recorded	dateTime	0..1	when the immunization was first captured in the subject's record
primarySource	boolean	0..1	indicates context the data was recorded in
reportOrigin	CodeableConcept	0..1	indicates the source of a secondarily reported record
location	Reference	0..1	where immunization occurred (Location)
manufacturer	Reference	0..1	vaccine manufacturer (Organization)
lotNumber	string	0..1	vaccine lot number
expirationDate	date	0..1	vaccine expiration date
site	CodeableConcept	0..1	body site vaccine was administered
route	CodeableConcept	0..1	body site vaccine was administered
doseQuantity	SimpleQuantity	0..1	amount of vaccine administered
performer	BackboneElement	0..*	who performed event
performer.id	string	0..1	unique ID for inter-element referencing
performer.function	CodeableConcept	0..1	what type of performance was done (Binding)
performer.actor	Reference	1..1	individual or organization who was performing (Practitioner, PractitionerRole, or Organization)
note	Annotation	0..*	additional immunization notes
reasonCode	CodeableConcept	0..*	why immunization occurred
reasonReference	Reference	0..*	why immunization occurred (Condition, Observation, or DiagnosticReport)
isSubpotent	boolean	0..1	dose potency
subpotentReason	CodeableConcept	0..*	reason for being subpotent
education	BackboneElement	0..*	educational material presented to patient
education.id	string	0..1	unique ID for inter-element referencing
education.documentType	string	0..1	educational material document identifier
education.reference	uri	0..1	educational material reference pointer
education.publicationDate	dateTime	0..1	educational material publication date
education.presentationDate	dateTime	0..1	educational material presentation date
programEligibility	CodeableConcept	0..*	patient eligibility for a vaccination program
fundingSource	CodeableConcept	0..1	funding source for the vaccine
reaction	BackboneElement	0..*	details of a reaction that follows immunization
reaction.id	string	0..1	unique ID for inter-element referencing
reaction.date	dateTime	0..1	when reaction started
reaction.detail	Reference	0..1	additional information on reaction (Observation)
reaction.reported	boolean	0..1	indicates self-reported reaction
protocolApplied	BackboneElement	0..*	protocol followed by the provider
protocolApplied.id	string	0..1	unique ID for inter-element referencing
protocolApplied.series	string	0..1	name of vaccine series
protocolApplied.authority	Reference	0..1	who is responsible for publishing the recommendations (Organization)
protocolApplied.targetDisease	CodeableConcept	0..*	vaccine preventatable disease being targetted
protocolApplied.doseNumber[x]		1..1	dose number within series
protocolApplied.doseNumberPositiveInt	positiveInt
protocolApplied.doseNumberString	string
protocolApplied.seriesDoses[x]		0..1	Recommended number of doses for immunity
protocolApplied.seriesDosesPositiveInt	positiveInt
protocolApplied.seriesDosesString	string

Immunization sample response



"resource": {
                "resourceType": "Immunization",
                "id": "406",                
                "status": "completed",
                "statusReason": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
                            "code": "IMMUNE",
                            "display": "immunity"
                        }
                    ],
                    "text": "StatusReason-immunity"
                },
                "vaccineCode": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/ndc",
                            "code": "10742-1397",
                            "display": "Oxy 10 Acne Cleanser"
                        }
                    ],
                    "text": "Oxy 10 Acne Cleanser"
                },
                "patient": {
                    "reference": "{{FhirURL}}/Patient/1111",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "DL",
                                    "display": "Driver's license number"
                                }
                            ],
                            "text": "Driver's license number"
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "700170017001",
                        "period": {
                            "start": "2020-07-16T03:39:01-04:00",
                            "end": "2020-07-18T03:39:01-04:00"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/7001",
                            "type": "Organization"
                        }
                    },
                    "display": "Smith, James"
                },
                "occurrenceDateTime": "2021-01-04T06:02:47-05:00",
                "primarySource": true
            }

Location resource

The Location resource describes information about a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Location supported profiles

Location supported searches

Name	Type	Description	Syntax
id	token	Location resource with the given ID	GET [base]/Location/[id]
name	string	portion of the location's name or alias	GET [base]/Location?name=[name]
address	string	part of the address of the location	GET [base]/Location?address=[address]
address-city	string	city specified in an address	GET [base]/Location?address-city=[address-city]
address-state	string	state specified in an address	GET [base]/Location?address-state=[address-state]
address-postalcode	string	postal code specified in an address	GET [base]/Location?address-postalcode=[address-postalcode]
organization	reference	searches for locations that are managed by the provided organization	GET [base]/Location?organization=[reference]
partof	reference	location of which this location is a part	GET [base]/Location?partOf=[reference]
operational-status	token	searches for locations (typically bed/room) that have an operational status (for example, contaminated or housekeeping)	GET [base]/Location?operationalStatus=[token]
type	token	code for the type of location	GET [base]/Location?type=[token]
_revinclude		Provenance:target	GET [base]/Location?[parameter=value]&_revinclude=Provenance:target

Location resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	unique code or number identifying the location to its users
status	code	0..1	active \| suspended \| inactive
operationalStatus	Coding	0..1	operational status of the location (typically only for a bed/room)
name	string	0..1	name of the location as used by humans
alias	string	0..*	list of alternate names that the location is known as, or was known as, in the past
description	string	0..1	additional details about the location that could be displayed as further information to identify the location beyond its name
mode	code	0..1	instance \| kind
type	CodeableConcept	0..*	type of function performed (Binding)
telecom	ContactPoint	0..*	contact details of the location
address	Address	0..1	physical location
address.id	string	0..1	unique ID for inter-element referencing
address.use	code	0..1	home \| work \| temp \| old \| billing - purpose of this address (Binding)
address.type	code	0..1	postal \| physical \| both (Binding)
address.text	string	0..1	text representation of the address
address.line	string	0..*	street name, number, direction
address.city	string	0..1	name of city
address.district	string	0..1	district name (county)
address.state	string	0..*	sub-unit of country
address.postalCode	string	0..1	US zip Codes
address.country	string	0..1	country
address.period	Period	0..1	time period when address was/is in use
physicalType	CodeableConcept	0..1	physical form of the location
position	BackboneElement	0..1	absolute geographic location
position.id	string	0..1	unique ID for inter-element referencing
position.longitude	decimal	1..1	longitude with WGS84 datum
positionlatitude	decimal	1..1	latitude with WGS84 datum
altitude	decimal	0..1	altitude with WGS84 datum
managingOrganization	Reference	0..1	organization responsible for provisioning and upkeep (Organization)
partOf	Reference	0..1	another location this one is physically a part of
hoursOfOperation	BackboneElement	0..*	what days/times during a week is this location usually open
hoursOfOperation.id	string	0..1	unique ID for inter-element referencing
hoursOfOperation.daysOfWeek	code	0..*	mon \| tue \| wed \| thu \| fri \| sat \| sun (Binding)
hoursOfOperation.allDay	boolean	0..1	is the location is open all day
hoursOfOperation.openingTime	time	0..1	time that the Location opens
hoursOfOperation.closingTime	time	0..1	time that the Location closes
availabilityExceptions	string	0..1	description of availability exceptions
endpoint	Reference	0..*	technical endpoints providing access to services operated for the location

Location sample response




"resource": {
                "resourceType": "Location",
                "id": "1201",
                
                "identifier": [
                    {
                        "system": "http://mockehr/CodeSystem/identifier"
                    }
                ],
                "status": "active",
                "operationalStatus": {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0116",
                    "code": "K",
                    "display": "Contaminated"
                },
                "name": "Smith Clinic",
                "alias": [
                    "North Clinic"
                ],
                "type": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                "code": "BMTU",
                                "display": "Bone marrow transplant unit"
                            }
                        ],
                        
                    }
                ],
                
                
                "partOf": {
                    "reference": "{{FhirURL}}/Location/10",
                    "type": "Location"
                },
                
            }

Medication resource

The Medication resource describes the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Medication supported profiles

Medication supported searches

Name	Type	Description	Syntax
id	token	Medication resource with the given ID	GET [base]/Medication/[id]
lot-number	string	medications in a batch with this lot number	GET [base]/Medication?lotnumber=[lotnumber]
code	token	medications for a specific code	GET [base]/Medication?code={[system]}\|[code]
ingredient	reference	medications for this ingredient reference	GET [base]/Medication?ingredient=[reference]
status	token	medications for this status	GET [base]/Medication?status={[system]}\|[code]
manufacturer	reference	medications made or sold for this manufacturer	GET [base]/Medication?manufacturer=[reference]
ingredient-code	token	medications for this ingredient code	GET [base]/Medication?ingredient-code={[system]}\|[code]
expiration-date	date	medications in a batch with this expiration date	GET [base]/Medication?expiration-date={gt\|ge\|le\|lt}[date]

Medication resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	business identifier for this medication
code	CodeableConcept	1..1	codes that identify this medication
status	code	0..1	active \| inactive \| entered-in-error (Binding)
manufacturer	Reference	0..1	manufacturer of the item (Organization)
form	CodeableConcept	0..1	powder \| tablets \| capsule
amount	Ratio	0..1	amount of drug in package
ingredient	BackboneElement	0..*	active or inactive ingredient
ingredient.id	string	0..1	unique ID for inter-element referencing
ingredient.item[x]		1..1	actual ingredient or content
ingredient.itemCodeableConcept	CodeableConcept
ingredient.itemReference	Reference		(Substance or Medication)
ingredient.isActive	boolean	0..1	active ingredient indicator
ingredient.strength	Ratio	0..1	quantity of ingredient present
batch	BackboneElement	0..1	details about packaged medications
batch.id	string	0..1	unique ID for inter-element referencing
batch.lotNumber	string	0..1	identifier assigned to batch
batch.expirationDate	dateTime	0..1	when batch will expire

Medication sample response



"resource": {
                "resourceType": "Medication",
                "id": "910",
                
                "identifier": [
                    {
                        "use": "official",
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "1"
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                            "code": "89904",
                            "display": "calcium chloride, dihydration 0.2 MG/ML / potassium chloride 0.3 MG/ML / sodium chloride 6 MG/ML / sodium lactate 3.1 MG/ML Irrigation Solution"
                        }
                    ]
                },
                "status": "active",
                "manufacturer": {
                    "reference": "{{FhirURL}}/Organization/03",
                    "type": "Organization"
                },
                "form": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "48582000",
                            "display": "Caplet"
                        }
                    ]
                },
                "amount": {
                    "numerator": {
                        "value": -1.0,
                        "comparator": "<",
                        "unit": "5"
                    },
                    "denominator": {
                        "value": 2.0,
                        "comparator": ">=",
                        "unit": "8"
                    }
                },
                "ingredient": [
                    {
                        "itemCodeableConcept": {
                            "coding": [
                                {
                                    "system": "TWINTERNALSYSTEM",
                                    "code": "2125008",
                                    "display": "Betazole"
                                }
                            ],
                            "text": "Betazole"
                        },
                        "isActive": true,
                        "strength": {
                            "numerator": {
                                "value": 1.0,
                                "comparator": "<"
                            },
                            "denominator": {
                                "value": 4.0,
                                "comparator": "<="
                            }
                        }
                    }
                ],
                "batch": {
                    "lotNumber": "45",
                    "expirationDate": "2021"
                }
            }

MedicationDispense resource

The MedicationDispense resource indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

MedicationDispense supported profiles

US Core 6.1.0 MedicationDispense profile

MedicationDispense supported searches

Name	Type	Description	Syntax
id	token	MedicationDispense resource with the given ID	GET [base]/MedicationDispense/[id]
patient	reference	MedicationDispense resources for a patient	GET [base]/MedicationDispense?patient=[patient]
patient+status	reference+token	MedicationDispense resources for a patient and status	GET [base]/MedicationDispense?patient={Type/}[id]&status={system\|}[code]{,{system\|}[code],...}
patient+status+type	reference+token+token	MedicationDispense resources for a patient, status, and type combination	GET [base]/MedicationDispense?patient={Type/}[id]&status={system\|}[code]{,{system\|}[code],...}&type={system\|}[code]{,{system\|}[code],...}
_revinclude		Provenance:target	GET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:target
_include		MedicationDispense:medication	GET [base]/MedicationDispense?patient=[id]&_include=MedicationDispense:medication

MedicationDispense resource contents

Name	Type	Cardinality	Description
status	code	1..1	preparation \| in-progress \| cancelled \| on-hold \| completed \| entered-in-error \| stopped \| declined \| unknown
status.statusReasonCodeableConcept	CodeableConcept
status.statusReasonReference	Reference		(DetectedIssue)
medicationCodeableConcept	CodeableConcept	1..1	Medication that was supplied
medicationReference	Reference	1..1	Medication that was supplied (Medication)
subject	Reference	1..1	Who the dispense is for (Patient)
context	Reference	0..1	Encounter / Episode associated with event (Encounter or EpisodeOfCare)
supportingInformation	Reference	0..*	Information that supports the dispensing of the medication (any)
performer	BackboneElement	0..1	Who performed event
performer.function	CodeableConcept	0..1	Who performed the dispense and what they did
performer.actor	Reference	1..1	Individual who was performing (Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson)
location	Reference	0..1	Where the dispense occurred (Location)
authorizingPrescription	Reference	0..*	Medication order that authorizes the dispense (MedicationRequest)
type	CodeableConcept	0..1	Trial fill, partial fill, emergency fill, etc.
quantity	SimpleQuantity	0..1	Ammount dispensed
daysSupply	SimpleQuantity	0..1	Amount of medication expressed as a timing amount
whenPrepared	dateTime	0..1	When product was packaged and reviewed
whenHandedOver	dateTime	0..1	When product was given out or mailed
destination	Reference	0..1	Where the medication was sent (Location)
receiver	Reference	0..*	Who collected the medication (Patient or Practitioner)
note	Annotation	0..*	Information about the dispense
dosageInstruction	Dosage	0..*	How the medication is to be used by the patient or administered by the caregiver
dosageInstruction.text	string	0..1	Free text dosage instructions e.g. SIG
dosageInstruction.timing	Timing	0..1	When medication should be administered
dosageInstruction.doseAndRate	Element	0..*	Amount of medication administered
dosageInstruction.doseAndRate.doseQuantity	Quantity	d
dosageInstruction.doseAndRate.doseRange	Range
substitution	BackboneElement	0..1	Whether a substitution was performed on the dispense
substitution.wasSubstituted	boolean	1..1	Whether a substitution was or was not performed on the dispense
substitution.type	CodeableConcept	0..*	Code signifying whether a different drug was dispensed from what was prescribed
substitution.reason	CodeableConcept	0..*	Why was substitution made
substitution.responsibleParty	Reference	0..*	Who is responsible for the substitution (Practitioner or PractitionerRole)
detectedIssue	Reference	0..*	Clinical issue with action (DetectedIssue)
eventHistory	Reference	0..*	A list of relevant lifecycle events (Provenance)

MedicationDispense sample response



"resource": {
                "resourceType": "MedicationDispense",
                "id": "1001",
                "status": "completed",
                "category": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/fhir/CodeSystem/medicationdispense-category",
                            "code": "community",
                            "display": "Community"
                        }
                    ]
                },
                "medicationCodeableConcept": {
                    "extension": [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                            "valueCode": "unknown"
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/11003",
                    "type": "Patient",
                    "display": "Smith, Jane"
                },
                "context": {
                    "reference": "{{FhirURL}}/Encounter/101",
                    "type": "Encounter",
                    "display": "Encounter 101 in Progress - Summary Display"
                },
                "performer": [
                    {
                        "function": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/medicationdispense-performer-function",
                                    "code": "checker",
                                    "display": "Checker"
                                }
                            ],
                            "text": "Checker"
                        },
                        "actor": {
                            "reference": "{{FhirURL}}/Device/08303",
                            "type": "Device"
                        }
                    }
                ],
                "location": {
                    "reference": "{{FhirURL}}/Location/102",
                    "type": "Location"
                },
                "type": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                            "code": "DF",
                            "display": "Daily Fill"
                        }
                    ]
                },
                "quantity": {
                    "value": 4.0,
                    "unit": "mm3",
                    "system": "http://unitsofmeasure.org",
                    "code": "mm3"
                },
                "daysSupply": {
                    "value": 4.0,
                    "unit": "mm3",
                    "system": "http://unitsofmeasure.org",
                    "code": "mm3"
                },
                "destination": {
                    "reference": "{{FhirURL}}/Location/101",
                    "type": "Location"
                },
                "substitution": {
                    "wasSubstituted": true,
                    "type": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution",
                                "code": "EC",
                                "display": "equivalent composition"
                            }
                        ]
                    }
                }

MedicationRequest resource

The MedicationRequest resource describes an order or request for both supply of the medication and the instructions for administration of the medication to a patient.

MedicationRequest supported profiles

MedicationRequest supported searches

Name	Type	Description	Syntax
id	token	MedicationRequest resource with the given ID	GET [base]/MedicationRequest/[id]
patient	reference	returns prescriptions for a specific patient	GET [base]/MedicationRequest?patient=[patient]
patient+intent	reference+token	returns prescriptions for a specific patient with a specific intent	GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]
patient+intent+encounter	reference+token+reference	returns prescriptions for a specific patient encounter with a specific intent	GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]&encounter=[encounter]
patient+encounter	reference+reference	returns prescriptions for a specific patient encounter	GET [base]/MedicationRequest?patient=[patient]&encounter=[encounter]
patient+intent+authoredon	reference+token+date	returns prescriptions for a specific patient with a specific intent authored on a specific date	GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]&authoredon=[authoredon]
patient+intent+status	reference+token+token	returns prescriptions for a specific patient with a specific intent and status	GET [base]/MedicationRequest?patient=[reference]&intent=order,plan&status={system\|}[code]{,{system\|}[code],...}
patient+status	reference+token	returns prescriptions for a specific patient with a specific status	GET [base]/MedicationRequest?patient=[id]&status={[system]}\|[code]
patient+authoredon	reference+date	returns prescriptions for a specific patient authored on a specific date	GET [base]/MedicationRequest?patient=[id]&authoredon={gt\|ge\|le\|lt}[date](&authoredon={gt\|ge\|le\|lt}[date]}
status	token	returns prescriptions with a specific status	GET [base]/MedicationRequest?status=[status]
intent	token	returns prescriptions with a specific intent	GET [base]/MedicationRequest?intent=[system]\|[code]
intent+status	token+token	returns prescriptions with a specific status and intent	GET [base]/MedicationRequest?intent={[system]}\|[code]&status={[system]}\|[code]
intent+authoredon	token+date	returns prescriptions with a specific intent authored on a specific date	GET [base]/MedicationRequest?intent={[system]}\|[code]&authoredon={gt\|ge\|le\|lt}[date](&authoredon={gt\|ge\|le\|lt}[date]}
encounter	reference	returns prescriptions with a specific encounter	GET [base]/MedicationRequest?encounter=[encounter]
authoredon	date	returns prescriptions authored on a specific date	GET [base]/MedicationRequest?authoredon=[authoredon]
_revinclude		Provenance:target	GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target
_include		MedicationRequest:medication	GET /MedicationRequest?[parameters]&_include=MedicationRequest:medication

MedicationRequest resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	external ID for this request
status	code	1..1	active \| on-hold \| cancelled \| completed \| entered-in-error \| stopped \| draft \| unknown (Binding)
statusReason	CodeableConcept	0..1	reason for current status
intent	code	1..1	proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option (Binding)
category:us-core	CodeableConcept	0..*	type of medication usage (Binding)
priority	code	0..1	routine \| urgent \| asap \| stat (Binding)
doNotPerform	boolean	0..1	true if request is prohibiting action
reported[x]		0..1	reported rather than primary record
reportedBoolean	boolean
reportedReference	Reference		(Practitioner, Organization, Patient, PractitionerRole, or RelatedPerson US Core profile)
medication[x]		1..1	medication to be taken
medicationCodeableConcept	CodeableConcept
medicationReference	Reference	1..1	(Medication US Core profile)
subject	Reference	1..1	who or group medication request is for (Patient US Core profile)
encounter	Reference	0..1	encounter created as part of encounter/admission/stay (Encounter US Core profile)
supportingInformation	Reference	0..*	information to support ordering of the medication (Resource)
authoredOn	dateTime	0..1	when request was initially authored
requester	Reference	0..1	who/what requested the request (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson, or Device US Core profile)
performer	Reference	0..1	intended performer of administration (Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, or CareTeam)
performerType	CodeableConcept	0..1	desired kind of performer of the medication administration
recorder	Reference	0..1	person who entered the request (Practitioner or PractitionerRole)
reasonCode	CodeableConcept	0..*	reason or indication for ordering or not ordering the medication
reasonReference	Reference	0..*	US Core Condition or Observation that supports the prescription
instantiatesCanonical	canonical	0..*	instantiates FHIR protocol or definition
instantiatesUri	uri	0..*	instantiates external protocol or definition
basedOn	Reference	0..*	what the request fulfills (CarePlan, MedicationRequest, ServiceRequest)
groupIdentifier	Identifier	0..1	composite request this is part of
courseOfTherapyType	CodeableConcept	0..1	overall pattern of medication administration
insurance	Reference	0..*	associated insurance coverage
note	Annotation	0..*	information about the prescription
dosageInstruction	Dosage	0..*	how the medication should be taken
dosageInstruction.id	string	0..1	unique ID for inter-element referencing
dosageInstruction.sequence	integer	0..1	order of the dosage instructions
dosageInstruction.text	string	0..1	free text dosage instructions e.g. SIG
dosageInstruction.additionalInstruction	CodeableConcept	0..*	supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
dosageInstruction.patientInstruction	string	0..1	patient or consumer oriented instructions
dosageInstruction.timing	Timing	0..1	when medication should be administered
dosageInstruction.asNeeded[x]		0..1	Take "as needed" (for x)
dosageInstruction.asNeededBoolean	boolean
dosageInstruction.asNeededCodeableConcept	CodeableConcept	1..1
dosageInstruction.site	CodeableConcept	0..1	body site to administer to
dosageInstruction.route	CodeableConcept	0..1	how drug should enter body
dosageInstruction.method	CodeableConcept	0..1	technique for administering medication
dosageInstruction.doseAndRate	Element	0..*	amount of medication administered
dosageInstruction.doseAndRate.id	string	0..1	unique ID for inter-element referencing
dosageInstruction.doseAndRate.type	CodeableConcept	0..1	kind of dose or rate specified
dosageInstruction.doseAndRate.dose[x]		0..1	amount of medication per dose
dosageInstruction.doseAndRate.doseQuantity	Quantity
dosageInstruction.doseAndRate.doseRange	Range
dosageInstruction.doseAndRate.rate[x]	amount of medication administered	0..1
dosageInstruction.doseAndRate.rateRatio	Ratio
dosageInstruction.doseAndRate.rateRange	Range
dosageInstruction.doseAndRate.rateQuantity	Quantity
dosageInstruction.maxDosePerPeriod	Ratio	0..1	upper limit on medication per unit of time
dosageInstruction.maxDosePerAdministration	SimpleQuantity	0..1	upper limit on medication per administration
dosageInstruction.maxDosePerLifetime	SimpleQuantity	0..1	upper limit on medication per lifetime of the patient
dispenseRequest	BackboneElement	0..1	medication supply authorization
dispenseRequest.id	string	0..1	unique ID for inter-element referencing
dispenseRequest.initialFill	BackboneElement	0..1	first fill details
dispenseRequest.initialFill.id	string	1..1	unique ID for inter-element referencing
dispenseRequest.initialFill.quantity	SimpleQuantity	0..1	first fill quantity
dispenseRequest.initialFill.duration	Duration	0..1	first fill duration
dispenseRequest.dispenseInterval	Duration	0..1	minimum period of time between dispenses
dispenseRequest.validityPeriod	Period	0..1	time period supply is authorized for
dispenseRequest.numberOfRepeatsAllowed	unsignedInt	0..1	number of refills authorized
dispenseRequest.quantity	SimpleQuantity	0..1	amount of medication to supply per dispense
dispenseRequest.expectedSupplyDuration	Duration	0..1	number of days supply per dispense
dispenseRequest.performer	Reference	0..1	intended dispenser (Organization)
substitution	BackboneElement	0..1	any restrictions on medication substitution
substitution.id	string	0..1	unique ID for inter-element referencing
substitution.allowed[x]		1..1	whether substitution is allowed or not
substitution.allowedBoolean	boolean
substitution.allowedCodeableConcept	CodeableConcept
substitution.reason	CodeableConcept	0..1	why should (not) substitution be made
priorPrescription	Reference	0..1	order/prescription that is being replaced (MedicationRequest)
detectedIssue	Reference	0..*	clinical Issue with action
eventHistory	Reference	0..*	list of events of interest in the lifecycle (Provenance)

MedicationRequest sample response


"resource": {
                "resourceType": "MedicationRequest",
                "id": "50083",                
                "identifier": [
                    {
                        "use": "usual",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "MD",
                                    "display": "Medical License number"
                                }
                            ]
                        },
                        "value": "4006-117"
                    },
                  ],
                "status": "active",
                "statusReason": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-status-reason",
                            "code": "salg",
                            "display": "Allergy - ATP"
                        },
                    ],
                    "text": "Allergy - ATP"
                },
                "intent": "filler-order",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                                "code": "discharge",
                                "display": "Discharge"
                            }
                        ],
                        "text": "Discharge"
                    },
                ],
                "priority": "routine",
                "doNotPerform": false,
                "medicationCodeableConcept": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "261000",
                            "display": "Codeine phosphate"
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/802",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "text": "Medical Record Number"
                        },
                        "system": "http://EHR/146",
                        "value": "167167167",
                        "period": {
                            "start": "2019-12-06T16:09:49+00:00",
                            "end": "2020-10-10T15:09:49+00:00"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/7001",
                            "type": "Organization"
                        }
                    },
                    "display": "Smith, James - Summary Display"
                },
                "encounter": {
                    "reference": "{{FhirURL}}/Encounter/117",
                    "type": "Encounter",
                    "display": "Encounter 2"
                },
                "authoredOn": "2020-01-23T06:28:32+00:00",
                "requester": {
                    "extension": [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                            "valueCode": "unknown"
                        }
                    ]
                },
                "performer": {
                    "reference": "{{FhirURL}}/CareTeam/3001",
                    "type": "CareTeam",
                    "display": "CarePlan"
                },
                "performerType": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "4162009",
                            "display": "Medical assistant"
                        }
                    ]
                },
                "recorder": {
                    "reference": "{{FhirURL}}/PractitionerRole/3001",
                    "type": "PractitionerRole",
                    "display": "PractitionerRole"
                },
                "reasonCode": [
                    {
                        "coding": [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "165002",
                                "display": "Accident prone"
                            }
                        ],
                        "text": "Accident-prone"
                    },
                "reasonReference": [
                    {
                        "reference": "{{FhirURL}}/Condition/6136890",
                        "type": "Condition"
                    }
                ],
                "instantiatesUri": [
                    "http://hl7.org/fhir/medicationRequesttest.html"
                ],
                "courseOfTherapyType": {
                    "coding": [
                        {
                            "system": "https://www.hl7.org/fhir/codesystem-medicationrequest-course-of-therapy.html",
                            "code": "continuous",
                            "display": "Continuous long term therapy"
                        }
                    ]
                },
                "dosageInstruction": [
                    {
                        "site": {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "2592007",
                                    "display": "All extremities"
                                }
                            ]
                        },
                        "maxDosePerPeriod": {
                            "numerator": {
                                "value": 4.0,
                                "comparator": ">",
                                "unit": "h",
                                "system": "http://unitsofmeasure.org",
                                "code": "h"
                            },
                            "denominator": {
                                "value": 2.0,
                                "comparator": "<=",
                                "unit": "h",
                                "system": "http://unitsofmeasure.org",
                                "code": "h"
                            }
                        },
                        "maxDosePerAdministration": {
                            "value": 2.0,
                            "unit": "h",
                            "system": "http://unitsofmeasure.org",
                            "code": "h"
                        }
                    }

Observation resource

The Observation resource describes measurements and simple assertions made about a patient, device, or other subject.

Observation supported profiles

US Core 3.1.1 profiles

US Core 6.1.0 profiles

Observation supported searches

Name	Type	Description	Syntax
id	token	Observation resource with the given ID	GET [base]/Observation/[id]
patient	reference	subject that the observation is about (if patient)	GET [base]/Observation?patient=[patient]
patient+date	id+date	observation subject+obtained date	GET [base]/Observation?patient=[id]&date={gt\|ge\|le\|lt}[date]{&date={gt\|ge\|le\|lt}\|[date]&...}
patient+category+date	reference/id+token+date	observation subject+observation classification+obtained date	GET [base]/Observation?patient=[patient]&category=[system]\|[code]&date=[date]
patient+category	reference/id+token	observation subject+observation classification	GET [base]/Observation?patient=[patient]&category=[system]\|[code]
patient+category+status	reference/id+token+token	observation subject+observation classification+observation status	GET [base]/Observation?patient=[patient]&category=[system]\|[code]&status=[status]
patient+code+date	reference/id+token+date	observation subject+observation type code+obtained date	GET [base]/Observation?patient=[patient]&code=[system]\|[code]&date=[date]
patient+code	reference/id+token	observation subject+observation type code	GET [base]/Observation?patient=[patient]&code=[system]\|[code]
patient+status	reference/id+token	observation subject+observation status	GET [base]/Observation?patient=[patient]&status=[system]\|[code]
status	token	observation status	GET [base]/Observation?status=[status]
category+status	token+token	observation classification+observation status	GET [base]/Observation?category=http://terminology.hl7.org/CodeSystem/observation-category\|laboratory&status={[system]}\|[code]
category	token	observation classification	GET [base]/Observation?category=[system]\|[code]
code	token	observation type code	GET [base]/Observation?code=[system]\|[code]
date	date	obtained date	GET [base]/Observation?date={gt\|ge\|le\|lt\|[date]{&date={gt\|ge\|le\|lt}[date]}
code+date	token+date	observation type code+obtained date	GET [base]/Observation?code={[system]}\|code{,{[system]}\|code}...}&date={gt\|ge\|le\|lt}[date]{&date={gt\|ge\|le\|lt}\|[date]}
_revinclude		Provenance:target	GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target

Observation resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	ID for this observation
basedOn	Reference	0..*	fulfills plan, proposal, or order
partOf	Reference	0..*	part of referenced event
status	code	1..1	registered \| preliminary \| final \| amended
category	CodeableConcept	0..*	classification of type of observation
code	CodeableConcept	1..1	type of observation (code / type)
subject	Reference	0..1	who and/or what the observation is about
focus	Reference	0..*	what the observation is about, when it is not about the subject of record
encounter	Reference	0..1	healthcare event during which this observation is made
effective[x]		0..1	clinically relevant time/time-period for observation
effectiveDateTime	dateTime
effectivePeriod	Period
effectiveTiming	Timing
effectiveInstant	instant
issued	instant	0..1	date/time this version was made available
performer	Reference	0..*	who is responsible for the observation
value[x]	0..1		actual result
valueQuantity	Quantity
valueCodeableConcept	CodeableConcept
valueString	string
valueBoolean	boolean
valueInteger	integer
valueRange	Range
valueRatio	Ratio
valueSampledData	SampledData
valueTime	time
valueDateTime	dateTime
valuePeriod	Period
dataAbsentReason	CodeableConcept	0..1	why the result is missing
interpretation	CodeableConcept	0..*	high, low, normal, etc.
note	Annotation	0..*	comments about the observation
bodySite	CodeableConcept	0..1	observed body part
method	CodeableConcept	0..1	how it was done
specimen	Reference	0..1	specimen used for this observation
device	Reference	0..1	device
referenceRange	BackboneElement	0..*	provides guide for interpretation
referenceRange.low	SimpleQuantity	0..1	low range, if relevant
referenceRange.high	SimpleQuantity	0..1	high range, if relevant
referenceRange.type	CodeableConcept	0..1	reference range qualifier
referenceRange.appliesTo	CodeableConcept	0..*	reference range population
referenceRange.age	Range	0..1	applicable age range, if relevant
referenceRange.text	string	0..1	text based reference range in an observation
hasMember	Reference	0..*	related resource that belongs to the Observation group
derivedFrom	Reference	0..*	related measurements the observation is made from
component	BackboneElement	0..*	component results
component.code	CodeableConcept	1..1	type of component observation (code/type)
component.value[x]		0..1	actual component result
component.valueQuantity	Quantity
component.valueCodeableConcept	CodeableConcept
component.valueString	string
component.valueBoolean	boolean
component.valueInteger	integer
component.valueRange	Range
component.valueRatio	Ratio
component.valueSampledData	SampledData
component.valueTime	time
component.valueDateTime	dateTime
component.valuePeriod	Period
component.dataAbsentReason	CodeableConcept	0..1	why the component result is missing
component.interpretation	CodeableConcept	0..*	high, low, normal, etc.
component.referenceRange		0..*	provides guide for interpretation of component result

Observation sample response


"resourceType": "Observation",
                "id": "1914",
                "meta": {
                    "lastUpdated": "2023-03-21T17:05:44.386+05:30",
                    "source": "{{FhirURL}}",
                    "security": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                            "code": "L",
                            "display": "low"
                        }
                    ]
                },
                
                "status": "unknown",
                "code": {
                    "extension": [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                            "valueCode": "unknown"
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/5014",
                    "type": "Patient",
                    "display": "Smith, James"
                },
                "encounter": {
                    "reference": "{{FhirURL}}/Encounter/0502",
                    "type": "Encounter",
                    "display": "Encounter Summary Display"
                }
            }

Organization resource

The Organization resource describes a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. This includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Organzation supported profiles

Organzation supported searches

Name	Type	Description	Syntax
id	token	Organization resource with the given ID	GET [base]/Organization/[id]
partof	reference	organization of which this organization forms a part	GET [base]/Organization?partOf=[reference]
name	string	portion of the organization's name or alias	GET [base]/Organization?name=[name]
address	string	server defined search that may match any of the string fields in the address, including line, city, district, state, country, postalCode, and/or text	GET [base]/Organization?address=[address]
address-state	string	state specified in an address	GET [base]/Organization?address-state=[string]
address-postalcode	string	postal code specified in an address	GET [base]/Organization?address-postalcode=[string]
address-city	string	city specified in an address	GET [base]/Organization?address-city=[string]

Organization resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	external IDs for this organization
active	boolean	0..1	whether the organization's record is still in active use
type	CodeableConcept	0..*	kind of organization
name	string	0..1	name used for the organization
alias	string	0..*	list of alternate names that the organization is known as, or was known as in the past
telecom	ContactPoint	0..*	contact detail for the organization
address	Address	0..*	address for the organization
partOf	Reference	0..1	organization of which this organization forms a part (Organization)
contact	BackboneElement	0..*	contact for the organization for a certain purpose
contact.purpose	CodeableConcept	0..1	type of contact
contact.name	HumanName	0..1	name associated with the contact
contact.telecom	ContactPoint	0..*	contact details (telephone, email, etc.) for a contact
contact.address	Address	0..1	visiting or postal addresses for the contact
endpoint	Reference	0..*	technical endpoints providing access to services operated for the organization

Organization sample response


"resourceType": "Organization",
                "id": "703",                
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "FI",
                                    "display": "facility ID"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "5000-101",
                        "period": {
                            "start": "2020-01-27T06:37:11-05:00",
                            "end": "2020-01-28T06:37:11-05:00"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/4000",
                            "type": "Organization"
                        }
                    }
                ],
                "active": true,
                "type": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                                "code": "cg",
                                "display": "Community Group"
                            }
                        ]
                    }
                ],
                "name": "City Health Group",
                
            }

Patient resource

The Patient resource contains demographics and other administrative information about an individual receiving care or other health-related services.

Patient supported profiles

Patient supported searches

Name	Type	Description	Syntax
id	token	Patient resource with the given ID	GET [base]/Patient/[id]
birthdate	date	patient’s date of birth	GET [base]/Patient?birthdate=[birthdate]
family	string	portion of the family name of the patient	GET [base]/Patient?family=[family]
gender	token	gender of the patient	GET [base]/Patient?gender=[system]\|[code]
given	string	portion of the given name of the patient	GET [base]/Patient?given=[given]
identifier	token	patient identifier	GET [base]/Patient?identifier=[system]\|[code]
name	string	server-defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, suffix, and/or text	GET [base]/Patient?name=[name]
birthdate+family	date+string	patient’s date of birth and a portion of the family name of the patient	GET [base]/Patient?birthdate=[birthdate]&family=[family]
family+gender	string+token	portion of the family name of the patient and gender of the patient	GET [base]/Patient?family=[family]&gender=[system]\|[code]
birthdate+name	date+string	patient’s date of birth and a server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, suffix, and/or text	GET [base]/Patient?birthdate=[birthdate]&name=[name]
gender+name	token+string	gender of the patient and a server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, suffix, and/or text	GET [base]/Patient?gender=[system]\|[code]&name=[name]
_revinclude		Provenance:target	GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target

Patient resource contents

Name	Type	Cardinality	Description
extension (race)	Complex	0..1	US Core race extension
extension (ethnicity)	Complex	0..1	US Core ethnicity extension
extension (tribalAffiliation)	Complex	0..*	US Core tribalAfflilation extension
extension (birthsex)	code	0..1	US Core birthsex extension (Binding)
extension (sex)	code	0..1	US Core sex extension (Binding)
extension (genderIdentity)	CodeableConcept	0..*	US Core genderIdentity extension (Binding)
identifier	Identifier	0..*	identifier for the patient
active	boolean	0..1	whether this patient’s record is in active use
name	HumanName	0..*	name associated with the patient
gender	code	0..1	male \| female \| other \| unknown
birthdate	date	1..1	date of birth for the individual
deceased.Boolean	boolean	0..1	indicates if the individual is deceased or not
deceased.DateTime	dateTime	0..1	indicates the date and time of death
address	Address	0..*	address for the individual
maritalStatus	CodeableConcept	0..1	marital (civil) status of a patient
multipleBirthBoolean	boolean	0..1	whether patient is part of a multiple birth
multipleBirthInteger	integer	0..1	number of multiple births
photo	Attachment	0..*	image of the patient
contact	BackboneElement	0..*	contact parties (guardian, partner, friend) for the patient
contact.relationship	CodeableConcept	0..*	kind of relationship
contact.name	HumanName	0..1	name associated with the contact person
contact.telecom	ContactPoint	0..*	contact detail for the person
contact.address	Address	0..1	address for the contact person
contact.gender	code	0..1	male \| female \| other \| unknown
contact.organization	Reference	0..1	organization that is associated with the contact (Organization)
contact.period	Period	0..1	period during which this contact person or organization is valid to be contacted relating to this patient
communication.language	CodeableConcept	1..1	language which can be used to communicate with the patient about his or her health
communication.preferred	boolean	0..1	language preference indicator
generalPractitioner	Reference	0..*	patient's nominated primary care provider (Organization, Practitioner, or PractitionerRole)
managingOrganization	Reference	0..1	organization that is the custodian of the patient record (Organization)
link	BackboneElement	0..*	link to another patient resource that concerns the same actual person
link.other	Reference	1..1	other patient or related person resource that the link refers to (Patient, RelatedPerson)
link.type	code	1..1	replaced-by \| replaces \| refer \| seealso

Patient sample response



"resourceType": "Patient",
                "id": "2551",
                "meta": {
                    "lastUpdated": "2021-02-16T16:52:36.846+05:30",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
                    ],
                    "security": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                            "code": "L",
                            "display": "low"
                        }
                    ]
                },
                
                "extension": [
                    {
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                        "valueCode": "M"
                    },
                    {
                        "extension": [
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2135-2",
                                    "display": "Hispanic or Latino"
                                }
                            },
                            {
                                "url": "text",
                                "valueString": "2"
                            }
                        ],
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
                    },
                    {
                        "extension": [
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2028-9",
                                    "display": "Asian"
                                }
                            },
                            {
                                "url": "detailed",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "1735-0",
                                    "display": "Alaska Native"
                                }
                            },
                            {
                                "url": "text",
                                "valueString": "1"
                            }
                        ],
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
                    }
                ],
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "text": "Social Security number"
                        },
                        "system": "http://hl7.org/fhir/sid/us-ssn",
                        "value": "764-20-8055",
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/03",
                            "type": "Organization"
                        }
                    }
                ],
                "active": true,
                "name": [
                    {
                        "family": "patientresource",
                        "given": [
                            "Smith, James"
                        ]
                    }
                ],
                "gender": "male",
                "birthDate": "1990-12-27",
                "maritalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
                            "code": "S",
                            "display": "Never Married"
                        }
                    ]

Practitioner resource

The Practitioner resource describes a person who is directly or indirectly involved in the provisioning of healthcare.

Practitioner supported profiles

Practitioner supported searches

Name	Type	Description	Syntax
id	token	Practitioner resource with the given ID	GET [base]/Practitioner/[id]
name	string	server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text	GET [base]/Practitioner?name=[string]
identifer	identifer	practitioner's identifier	GET [base]/Practitioner?identifier=[system]\|[code]
address	string	server defined search that may match any of the string fields in the address, including line, city, district, state, country, postalCode, and/or text	GET [base]/Practitioner?address=[string]
address-state	string	state specified in an address	GET [base]/Practitioner?address-state=[string]
address-postalcode	string	postal code specified in an address	GET [base]/Practitioner?address-postalcode=[string]
address-city	string	city specified in an address	GET [base]/Practitioner?address-city=[string]
_revinclude		Provenance:target	GET [base]/Practitioner?[parameter=value]&_revinclude=Provenance:target

Practitioner resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	identifier for the person as this agent
active	boolean	0..1	whether this practitioner's record is in active use
name	HumanName	0..*	name(s) associated with the practitioner
telecom	ContactPoint	0..*	contact detail for the practitioner (that apply to all roles)
address	Address	0..*	address(es) of the practitioner that are not role specific (typically home address)
gender	code	0..1	male \| female \| other \| unknown (Binding)
birthDate	date	0..1	date on which the practitioner was born
photo	Attachment	0..*	image of the person
qualification	BackboneElement	0..*	certification, licenses, or training pertaining to the provision of care
qualification.identifier	Identifier	0..*	identifier for this qualification for the practitioner
qualification.code	CodeableConcept	1..1	coded representation of the qualification
qualification.period	Period	0..1	period during which the qualification is valid
qualification.issuer	Reference	0..1	organization that regulates and issues the qualification (Organization)
communication	CodeableConcept	0..*	language the practitioner can use in patient communication

Practitioner sample response


"resourceType": "Practitioner",
                "id": "1111",
                "meta": {
                    "versionId": "1.0",
                    "lastUpdated": "2022-11-07T07:49:44.379+00:00",
                    "source": "{{FhirURL}}",
                    "profile": [
                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
                    ],
                    "security": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                            "code": "L",
                            "display": "low"
                        }
                    ],
                    "tag": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/common-tags",
                            "code": "actionable",
                            "display": "Actionable"
                        }
                    ]
                },
                
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "DL",
                                    "display": "Driver's license number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "5000-101",
                        "period": {
                            "start": "2021-01-27T05:02:15+00:00",
                            "end": "2021-01-28T05:02:15+00:00"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/02",
                            "type": "Organization"
                        }
                    }
                ],
                "active": true,
                "name": [
                    {
                        "use": "anonymous",
                        "family": "Jones",
                        "given": [
                            "jeff"
                        ],
                        "prefix": [
                            "Mr"
                        ],
                        "period": {
                            "start": "2021-06-01T05:01:20+00:00",
                            "end": "2021-06-10T05:01:20+00:00"
                        }
                    }
                ],
                "telecom": [
                    {
                        "system": "email",
                        "value": "test",
                        "use": "home",
                        "rank": 1,
                        "period": {
                            "start": "2022-11-07T07:45:09+00:00",
                            "end": "2023-06-21T07:45:09+00:00"
                        }
                    }
                ],
                "address": [
                    {
                        "use": "billing",
                        "type": "postal",
                        "text": "text1",
                        "city": "pune",
                        "state": "US-state1",
                        "postalCode": "89-4567",
                        "country": "IL"
                    }
                ],
                "gender": "female",
                "birthDate": "2022-04-13",
                "photo": [
                    {
                        "contentType": "image/png",
                        "language": "en",
                        "data": ...
                        "size": 111891,
                        "hash": "LVTKVAQ5GqbVGnzq0jMjLuO+d+s="
                    }
                ],
                "qualification": [
                    {
                        "identifier": [
                            {
                                "use": "official",
                                "system": "http://mockehr/CodeSystem/identifier"
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0360|2.7",
                                    "code": "AAS",
                                    "display": "Associate of Applied Science"
                                }
                            ]
                        },
                        "period": {
                            "start": "2022-11-07T07:48:49+00:00",
                            "end": "2023-05-25T07:48:49+00:00"
                        },
                        "issuer": {
                            "reference": "{{FhirURL}}/Organization/1003",
                            "type": "Organization",
                            "identifier": {
                                "use": "official",
                                "type": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                            "code": "NPI",
                                            "display": "National provider identifier"
                                        }
                                    ]
                                },
                                "system": "http://mockehr/CodeSystem/identifier",
                                "value": "123123",                                
                                }
                           "display": "Smith, Judith"
                        }
                    }
                ],
                "communication": [
                    {
                        "coding": [
                            {
                                "system": "urn:ietf:bcp:47",
                                "code": "en",
                                "display": "English"
                            }
                        ]
                    }

PractitionerRole resource

The PractitionerRole resource describes the location and types of services that practitioners are able to provide for an organization.

PractitionerRole supported profiles

PractitionerRole supported searches

Name	Type	Description	Syntax
id	token	PractitionerRole resource with the given ID	GET [base]/PractitionerRole/[id]
specialty	token	practitioner has this specialty at an organization	GET [base]/PractitionerRole?specialty=[token]
practitioner	reference	practitioner that is able to provide the defined services for the organization	GET [base]/PractitionerRole?practitioner=[reference]
service	reference	list of healthcare services that this worker provides for this role's organization/location(s)	GET [base]/PractitionerRole?service=[reference]
location	reference	one of the locations at which this practitioner provides care	GET [base]/PractitionerRole?location=[reference]
_revinclude		Provenance:target	GET [base]/PractitionerRole?[parameter=value]&_revinclude=Provenance:target
_include		PractitionerRole:practitioner	GET /PractitionerRole?[parameters]&_include=PractitionerRole:practitioner
_include		PractitionerRole:endpoint	GET /PractitionerRole?[parameters]&_include=PractitionerRole:endpoint

PractitionerRole resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	business identifiers that are specific to a role/location
active	boolean	0..1	whether this practitioner role record is in active use
period	Period	0..1	period during which the practitioner is authorized to perform in these role(s)
practitioner	Reference	0..1	practitioner that is able to provide the defined services for the organization (Practitioner)
organization	Reference	0..1	organization where the roles are available
code	CodeableConcept	0..*	roles which this practitioner may perform
specialty	CodeableConcept	0..*	specific specialty of the practitioner
location	Reference	0..*	location(s) at which this practitioner provides care (Location)
healthcareService	Reference	0..*	list of healthcare services that this worker provides for this role's organization/location(s) (HealtcareService)
telecom	ContactPoint	0..*	contact details that are specific to the role/location/service
availableTime	BackboneElement	0..*	times the Service Site is available
availableTime.daysOfWeek	code	0..*	mon \| tue \| wed \| thu \| fri \| sat \| sun
availableTime.allDay	boolean	0..1	always available? (24 hour service)
availableTime.availableStartTime	time	0..1	opening time of day (ignored if allDay = true)
availableTime.availableEndTime	time	0..1	closing time of day (ignored if allDay = true)
notAvailable	BackboneElement	0..*	not available during this time due to provided reason
notAvailable.description	string	1..1	reason presented to the user explaining why time not available
notAvailable.during	Period	0..1	service not available from this date
availabilityExceptions	string	0..1	description of availability exceptions
endpoint	Reference	0..*	technical endpoints providing access to services operated for the practitioner with this role

PractitionerRole sample response


resourceType": "PractitionerRole",
                "id": "112",                
                "period": {
                    "start": "2021-01-01",
                    "end": "2021-12-31"
                },
                "practitioner": {
                    "reference": "{{FhirURL}}/Practitioner/116",
                    "type": "Practitioner",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "NPI",
                                    "display": "National provider identifier"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "123"
                    }
                },
                "organization": {
                    "reference": "{{FhirURL}}/Organization/100",
                    "type": "Organization",
                    "identifier": {
                        "use": "official",
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "123"
                    },
                    "display": "sum display"
                },
                "location": [
                    {
                        "reference": "{{FhirURL}}/Location/113",
                        "type": "Location",
                        "display": "Clinic 4"
                    }
                ],
                "telecom": [
                    {
                        "extension": [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                "valueCode": "unknown"
                            }
                        ]
                    }
                ],
                "availableTime": [
                    {
                        "availableStartTime": "10:35:35",
                        "availableEndTime": "11:34:15"
                    }
                ],
                "notAvailable": [
                    {
                        "description": "Holiday",
                        "during": {
                            "start": "2020-03-05",
                            "end": "2030-03-06"
                        }
                    }
                ],
                "availabilityExceptions": "Exception - 01",
                "endpoint": [
                    {
                        "reference": "{{FhirURL}}/Endpoint/501",
                        "type": "Endpoint",
                        "display": "EndPoint - Summary"
                    }
                ]
            }

Procedure resource

The Procedure resource describes the details of current and historical procedures performed on or for a patient.

Procedure supported profiles

Procedure supported searches

Name	Type	Description	Syntax
id	token	Procedure resource with the given ID	GET [base]/Procedure/[id]
patient	reference	search by subject/patient	GET [base]/Procedure?patient=[patient]
patient+date	reference+date	subject and date when the procedure was performed	GET [base]/Procedure?patient=[patient]&date=[date]
patient+status	reference+token	subject and procedure status (preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, or unknown)	GET [base]/Procedure?patient=[patient]&status=[status]
patient+code+date	reference+token+date	subject and procedure code and performed date	GET [base]/Procedure?patient=[patient]&code=[system]\|[code]&date=[date]
patient+code	reference+token	subject and procedure code	GET [base]/Procedure?patient=[patient]&code=[system]\|[code]
status	token	procedure status (preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, or unknown)	GET [base]/Procedure?status=[status]
date	date	date when the procedure was performed	GET [base]/Procedure?date=[date]
code	token	procedure code	GET [base]/Procedure?code=[system]\|[code]
code+date	token+date	procedure code and date when performed	GET [base]/Procedure?code=[system]\|[code]&date
_revinclude		Provenance:target	GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target
_include		Procedure:subject	GET /Procedure?[parameters]&_include=Procedure:subject
_include		Procedure:encounter	GET /Procedure?[parameters]&_include=Procedure:encounter

Procedure resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	External Identifiers for this procedure
instantiatesCanonical	canonical	0..*	instantiates FHIR protocol or definition
instantiatesUri	uri	0..*	instantiates external protocol or definition
basedOn	Reference	0..*	request for this procedure (CarePlan, ServiceRequest)
partOf	Reference	0..*	Part of referenced event (Procedure, Observation, MedicationAdministration)
status	code	1..1	preparation \| in-progress \| not-done \| on-hold \| stopped \| completed \| entered-in-error \| unknown
statusReason	CodeableConcept	0..1	reason for current status
category	CodeableConcept	0..1	classification of the procedure
code	CodeableConcept	0..1	identification of the procedure
subject	Reference	1..1	who the procedure was performed on (Patient, Group)
encounter	Reference	0..1	encounter created as part of (Encounter)
performed[x]		0..1	when the procedure was performed
performedDateTime	dateTime
performedPeriod	Period
performedString	string
performedAge	Age
performedRange	Range
recorder	Reference	0..1	who recorded the procedure (Patient, RelatedPerson, Practitioner, PractitionerRole)
asserter	Reference	0..1	person who asserts this procedure (Patient, RelatedPerson, Practitioner, PractitionerRole)
performer	BackboneElement	0..*	people who performed the procedure
performer.function	CodeableConcept	0..1	type of performance
performer.actor	Reference	1..1	reference to the practitioner (Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
performer.onBehalfOf	Reference	0..1	organization the device or practitioner was acting for (Organization)
location	Reference	0..1	where the procedure happened (Location)
reasonCode	CodeableConcept	0..*	coded reason procedure performed
reasonReference	Reference	0..*	justification that the procedure was performed (Condition, Observation, Procedure, DiagnosticReport, DocumentReference)
bodySite	CodeableConcept	0..*	target body sites
outcome	CodeableConcept	0..1	result of the procedure
report	Reference	0..*	report resulting from the procedure (DiagnosticReport, DocumentReference)
complication	CodeableConcept	0..*	complication following the procedure
complicationDetail	Reference	0..*	condition that is a result of the procedure (Condition)
followUp	CodeableConcept	0..*	instructions for follow up
note	Annotation	0..*	additional information about the procedure
focalDevice	BackboneElement	0..*	manipulated, implanted, or removed device
focalDevice.action	CodeableConcept	0..1	kind of change to device
focalDevice.manipulated	Reference	1..1	device that was changed (Device)
usedReference	Reference	0..*	items used during procedure (Device, Medication)
usedCode	CodeableConcept	0..*	Coded items used during the procedure

Procedure sample response


"resourceType": "Procedure",
                "id": "5902",
                "status": "preparation",
                "code": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "113091000",
                            "display": "Magnetic resonance imaging"
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/12007",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "MR",
                                    "display": "Medical record number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "8001",
                        "period": {
                            "start": "2020-09-03T08:27:45+05:30",
                            "end": "2020-09-04T08:27:45+05:30"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/7001",
                            "type": "Organization"
                        }
                    },
                    "display": "Smith, James"
                },
                "performedDateTime": "2018-06-20T17:46:28+05:30"
            }

Questionnaire resource

The Questionnaire resource is used to describe a structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

Questionnaire supported profile

SDC 3.0.0 Base Questionnaire

Questionnaire supported searches

Name	Type	Description
id	token	Questionnaire resource with the given ID
_id	token	Questionnaire resource with the given ID
patient.identifier	token	patient identifier

Questionnaire resource contents

Name	Type	Cardinality	Description
extension (designNote)	markdown	0..1	SDC Design Note extension
extension (preferredTerminologyServer)			SDC Preferred Terminology Server extension
extension (performerType)			SDC Performer Type extension
extension (assemble-expectation)			SDC Assembly Expectations for Questionnaire extension
url	uri	0..1	aanonical identifier for this questionnaire, represented as a URI (globally unique)
identifier	Identifier	0..*	additional identifier for the questionnaire
version	string	0..1	business version of the questionnaire; the identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance
name	string	0..1	name for this questionnaire (computer friendly); natural language name identifying the questionnaire
title	string	0..1	name for this questionnaire (human friendly); natural language name identifying the questionnaire
derivedFrom	canonical	0..*	URL of a questionnaire that this questionnaire is based on; allows a questionnaire to be created based on another questionnaire
status	code	1..1	status of this questionnaire; enables tracking the life-cycle of the content. draft \| active \| retired \| unknown
experimental	boolean	0..1	for testing purposes, not real usage; boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage
subjectType	code	0..*	resource that can be subject of QuestionnaireResponse; types of subjects that can be the subject of responses created for the questionnaire
date	dateTime	0..1	date last changed; date (and optionally time) when the questionnaire was published
publisher	string	0..1	name of the publisher (organization or individual)
contact	ContactDetail	0..*	contact details for the publisher; contact details to assist a user in finding and communicating with the publisher
description	markdown	0..1	free text natural language description of the questionnaire from a consumer's perspective
useContext	UsageContext	0..*	context that the content is intended to support
jurisdiction	CodeableConcept	0..*	intended jurisdiction for questionnaire (if applicable); legal or geographic region in which the questionnaire is intended to be used
purpose	markdown	0..1	why this questionnaire is defined; explanation of why this questionnaire is needed and why it has been designed as it has
copyright	markdown	0..1	copyright statement relating to the questionnaire and/or its contents; copyright statements are generally legal restrictions on the use and publishing of the questionnaire
approvalDate	date	0..1	date on which the questionnaire was approved by the publisher; approval happens once when the content is officially approved for usage
lastReviewDate	date	0..1	date on which the questionnaire was last reviewed; review happens periodically after approval but does not change the original approval date
effectivePeriod	Period	0..1	when the questionnaire is expected to be used; the period during which the questionnaire content was or is planned to be in active use
code	Coding	0..*	concept that represents the overall questionnaire; an identifier for this question or group of questions in a particular terminology such as LOINC
item	BackboneElement	0..*	questions and sections within the questionnaire
item.designNote	markdown	0..1	design comments
item.sdc-questionnaire-preferredTerminologyServer	url	0..*	preferred terminology server
item.linkId	string	1..1	unique ID for item in questionnaire
item.definition	uri	0..1	ElementDefinition - details for the item
item.code	Coding	0..*	corresponding concept for this item in a terminology
item.prefix	string	0..1
item.text	string	0..1	primary text for the item
item.type	code	1..1	group \| display \| boolean \| decimal \| integer \| date \| dateTime
item.enableWhen	BackboneElement	0..*	only allow data when
item.enableWhen.id	string	0..1	unique ID for inter-element referencing
item.enableWhen.question	string	1..1	question that determines whether item is enabled
item.enableWhen.operator	code	1..1	exists \| = \| != \| > \| < \| >= \| <=
item.enableWhen.answer[x]		1..1	value for question comparison based on operator
item.enableWhen.answerBoolean	boolean
item.enableWhen.answerDecimal	decimal
item.enableWhen.answerInteger	integer
item.enableWhen.answerDate	date
item.enableWhen.answerDateTime	dateTime
item.enableWhen.answerTime	time
item.enableWhen.answerString	string
item.enableWhen.answerCoding	Coding
item.enableWhen.answerQuantity	Quantity
item.enableWhen.answerReference	Reference
item.enableBehavior	code	0..1	all \| any
item.required	boolean	0..1	whether the item must be included in data results
item.repeats	boolean	0..1	whether the item may repeat
item.readOnly	boolean	0..1	don't allow human editing
item.maxLength	integer	0..1	no more than this many characters
item.answerValueSet	canonical	0..1	value set containing permitted answers
item.answerOption	BackboneElement	0..*	permitted answer
item.answerOption.id	string	0..1	unique ID for inter-element referencing
item.answerOption.value[x]		1..1	answer value
item.answerOption.valueBoolean	boolean
item.answerOption.valueDecimal	decimal
item.answerOption.valueInteger	integer
item.answerOption.valueDate	date
item.answerOption.valueTime	time
item.answerOption.valueString	string
item.answerOption.valueCoding	Coding
item.answerOption.valueReference	Reference
item.answerOption.initialSelected	boolean	0..1	whether option is selected by default
item.initial	BackboneElement	0..*	initial value(s) when item is first rendered
item.initial.id	string	0..1	unique ID for inter-element referencing
item.initial.value[x]		1..1	actual value for initializing the question
item.initial.valueBoolean	boolean
item.initial.valueDecimal	decimal
item.initial.valueInteger	integer
item.initial.valueDate	date
item.initial.valueDateTime	dateTime
item.initial.valueTime	time
item.initial.valueString	string
item.initial.valueUri	uri
item.initial.valueAttachment	Attachment
item.initial.valueCoding	Coding
item.initial.valueQuantity	Quantity
item.initial.valueReference	Reference
item.item			nested questionnaire items

Questionnaire sample response




"resource": {
                "resourceType": "Questionnaire",
                "id": "Q4000",                
                "url": "https://hl7.org/fhir/R4/questionnaire.html",
                "status": "active",
                "contact": [
                    {
                        "name": "Contact1",
                        "telecom": [
                            {
                                "system": "email",
                                "value": "Value Element1",
                                "use": "mobile",
                                "rank": 1,
                                "period": {
                                    "start": "2024-03-14T01:50:50-04:00",
                                    "end": "2026-03-14T01:50:50-04:00"
                                }
                            }
                        ]
                    }
                ],
                "jurisdiction": [

                    {
                        "coding": [
                            {
                                "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
                                "code": "001",
                                "display": "World"
                            }
                        ]
                    }
                ],
                "code": [ 
                    {
                        "system": "http://loinc.org",
                        "code": "93025-5",
                        "display": "Protocol for Responding to and Assessing Patients' Assets, Risks, and Experiences [PRAPARE]"
                    },
                ],
                "item": [
                    {
                        "enableWhen": [
                            {
                                "question": "QueDate2",
                                "operator": "=",
                                "answerDate": "2024-03"
                            }
                        ]
                    }
                ]
            }

QuestionnaireResponse

The QuestionnaireResponse resource is used to describe a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

QuestionnaireResponse supported profiles

QuestionnaireResponse supported searches

Name	Type	Description
id	token	QuestionnaireResponse resource with the given ID
_id	token	QuestionnaireResponse resource with the given ID
patient	reference	the patient that is the subject of the questionnaire response
questionnaire	reference	the questionnaire the answers are provided for
status	token	the status of the questionnaire response
authored	date	when the questionnaire response was last changed
patient.identifier	token	patient identifier
patient+status	reference+token	the patient that is the subject of the questionnaire response and the status of the questionnaire response
patient+authored	reference+date	the patient that is the subject of the questionnaire response and when the questionnaire response was last changed
patient+questionnaire	reference+reference	the patient that is the subject of the questionnaire response and the questionnaire the answers are provided for

QuestionnaireResponse resource contents

Name	Type	Cardinality	Description
extension (signature)	Signature	0..*	represents a wet or electronic signature for either the form overall or for the question or item it's associated with (QuestionnaireResponse Signature)
extension (completionMode)	CodeableConcept	0..1	indicates how the individual completing the QuestionnaireResponse provided their responses (QuestionnaireResponse Completion Mode)
identifier	Identifier	0..1	unique ID for this set of answers
basedOn	Reference	0..*	request fulfilled by this QuestionnaireResponse (CarePlan or ServiceRequest)
partOf	Reference	0..*	part of this action (Observation or Procedure)
questionnaire	canonical	0..1	form being answered
questionnaire.id	string	0..1	xml:id
extension (questionnaire.questionnaireDisplay)	string	0..1	display name for canonical reference
extension (questionnaire.uri)	uri	0..1	location where a non-FHIR questionnaire/survey form can be found
status	code	1..1	in-progress \| completed \| amended \| entered-in-error \| stopped
subject	Reference	1..1	subject of the questions (Patient)
encounter	Reference	0..1	encounter created as part of (Encounter)
authored	dateTime	1..1	date the answers were gathered
author	Reference	0..1	person who received and recorded the answers (Device, Practitioner, PractitionerRole, Patient, or Organization)
source	Reference	0..1	person who answered the questions (Practitioner, PractitionerRole, or Patient)
item	BackboneElement	0..*	groups and questions
item.id	string	0..1	unique ID for inter-element referencing
extension (item.itemMedia)	Attachment	0..1	media to display
extension (item.itemSignature)	Signature	0..1	a signature attesting to the content
item.linkId	string	1..1	pointer to specific item from Questionnaire
item.definition	uri	0..1	ElementDefinition - details for the item
item.text	string	0..1	name for group or question text
item.answer	BackboneElement	0..*	response(s) to the question
item.answer.id	string	0..1	unique ID for inter-element referencing
extension (item.answer.itemAnswerMedia)	Attachment	0..1	answer media to display
extension (item.answer.ordinalValue)	decimal	0..1	assigned ordinal value
item.value		0..1	single-valued answer to the question

QuestionnaireResponse sample response



"resource": {
                "resourceType": "QuestionnaireResponse",
                "id": "9393",
                "extension": [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature",
                        "valueSignature": {
                            "type": [
                                {
                                    "system": "urn:iso-astm:E1762-95:2013",
                                    "version": "V1.0",
                                    "code": "1.2.840.10065.1.12.1.1",
                                    "display": "Author's Signature",
                                    "userSelected": true
                                }
                            ],
                            "when": "2024-04-22T01:53:43.063-04:00",
                            "who": {
                                "reference": "{{FhirURL}}/Practitioner/120",
                                "type": "Practitioner",
                                "identifier": {
                                    "type": {
                                        "text": "text"
                                    },
                                    "system": "http://mockehr/Code,System/identifier",
                                    "value": "2324",
                                    "period": {
                                        "start": "2019",
                                        "end": "2021"
                                    }
                                }
                            },
                            "onBehalfOf": {
                                "reference": "{{FhirURL}}/Practitioner/120",
                                "type": "Practitioner",
                                "identifier": {
                                    "type": {
                                        "text": "text"
                                    },
                                    "system": "http://mockehr/Code,System/identifier",
                                    "value": "2324",
                                    "period": {
                                        "start": "2019",
                                        "end": "2021"
                                    }
                                }
                            },
                            "data":{{data}}
                        }
                    }
                ],
                "questionnaire": "http://hl7.org/fhir/us/sdoh-clinicalcare/Questionnaire/SDOHCC-QuestionnaireHungerVitalSign",
                "status": "amended",
                "subject": {
                    "reference": "{{FhirURL}}/Patient/4002",
                    "type": "Patient",
                    "identifier": {
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "400240024002"
                    },
                    "display": "Smith, Jane"
                },
                "authored": "2024-05-09T08:27:22-04:00",
                "source": {
                    "reference": "{{FhirURL}}/Patient/1441",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "text": "Social Security number"
                        },
                        "system": "http://hl7.org/fhir/sid/us-ssn",
                        "value": "764-20-9166"
                    },
                    "display": "Condition-TW-AA, MinVerStatus"
                },
                "item": [
                    {
                        "linkId": "2323",
                        "definition": "http://hl7.org/fhir/R4/questionnaireresponse.html",
                        "text": "test",
                        "item": [
                            {
                                "linkId": "1515",
                                "definition": "http://hl7.org/fhir/R4/questionnaireresponse.html",
                                "text": "text2",
                                "item": [
                                    {
                                        "linkId": "1818",
                                        "definition": "http://hl7.org/fhir/R4/questionnaireresponse.html",
                                        "text": "text3"
                                    }
                                ]
                            }
                        ]
                    }

RelatedPerson resource

The RelatedPerson resource describes a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

RelatedPerson supported profile

US Core version 6.1.0 RelatedPerson profile

RelatedPerson supported searches

Name	Type	Description	Syntax
id	token	RelatedPerson resource with the given ID	GET [base]/RelatedPerson/[id]
patient	reference	patient this person is related to	GET [base]/RelatedPerson?patient=[id]
patient+name	reference+HumanName	patient this person is related to and name associated with the person	GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]
_revinclude		Provenance:target	GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:target
_include		RelatedPerson:patient	GET [base]/RelatedPerson?[parameters]&_include=RelatedPerson:patient

RelatedPerson resource contents

Name	Type	Cardinality	Description
identifier	Identifier	0..*	human identifier for this person
active	boolean	1..1	whether this related person's record is in active use
patient	Reference	1..1	patient this person is related to (Patient)
relationship	CodeableConcept	0..*	nature of the relationship
name	HumanName	0..1	name associated with the person
telecom	ContactPoint	0..*	contact detail for the person
gender	code	0..1	male \| female \| other \| unknown
birthDate	date	0..1	date on which the related person was born
address	Address	0..*	address where the related person can be contacted or visited
photo	Attachment	0..*	image of the person
period	Period	0..1	period of time that this relationship is considered valid
communication	BackboneElement	0..*	language which may be used to communicate with about the patient's health
communication.language	CodeableConcept	1..1	language which can be used to communicate with the patient about his or her health
communication.preferred	boolean	0..1	language preference indicator

RelatedPerson sample response


"resourceType": "RelatedPerson",
                "id": "111",                
                "identifier": [
                    {
                        "use": "official",
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "123",
                        "period": {
                            "start": "2021-06-09T09:06:07+00:00",
                            "end": "2021-06-30T09:06:07+00:00"
                        }
                    }
                ],
                "active": true,
                "patient": {
                    "reference": "{{FhirURL}}/Patient/P0001",
                    "type": "Patient",
                    "identifier": {
                        "use": "secondary",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "version": "V",
                                    "code": "PPN",
                                    "display": "Passport number",
                                    "userSelected": true
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "V001",
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/04",
                            "type": "Organization"
                        }
                    },
                    "display": "James Smith"
                },
                "relationship": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                "code": "CHLDADOPT",
                                "display": "adopted child"
                            }
                        ]
                    }
                ],
                "name": [
                    {
                        "use": "usual",
                        "text": "son",
                        "family": "Smith"
                        
                    }
                ],
                "telecom": [
                    {
                        "system": "email",
                        "use": "home"
                    }
                ],
                "gender": "male",
                "birthDate": "2019-11-17",
                "address": [
                    {
                        "use": "billing",
                        "type": "postal"
                    }
                ],
                "period": {
                    "start": "2019-11-17T05:26:25+00:00",
                    "end": "2022-02-17T05:26:41+00:00"
                },                
            }

ServiceRequest

The ServiceRequest resource is used to describe a record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

ServiceRequest supported profile

US Core version 6.1.0 ServiceRequest profile

ServiceRequest supported searches

Name	Type	Description
id	token	ServiceRequest resource with the given ID
_id	token	ServiceRequest resource with the given ID
patient	reference	patient ID
patient+ category	reference+token	patient ID and classification of service
patient+ code	reference+token	patient ID and code indicating what is being requested/ordered
patient+ category+ authored	reference+token+date	patient ID and classification of service and date request signed
patient+ status	reference+token	patient ID and status (draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown)
patient+ code+ authored	reference+token+date	patient ID and code indicating what is being requested/ordered and date request signed
Provenance:target	_revinclude
	_include

ServiceRequest resource contents

Name	Type	Cardinality	Description
instantiatesCanonical	canonical	0..*	instantiates FHIR protocol or definition
instantiatesUri	uri	0..*	instantiates external protocol or definition
basedOn	Reference	0..*	what request fulfills (CarePlan \| ServiceRequest \| MedicationRequest)
replaces	Reference	0..*	what the request replaces (ServiceRequest)
requisition	Identifier	0..1	a shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier
status	code	1..1	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown
intent	code	1..1	proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option
category	CodeableConcept	0..*	whether the request is a proposal, plan, an original order, or a reflex order (value set)
priority	code	0..1	routine \| urgent \| asap \| stat
doNotPerform	boolean	0..1	true when the service/procedure should not be performed
code	CodeableConcept	1..1	what is being requested/ordered (Binding: US Core Procedure Codes)
orderDetail	CodeableConcept	0..*	additional order information
quantity		0..1	service amount
quantityQuantity	Quantity
quantityRatio	Ratio
quantityRange	Range
subject	Reference	1..1	individual or entity the service is ordered for (US Core Patient, Group, Location, Device)
encounter	Reference	0..1	encounter in which the request was created (ServiceRequest)
occurrence		0..1	date/time at which the requested service should occur
occurrencePeriod	Period
occurrenceDateTime	dateTime
occurrenceTiming	Timing
asNeeded		0..1	preconditions for service
asNeededBoolean	boolean
asNeededCodeableConcept	CodeableConcept
authoredOn	dateTime	0..1	date request signed
requester	Reference	0..1	who/what is requesting service (US Core Organization Profile \| US Core Patient Profile \| PractitionerRole \| US Core RelatedPerson Profile \| Device)
performerType	CodeableConcept	0..1	performer role
performer	Reference	0..*	requested performer (Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| Device \| RelatedPerson)
locationCode	CodeableConcept	0..*	preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center
locationReference	Reference	0..*	reference to the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center (Location)
reasonCode	CodeableConcept	0..1	explanation/justification for procedure or service (Binding: US Core Condition Codes)
reasonReference	Reference	0..1	explanation/justification for service or service (Condition \| Observation \| DiagnosticReport \| DocumentReference)
insurance	Reference	0..*	insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service
supportingInfo	Reference	0..*	additional clinical information
specimen	Reference	0..*	procedure samples
bodySite	CodeableConcept	0..*	anatomic location where the procedure should be performed
note	Annotation	0..*	notes and comments made about the service request
patientInstruction	string	0..1	patient or consumer-oriented instructions
relevantHistory	Reference	0..*	request provenance

ServiceRequest sample response




"resource": {
                "resourceType": "ServiceRequest",
                "id": "105",
                "status": "entered-in-error",
                "intent": "directive",
                "code": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "313331005",
                            "display": "Admission for social reasons"
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/4002",
                    "type": "Patient",
                    "identifier": {
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "400240024002"
                    },
                    "display": "Smith, Jane"
                }
            }

Specimen resource

The Specimen resource covers substances used for diagnostic and environmental testing. The focus of the specimen resource is the process for gathering, maintaining and processing the specimen as well as where the specimen originated. This is distinct from the use of Substance which is only used when these other aspects are not relevant.

Specimen supported profiles

US Core 6.1.0 Specimen profile

Specimen supported searches

Name	Type	Description	Syntax
id	token	Specimen resource with the given ID	GET [base]/Specimen/[id]
patient	reference	Specimen resources for a patient	GET [base]/Specimen?patient=[id]

Specimen resource contents

Name	Type	Cardinality	Description
accessionIdentifier	Identifier	0..1	Identifier assigned by the lab
status	code	0..1	available \| unavailable \| unsatisfactory \| entered-in-error (Binding)
type	CodeableConcept	1..1	Kind of material that forms the specimen (Binding)
subject	Reference	0..1	Patient where the specimen came from (Patient)
receivedTime	dateTime	0..1	The time when specimen was received for processing
parent	Reference	0..*	Specimen from which this specimen originated (Specimen)
request	Reference	0..*	Why the specimen was collected (ServiceRequest)
collection	BackboneElement	0..1	Collection details
collection.collector	Reference	0..1	Who collected the specimen (Practitioner or PractitionerRole)
collection.collectedDateTime	dateTime	0..1	Collection time
collection.collectedPeriod	Period	0..1	Collection time
collection.duration	Duration	0..1	How long it took to collect specimen
collection.quantity	SimpleQuantity	0..1	The quantity of specimen collected
collection.method	CodeableConcept	0..1	Technique used to perform collection
collection.bodySite	CodeableConcept	0..1	Anatomical collection site
collection.fastingStatusCodeableConcept	CodeableConcept	0..1	Whether or how long patient abstained from food and/or drink
collection.fastingStatusDuration	Duration	0..1	Whether or how long patient abstained from food and/or drink
processing	BackboneElement	0..*	Processing and processing step details
processing.description	string	0..1	Textual description of procedure
processing.procedure	CodeableConcept	0..1	Indicates the treatment step applied to the specimen
processing.additive	Reference	0..*	Material used in the processing step (Substance)
processing.timeDateTime	dateTime	0..1	Date and time of specimen processing
processing.timePeriod	Period	0..1	Date and time of specimen processing
container	BackboneElement	0..*	Direct container of specimen (tube/slide, etc.)
container.identifier	Identifier	0..*	Id for the container
container.description	string	0..1	Textual description of the container
container.type	CodeableConcept	0..1	Kind of container directly associated with specimen
container.capacity	SimpleQuantity	0..1	Container volume or size
container.specimenQuantity	SimpleQuantity	0..1	Quantity of specimen within container
container.additiveCodeableConcept	CodeableConcept	0..1	Additive associated with container
container.additiveReference	Reference	0..1	Additive associated with container (Substance)
condition	CodeableConcept	0..*	State of the specimen
note	Annotation	0..*	Comments

Specimen sample response



"resource": {
                "resourceType": "Specimen",
                "id": "1000",
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "DL",
                                    "display": "Driver's license number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "4006-116",
                        "period": {
                            "start": "2025-07-23T07:39:28-04:00",
                            "end": "2025-08-22T07:39:28-04:00"
                        },
                        "assigner": {
                            "reference": "{{FhirURL}}/Organization/7001",
                            "type": "Organization"
                        }
                    }
                ],
                "accessionIdentifier": {
                    "use": "official",
                    "type": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                "code": "DL",
                                "display": "Driver's license number"
                            }
                        ]
                    },
                    "system": "http://mockehr/CodeSystem/identifier",
                    "value": "4006-116",
                    "period": {
                        "start": "2025-07-23T01:27:46-04:00",
                        "end": "2025-08-22T01:27:46-04:00"
                    },
                    "assigner": {
                        "reference": "{{FhirURL}}/Organization/7001",
                        "type": "Organization"
                    }
                },
                "status": "available",
                "type": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "442166002",
                            "display": "a.m. serum specimen"
                        }
                    ]
                },
                "subject": {
                    "reference": "{{FhirURL}}/Patient/4006",
                    "type": "Patient",
                    "identifier": {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code": "TAX",
                                    "display": "Tax ID number"
                                }
                            ]
                        },
                        "system": "http://mockehr/CodeSystem/identifier",
                        "value": "T2301"
                    },
                    "display": "Smith, Jane"
                },
                "receivedTime": "2025-07-25T08:05:33-04:00",
                "parent": [
                    {
                        "reference": "{{FhirURL}}/Specimen/8000",
                        "type": "Specimen",
                        "display": "Specimen Summary Display"
                    }
                ],
                "request": [
                    {
                        "reference": "{{FhirURL}}/ServiceRequest/215",
                        "type": "ServiceRequest",
                        "display": "BasedOnServiceRequest Summary"
                    }
                ],
                "collection": {
                    "collector": {
                        "reference": "{{FhirURL}}/Practitioner/68",
                        "type": "Practitioner",
                        "display": "Terry"
                    }
                },
                "condition": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0493",
                                "code": "AUT",
                                "display": "Autolyzed"
                            }
                        ],
                        "text": "Autolyzed"
                    }
                ],
                "note": [
                    {
                        "authorReference": {
                            "reference": "{{FhirURL}}/Organization/03",
                            "type": "Organization",
                            "identifier": {
                                "use": "old",
                                "type": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                            "code": "DL",
                                            "display": "Driver's license number"
                                        }
                                    ],
                                    "text": "driver lic no"
                                },
                                "system": "http://mockehr/CodeSystem/identifier",
                                "value": "value12",
                                "assigner": {
                                    "reference": "{{FhirURL}}/Organization/1",
                                    "type": "Organization",
                                    "identifier": {
                                        "use": "official",
                                        "type": {
                                            "coding": [
                                                {
                                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                    "code": "DL",
                                                    "display": "Driver's license number"
                                                }
                                            ],
                                            "text": "Driver's license number"
                                        },
                                        "system": "http://mockehr/CodeSystem/identifier",
                                        "value": "Value123",
                                        "period": {
                                            "start": "2021-04-04T01:31:50-04:00",
                                            "end": "2021-04-08T01:31:50-04:00"
                                        },
                                        "assigner": {
                                            "reference": "https://{{FhirURL}}/Organization/03",
                                            "type": "Organization"
                                        }
                                    },
                                    "display": "Smith, Jane Summary Display"
                                }
                            },
                            "display": "sdisplay"
                        },
                        "time": "2025-07-25T08:12:33-04:00",
                        "text": "For pain, Take 1 tab every 8 hrs"
                    }
                ]