USCore

This page is part of the US Core (v3.0.1: STU3 Ballot 3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Downloads: CapabilityStatement: (XML, JSON),OpenAPI-Swagger Definition file

US Core Client CapabilityStatement

FHIR Version: 4.0.0
Supported formats: xml, json
Published: 2019-09-03
Published by: HL7 International - US Realm Steering Committee

The Section describes the expected capabilities of the US Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the Conformance Requirements for Server. US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

FHIR RESTful Capabilities

The US Core Client SHALL:

Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.

Security:

See the [General Security Considerations] section for requirements and recommendations.

Summary of System Wide Interactions

MAY support the transaction interaction.

MAY support the batch interaction.

MAY support the search-system interaction.

MAY support the history-system interaction.

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

Resource Type Supported Profiles Supported Searches Supported _includes Supported Operations

AllergyIntolerance US Core AllergyIntolerance Profile clinical-status, patient, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+clinical-status

CarePlan US Core CarePlan Profile category, date, patient, status, us-core-includeprovenance, patient+category, _id+us-core-includeprovenance, patient+category+status, patient+category+date, patient+category+status+date, patient+us-core-includeprovenance

CareTeam US Core CareTeam Profile patient, status, us-core-includeprovenance, patient+status, _id+us-core-includeprovenance, patient+us-core-includeprovenance

Condition US Core Condition Profile category, clinical-status, patient, onset-date, code, us-core-includeprovenance, patient+category, patient+onset-date, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+code, patient+clinical-status

Device US Core Implantable Device Profile patient, type, us-core-includeprovenance, _id+us-core-includeprovenance, patient+type, patient+us-core-includeprovenance

DiagnosticReport US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting status, patient, category, code, date, us-core-includeprovenance, patient+status, patient+category, patient+code+date, _id+us-core-includeprovenance, patient+category+date, patient+us-core-includeprovenance, patient+code

DocumentReference US Core DocumentReference Profile _id, status, patient, category, type, date, period, us-core-includeprovenance, patient+status, patient+category, _id+us-core-includeprovenance, patient+category+date, patient+type, patient+us-core-includeprovenance, patient+type+period $docref

Encounter US Core Encounter Profile _id, class, date, identifier, patient, status, type, us-core-includeprovenance, patient+status, _id+us-core-includeprovenance, patient+type, patient+us-core-includeprovenance, class+patient, date+patient

Goal US Core Goal Profile lifecycle-status, patient, target-date, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+target-date, patient+lifecycle-status

Immunization US Core Immunization Profile patient, status, date, us-core-includeprovenance, patient+status, patient+date, _id+us-core-includeprovenance, patient+us-core-includeprovenance

Location US Core Location Profile name, address, address-city, address-state, address-postalcode, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance

Medication US Core Medication Profile us-core-includeprovenance

MedicationRequest US Core MedicationRequest Profile status, intent, patient, encounter, authoredon, us-core-includeprovenance, patient+intent+authoredon, _id+us-core-includeprovenance, patient+intent, patient+us-core-includeprovenance, patient+intent+encounter, patient+intent+status MedicationRequest:medication

Observation US Core Smoking Status Observation Profile, US Core Pediatric Weight for Height Observation Profile, US Core Laboratory Result Observation Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pulse Oximetry Profile status, category, code, date, patient, us-core-includeprovenance, patient+category, patient+code+date, _id+us-core-includeprovenance, patient+category+status, patient+category+date, patient+us-core-includeprovenance, patient+code

Organization US Core Organization Profile name, address, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance

Patient US Core Patient Profile _id, birthdate, family, gender, given, identifier, name, us-core-includeprovenance, family+gender, birthdate+family, _id+us-core-includeprovenance, patient+us-core-includeprovenance, birthdate+name, gender+name

Practitioner US Core Practitioner Profile name, identifier, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance

PractitionerRole US Core PractitionerRole Profile specialty, practitioner, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance PractitionerRole:endpoint, PractitionerRole:practitioner

Procedure US Core Procedure Profile status, patient, date, code, us-core-includeprovenance, patient+status, patient+code+date, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+date

Resource Type	Supported Profiles	Supported Searches	Supported `_includes`	Supported Operations
AllergyIntolerance	US Core AllergyIntolerance Profile	clinical-status, patient, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+clinical-status
CarePlan	US Core CarePlan Profile	category, date, patient, status, us-core-includeprovenance, patient+category, _id+us-core-includeprovenance, patient+category+status, patient+category+date, patient+category+status+date, patient+us-core-includeprovenance
CareTeam	US Core CareTeam Profile	patient, status, us-core-includeprovenance, patient+status, _id+us-core-includeprovenance, patient+us-core-includeprovenance
Condition	US Core Condition Profile	category, clinical-status, patient, onset-date, code, us-core-includeprovenance, patient+category, patient+onset-date, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+code, patient+clinical-status
Device	US Core Implantable Device Profile	patient, type, us-core-includeprovenance, _id+us-core-includeprovenance, patient+type, patient+us-core-includeprovenance
DiagnosticReport	US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting	status, patient, category, code, date, us-core-includeprovenance, patient+status, patient+category, patient+code+date, _id+us-core-includeprovenance, patient+category+date, patient+us-core-includeprovenance, patient+code
DocumentReference	US Core DocumentReference Profile	_id, status, patient, category, type, date, period, us-core-includeprovenance, patient+status, patient+category, _id+us-core-includeprovenance, patient+category+date, patient+type, patient+us-core-includeprovenance, patient+type+period		$docref
Encounter	US Core Encounter Profile	_id, class, date, identifier, patient, status, type, us-core-includeprovenance, patient+status, _id+us-core-includeprovenance, patient+type, patient+us-core-includeprovenance, class+patient, date+patient
Goal	US Core Goal Profile	lifecycle-status, patient, target-date, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+target-date, patient+lifecycle-status
Immunization	US Core Immunization Profile	patient, status, date, us-core-includeprovenance, patient+status, patient+date, _id+us-core-includeprovenance, patient+us-core-includeprovenance
Location	US Core Location Profile	name, address, address-city, address-state, address-postalcode, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance
Medication	US Core Medication Profile	us-core-includeprovenance
MedicationRequest	US Core MedicationRequest Profile	status, intent, patient, encounter, authoredon, us-core-includeprovenance, patient+intent+authoredon, _id+us-core-includeprovenance, patient+intent, patient+us-core-includeprovenance, patient+intent+encounter, patient+intent+status	MedicationRequest:medication
Observation	US Core Smoking Status Observation Profile, US Core Pediatric Weight for Height Observation Profile, US Core Laboratory Result Observation Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pulse Oximetry Profile	status, category, code, date, patient, us-core-includeprovenance, patient+category, patient+code+date, _id+us-core-includeprovenance, patient+category+status, patient+category+date, patient+us-core-includeprovenance, patient+code
Organization	US Core Organization Profile	name, address, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance
Patient	US Core Patient Profile	_id, birthdate, family, gender, given, identifier, name, us-core-includeprovenance, family+gender, birthdate+family, _id+us-core-includeprovenance, patient+us-core-includeprovenance, birthdate+name, gender+name
Practitioner	US Core Practitioner Profile	name, identifier, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance
PractitionerRole	US Core PractitionerRole Profile	specialty, practitioner, us-core-includeprovenance, _id+us-core-includeprovenance, patient+us-core-includeprovenance	PractitionerRole:endpoint, PractitionerRole:practitioner
Procedure	US Core Procedure Profile	status, patient, date, code, us-core-includeprovenance, patient+status, patient+code+date, _id+us-core-includeprovenance, patient+us-core-includeprovenance, patient+date
Provenance	US Core Provenance Profile
ValueSet				$expand

Provenance

US Core Provenance Profile

ValueSet $expand

AllergyIntolerance

Supported Profiles: US Core AllergyIntolerance Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a AllergyIntolerance resource using:
GET [base]/AllergyIntolerance/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD clinical-status token GET [base]/AllergyIntolerance?clinical-status=[system]|[code]

SHOULD patient reference GET [base]/AllergyIntolerance?patient=[patient]

SHOULD us-core-includeprovenance special GET [base]/AllergyIntolerance?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	clinical-status	token	`GET [base]/AllergyIntolerance?clinical-status=[system]\|[code]`
SHOULD	patient	reference	`GET [base]/AllergyIntolerance?patient=[patient]`
SHOULD	us-core-includeprovenance	special	`GET [base]/AllergyIntolerance?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/AllergyIntolerance?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/AllergyIntolerance?patient=[patient]&us-core-includeprovenance

SHOULD patient+clinical-status reference+token GET [base]/AllergyIntolerance?patient=[patient]&clinical-status=[system]|[code]

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/AllergyIntolerance?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/AllergyIntolerance?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+clinical-status	reference+token	`GET [base]/AllergyIntolerance?patient=[patient]&clinical-status=[system]\|[code]`

CarePlan

Supported Profiles: US Core CarePlan Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a CarePlan resource using:
GET [base]/CarePlan/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD category token GET [base]/CarePlan?category=[system]|[code]

SHOULD date date GET [base]/CarePlan?date=[date]

SHOULD patient reference GET [base]/CarePlan?patient=[patient]

SHOULD status token GET [base]/CarePlan?status=[status]

SHOULD us-core-includeprovenance special GET [base]/CarePlan?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	category	token	`GET [base]/CarePlan?category=[system]\|[code]`
SHOULD	date	date	`GET [base]/CarePlan?date=[date]`
SHOULD	patient	reference	`GET [base]/CarePlan?patient=[patient]`
SHOULD	status	token	`GET [base]/CarePlan?status=[status]`
SHOULD	us-core-includeprovenance	special	`GET [base]/CarePlan?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+category reference+token GET [base]/CarePlan?patient=[patient]&category=[system]|[code]

SHOULD _id+us-core-includeprovenance token+special GET [base]/CarePlan?_id=[id]&us-core-includeprovenance

SHOULD patient+category+status reference+token+token GET [base]/CarePlan?patient=[patient]&category=[system]|[code]&status=[status]

SHOULD patient+category+date reference+token+date GET [base]/CarePlan?patient=[patient]&category=[system]|[code]&date=[date]

SHOULD patient+category+status+date reference+token+token+date GET [base]/CarePlan?patient=[patient]&category=[system]|[code]&status=[status]&date=[date]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/CarePlan?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	patient+category	reference+token	`GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/CarePlan?_id=[id]&us-core-includeprovenance`
SHOULD	patient+category+status	reference+token+token	`GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]&status=[status]`
SHOULD	patient+category+date	reference+token+date	`GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]&date=[date]`
SHOULD	patient+category+status+date	reference+token+token+date	`GET [base]/CarePlan?patient=[patient]&category=[system]\|[code]&status=[status]&date=[date]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/CarePlan?patient=[patient]&us-core-includeprovenance`

CareTeam

Supported Profiles: US Core CareTeam Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a CareTeam resource using:
GET [base]/CareTeam/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD patient reference GET [base]/CareTeam?patient=[patient]

SHOULD status token GET [base]/CareTeam?status=[status]

SHOULD us-core-includeprovenance special GET [base]/CareTeam?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	patient	reference	`GET [base]/CareTeam?patient=[patient]`
SHOULD	status	token	`GET [base]/CareTeam?status=[status]`
SHOULD	us-core-includeprovenance	special	`GET [base]/CareTeam?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+status reference+token GET [base]/CareTeam?patient=[patient]&status=[status]

SHOULD _id+us-core-includeprovenance token+special GET [base]/CareTeam?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/CareTeam?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	patient+status	reference+token	`GET [base]/CareTeam?patient=[patient]&status=[status]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/CareTeam?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/CareTeam?patient=[patient]&us-core-includeprovenance`

Condition

Supported Profiles: US Core Condition Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Condition resource using:
GET [base]/Condition/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD category token GET [base]/Condition?category=[system]|[code]

SHOULD clinical-status token GET [base]/Condition?clinical-status=[system]|[code]

SHOULD patient reference GET [base]/Condition?patient=[patient]

SHOULD onset-date date GET [base]/Condition?onset-date=[onset-date]

SHOULD code token GET [base]/Condition?code=[system]|[code]

SHOULD us-core-includeprovenance special GET [base]/Condition?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	category	token	`GET [base]/Condition?category=[system]\|[code]`
SHOULD	clinical-status	token	`GET [base]/Condition?clinical-status=[system]\|[code]`
SHOULD	patient	reference	`GET [base]/Condition?patient=[patient]`
SHOULD	onset-date	date	`GET [base]/Condition?onset-date=[onset-date]`
SHOULD	code	token	`GET [base]/Condition?code=[system]\|[code]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Condition?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+category reference+token GET [base]/Condition?patient=[patient]&category=[system]|[code]

SHOULD patient+onset-date reference+date GET [base]/Condition?patient=[patient]&onset-date=[onset-date]

SHOULD _id+us-core-includeprovenance token+special GET [base]/Condition?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Condition?patient=[patient]&us-core-includeprovenance

SHOULD patient+code reference+token GET [base]/Condition?patient=[patient]&code=[system]|[code]

SHOULD patient+clinical-status reference+token GET [base]/Condition?patient=[patient]&clinical-status=[system]|[code]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+category	reference+token	`GET [base]/Condition?patient=[patient]&category=[system]\|[code]`
SHOULD	patient+onset-date	reference+date	`GET [base]/Condition?patient=[patient]&onset-date=[onset-date]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Condition?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Condition?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+code	reference+token	`GET [base]/Condition?patient=[patient]&code=[system]\|[code]`
SHOULD	patient+clinical-status	reference+token	`GET [base]/Condition?patient=[patient]&clinical-status=[system]\|[code]`

Device

Supported Profiles: US Core Implantable Device Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Device resource using:
GET [base]/Device/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD patient reference GET [base]/Device?patient=[patient]

SHOULD type token GET [base]/Device?type=[system]|[code]

SHOULD us-core-includeprovenance special GET [base]/Device?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	patient	reference	`GET [base]/Device?patient=[patient]`
SHOULD	type	token	`GET [base]/Device?type=[system]\|[code]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Device?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/Device?_id=[id]&us-core-includeprovenance

SHOULD patient+type reference+token GET [base]/Device?patient=[patient]&type=[system]|[code]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Device?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Device?_id=[id]&us-core-includeprovenance`
SHOULD	patient+type	reference+token	`GET [base]/Device?patient=[patient]&type=[system]\|[code]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Device?patient=[patient]&us-core-includeprovenance`

DiagnosticReport

Supported Profiles: US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting

Profile Interaction Summary:

SHALL support create^†, search-type, read.
SHOULD support vread, history-instance.
MAY support update, patch, delete, history-type.

create^†
This conformance expectation applies only to the US Core DiagnosticReport Profile for Report and Note exchange profile. The conformance expectation for the US Core DiagnosticReport Profile for Laboratory Results Reporting is MAY.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a DiagnosticReport resource using:
GET [base]/DiagnosticReport/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD status token GET [base]/DiagnosticReport?status=[status]

SHOULD patient reference GET [base]/DiagnosticReport?patient=[patient]

SHOULD category token GET [base]/DiagnosticReport?category=[system]|[code]

SHOULD code token GET [base]/DiagnosticReport?code=[system]|[code]

SHOULD date date GET [base]/DiagnosticReport?date=[date]

SHOULD us-core-includeprovenance special GET [base]/DiagnosticReport?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	status	token	`GET [base]/DiagnosticReport?status=[status]`
SHOULD	patient	reference	`GET [base]/DiagnosticReport?patient=[patient]`
SHOULD	category	token	`GET [base]/DiagnosticReport?category=[system]\|[code]`
SHOULD	code	token	`GET [base]/DiagnosticReport?code=[system]\|[code]`
SHOULD	date	date	`GET [base]/DiagnosticReport?date=[date]`
SHOULD	us-core-includeprovenance	special	`GET [base]/DiagnosticReport?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+status reference+token GET [base]/DiagnosticReport?patient=[patient]&status=[status]

SHOULD patient+category reference+token GET [base]/DiagnosticReport?patient=[patient]&category=[system]|[code]

SHOULD patient+code+date reference+token+date GET [base]/DiagnosticReport?patient=[patient]&code=[system]|[code]&date=[date]

SHOULD _id+us-core-includeprovenance token+special GET [base]/DiagnosticReport?_id=[id]&us-core-includeprovenance

SHOULD patient+category+date reference+token+date GET [base]/DiagnosticReport?patient=[patient]&category=[system]|[code]&date=[date]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/DiagnosticReport?patient=[patient]&us-core-includeprovenance

SHOULD patient+code reference+token GET [base]/DiagnosticReport?patient=[patient]&code=[system]|[code]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+status	reference+token	`GET [base]/DiagnosticReport?patient=[patient]&status=[status]`
SHOULD	patient+category	reference+token	`GET [base]/DiagnosticReport?patient=[patient]&category=[system]\|[code]`
SHOULD	patient+code+date	reference+token+date	`GET [base]/DiagnosticReport?patient=[patient]&code=[system]\|[code]&date=[date]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/DiagnosticReport?_id=[id]&us-core-includeprovenance`
SHOULD	patient+category+date	reference+token+date	`GET [base]/DiagnosticReport?patient=[patient]&category=[system]\|[code]&date=[date]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/DiagnosticReport?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+code	reference+token	`GET [base]/DiagnosticReport?patient=[patient]&code=[system]\|[code]`

DocumentReference

Supported Profiles: US Core DocumentReference Profile

Resource Specific Documentation:

The DocumentReference.type binding SHALL support at a minimum the 5 Common Clinical Notes and may extend to the full US Core DocumentReference Type Value Set

Profile Interaction Summary:

SHALL support create, search-type, read.
SHOULD support vread, history-instance.
MAY support update, patch, delete, history-type.

Operation Summary:

SHOULD support the $docref operation
A client SHOULD be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and MAY be able to receive other document types, if available. SHOULD be capable of receiving documents as included resources in response to the operation.
GET [base]/DocumentReference/$docref?patient=[id]

Fetch and Search Criteria:

A Client SHALL be capable of fetching a DocumentReference resource using:
GET [base]/DocumentReference/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD _id token GET [base]/DocumentReference?_id=[id]

SHOULD status token GET [base]/DocumentReference?status=[status]

SHOULD patient reference GET [base]/DocumentReference?patient=[patient]

SHOULD category token GET [base]/DocumentReference?category=[system]|[code]

SHOULD type token GET [base]/DocumentReference?type=[system]|[code]

SHOULD date date GET [base]/DocumentReference?date=[date]

SHOULD period date GET [base]/DocumentReference?period=[period]

SHOULD us-core-includeprovenance special GET [base]/DocumentReference?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	_id	token	`GET [base]/DocumentReference?_id=[id]`
SHOULD	status	token	`GET [base]/DocumentReference?status=[status]`
SHOULD	patient	reference	`GET [base]/DocumentReference?patient=[patient]`
SHOULD	category	token	`GET [base]/DocumentReference?category=[system]\|[code]`
SHOULD	type	token	`GET [base]/DocumentReference?type=[system]\|[code]`
SHOULD	date	date	`GET [base]/DocumentReference?date=[date]`
SHOULD	period	date	`GET [base]/DocumentReference?period=[period]`
SHOULD	us-core-includeprovenance	special	`GET [base]/DocumentReference?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+status reference+token GET [base]/DocumentReference?patient=[patient]&status=[status]

SHOULD patient+category reference+token GET [base]/DocumentReference?patient=[patient]&category=[system]|[code]

SHOULD _id+us-core-includeprovenance token+special GET [base]/DocumentReference?_id=[id]&us-core-includeprovenance

SHOULD patient+category+date reference+token+date GET [base]/DocumentReference?patient=[patient]&category=[system]|[code]&date=[date]

SHOULD patient+type reference+token GET [base]/DocumentReference?patient=[patient]&type=[system]|[code]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/DocumentReference?patient=[patient]&us-core-includeprovenance

SHOULD patient+type+period reference+token+date GET [base]/DocumentReference?patient=[patient]&type=[system]|[code]&period=[period]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+status	reference+token	`GET [base]/DocumentReference?patient=[patient]&status=[status]`
SHOULD	patient+category	reference+token	`GET [base]/DocumentReference?patient=[patient]&category=[system]\|[code]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/DocumentReference?_id=[id]&us-core-includeprovenance`
SHOULD	patient+category+date	reference+token+date	`GET [base]/DocumentReference?patient=[patient]&category=[system]\|[code]&date=[date]`
SHOULD	patient+type	reference+token	`GET [base]/DocumentReference?patient=[patient]&type=[system]\|[code]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/DocumentReference?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+type+period	reference+token+date	`GET [base]/DocumentReference?patient=[patient]&type=[system]\|[code]&period=[period]`

Encounter

Supported Profiles: US Core Encounter Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Encounter resource using:
GET [base]/Encounter/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD _id token GET [base]/Encounter?_id=[id]

SHOULD class token GET [base]/Encounter?class=[system]|[code]

SHOULD date date GET [base]/Encounter?date=[date]

SHOULD identifier token GET [base]/Encounter?identifier=[system]|[code]

SHOULD patient reference GET [base]/Encounter?patient=[patient]

SHOULD status token GET [base]/Encounter?status=[status]

SHOULD type token GET [base]/Encounter?type=[system]|[code]

SHOULD us-core-includeprovenance special GET [base]/Encounter?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	_id	token	`GET [base]/Encounter?_id=[id]`
SHOULD	class	token	`GET [base]/Encounter?class=[system]\|[code]`
SHOULD	date	date	`GET [base]/Encounter?date=[date]`
SHOULD	identifier	token	`GET [base]/Encounter?identifier=[system]\|[code]`
SHOULD	patient	reference	`GET [base]/Encounter?patient=[patient]`
SHOULD	status	token	`GET [base]/Encounter?status=[status]`
SHOULD	type	token	`GET [base]/Encounter?type=[system]\|[code]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Encounter?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+status reference+token GET [base]/Encounter?patient=[patient]&status=[status]

SHOULD _id+us-core-includeprovenance token+special GET [base]/Encounter?_id=[id]&us-core-includeprovenance

SHOULD patient+type reference+token GET [base]/Encounter?patient=[patient]&type=[system]|[code]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Encounter?patient=[patient]&us-core-includeprovenance

SHOULD class+patient token+reference GET [base]/Encounter?class=[system]|[code]&patient=[patient]

SHOULD date+patient date+reference GET [base]/Encounter?date=[date]&patient=[patient]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+status	reference+token	`GET [base]/Encounter?patient=[patient]&status=[status]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Encounter?_id=[id]&us-core-includeprovenance`
SHOULD	patient+type	reference+token	`GET [base]/Encounter?patient=[patient]&type=[system]\|[code]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Encounter?patient=[patient]&us-core-includeprovenance`
SHOULD	class+patient	token+reference	`GET [base]/Encounter?class=[system]\|[code]&patient=[patient]`
SHOULD	date+patient	date+reference	`GET [base]/Encounter?date=[date]&patient=[patient]`

Goal

Supported Profiles: US Core Goal Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Goal resource using:
GET [base]/Goal/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD lifecycle-status token GET [base]/Goal?lifecycle-status=[system]|[code]

SHOULD patient reference GET [base]/Goal?patient=[patient]

SHOULD target-date date GET [base]/Goal?target-date=[target-date]

SHOULD us-core-includeprovenance special GET [base]/Goal?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	lifecycle-status	token	`GET [base]/Goal?lifecycle-status=[system]\|[code]`
SHOULD	patient	reference	`GET [base]/Goal?patient=[patient]`
SHOULD	target-date	date	`GET [base]/Goal?target-date=[target-date]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Goal?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/Goal?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Goal?patient=[patient]&us-core-includeprovenance

SHOULD patient+target-date reference+date GET [base]/Goal?patient=[patient]&target-date=[target-date]

SHOULD patient+lifecycle-status reference+token GET [base]/Goal?patient=[patient]&lifecycle-status=[system]|[code]

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Goal?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Goal?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+target-date	reference+date	`GET [base]/Goal?patient=[patient]&target-date=[target-date]`
SHOULD	patient+lifecycle-status	reference+token	`GET [base]/Goal?patient=[patient]&lifecycle-status=[system]\|[code]`

Immunization

Supported Profiles: US Core Immunization Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Immunization resource using:
GET [base]/Immunization/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD patient reference GET [base]/Immunization?patient=[patient]

SHOULD status token GET [base]/Immunization?status=[status]

SHOULD date date GET [base]/Immunization?date=[date]

SHOULD us-core-includeprovenance special GET [base]/Immunization?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	patient	reference	`GET [base]/Immunization?patient=[patient]`
SHOULD	status	token	`GET [base]/Immunization?status=[status]`
SHOULD	date	date	`GET [base]/Immunization?date=[date]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Immunization?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+status reference+token GET [base]/Immunization?patient=[patient]&status=[status]

SHOULD patient+date reference+date GET [base]/Immunization?patient=[patient]&date=[date]

SHOULD _id+us-core-includeprovenance token+special GET [base]/Immunization?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Immunization?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	patient+status	reference+token	`GET [base]/Immunization?patient=[patient]&status=[status]`
SHOULD	patient+date	reference+date	`GET [base]/Immunization?patient=[patient]&date=[date]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Immunization?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Immunization?patient=[patient]&us-core-includeprovenance`

Location

Supported Profiles: US Core Location Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Location resource using:
GET [base]/Location/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD name string GET [base]/Location?name=[name]

SHOULD address string GET [base]/Location?address=[address]

SHOULD address-city string GET [base]/Location?address-city=[address-city]

SHOULD address-state string GET [base]/Location?address-state=[address-state]

SHOULD address-postalcode string GET [base]/Location?address-postalcode=[address-postalcode]

SHOULD us-core-includeprovenance special GET [base]/Location?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	name	string	`GET [base]/Location?name=[name]`
SHOULD	address	string	`GET [base]/Location?address=[address]`
SHOULD	address-city	string	`GET [base]/Location?address-city=[address-city]`
SHOULD	address-state	string	`GET [base]/Location?address-state=[address-state]`
SHOULD	address-postalcode	string	`GET [base]/Location?address-postalcode=[address-postalcode]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Location?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/Location?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Location?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Location?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Location?patient=[patient]&us-core-includeprovenance`

Medication

Supported Profiles: US Core Medication Profile

Resource Specific Documentation:

The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria SHALL be supported.

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Medication resource using:
GET [base]/Medication/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD us-core-includeprovenance special GET [base]/Medication?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	us-core-includeprovenance	special	`GET [base]/Medication?us-core-includeprovenance`

MedicationRequest

Supported Profiles: US Core MedicationRequest Profile

Resource Specific Documentation:

The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include` parameter for searching this element. The client application must support all methods.
For example, A server SHALL be capable of returning all medications for a patient using one of or both:
GET /MedicationRequest?patient=[id]
GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a MedicationRequest resource using:
GET [base]/MedicationRequest/[id]

A Client SHOULD be capable of supporting the following _includes:
MedicationRequest:medication - GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD status token GET [base]/MedicationRequest?status=[status]

SHOULD intent token GET [base]/MedicationRequest?intent=[system]|[code]

SHOULD patient reference GET [base]/MedicationRequest?patient=[patient]

SHOULD encounter reference GET [base]/MedicationRequest?encounter=[encounter]

SHOULD authoredon date GET [base]/MedicationRequest?authoredon=[authoredon]

SHOULD us-core-includeprovenance special GET [base]/MedicationRequest?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	status	token	`GET [base]/MedicationRequest?status=[status]`
SHOULD	intent	token	`GET [base]/MedicationRequest?intent=[system]\|[code]`
SHOULD	patient	reference	`GET [base]/MedicationRequest?patient=[patient]`
SHOULD	encounter	reference	`GET [base]/MedicationRequest?encounter=[encounter]`
SHOULD	authoredon	date	`GET [base]/MedicationRequest?authoredon=[authoredon]`
SHOULD	us-core-includeprovenance	special	`GET [base]/MedicationRequest?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+intent+authoredon reference+token+date GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&authoredon=[authoredon]

SHOULD _id+us-core-includeprovenance token+special GET [base]/MedicationRequest?_id=[id]&us-core-includeprovenance

SHOULD patient+intent reference+token GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/MedicationRequest?patient=[patient]&us-core-includeprovenance

SHOULD patient+intent+encounter reference+token+reference GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&encounter=[encounter]

SHOULD patient+intent+status reference+token+token GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&status=[status]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+intent+authoredon	reference+token+date	`GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]&authoredon=[authoredon]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/MedicationRequest?_id=[id]&us-core-includeprovenance`
SHOULD	patient+intent	reference+token	`GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/MedicationRequest?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+intent+encounter	reference+token+reference	`GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]&encounter=[encounter]`
SHOULD	patient+intent+status	reference+token+token	`GET [base]/MedicationRequest?patient=[patient]&intent=[system]\|[code]&status=[status]`

Observation

Supported Profiles: US Core Smoking Status Observation Profile, US Core Pediatric Weight for Height Observation Profile, US Core Laboratory Result Observation Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pulse Oximetry Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Observation resource using:
GET [base]/Observation/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD status token GET [base]/Observation?status=[status]

SHOULD category token GET [base]/Observation?category=[system]|[code]

SHOULD code token GET [base]/Observation?code=[system]|[code]

SHOULD date date GET [base]/Observation?date=[date]

SHOULD patient reference GET [base]/Observation?patient=[patient]

SHOULD us-core-includeprovenance special GET [base]/Observation?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	status	token	`GET [base]/Observation?status=[status]`
SHOULD	category	token	`GET [base]/Observation?category=[system]\|[code]`
SHOULD	code	token	`GET [base]/Observation?code=[system]\|[code]`
SHOULD	date	date	`GET [base]/Observation?date=[date]`
SHOULD	patient	reference	`GET [base]/Observation?patient=[patient]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Observation?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+category reference+token GET [base]/Observation?patient=[patient]&category=[system]|[code]

SHOULD patient+code+date reference+token+date GET [base]/Observation?patient=[patient]&code=[system]|[code]&date=[date]

SHOULD _id+us-core-includeprovenance token+special GET [base]/Observation?_id=[id]&us-core-includeprovenance

SHOULD patient+category+status reference+token+token GET [base]/Observation?patient=[patient]&category=[system]|[code]&status=[status]

SHOULD patient+category+date reference+token+date GET [base]/Observation?patient=[patient]&category=[system]|[code]&date=[date]

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Observation?patient=[patient]&us-core-includeprovenance

SHOULD patient+code reference+token GET [base]/Observation?patient=[patient]&code=[system]|[code]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+category	reference+token	`GET [base]/Observation?patient=[patient]&category=[system]\|[code]`
SHOULD	patient+code+date	reference+token+date	`GET [base]/Observation?patient=[patient]&code=[system]\|[code]&date=[date]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Observation?_id=[id]&us-core-includeprovenance`
SHOULD	patient+category+status	reference+token+token	`GET [base]/Observation?patient=[patient]&category=[system]\|[code]&status=[status]`
SHOULD	patient+category+date	reference+token+date	`GET [base]/Observation?patient=[patient]&category=[system]\|[code]&date=[date]`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Observation?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+code	reference+token	`GET [base]/Observation?patient=[patient]&code=[system]\|[code]`

Organization

Supported Profiles: US Core Organization Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Organization resource using:
GET [base]/Organization/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD name string GET [base]/Organization?name=[name]

SHOULD address string GET [base]/Organization?address=[address]

SHOULD us-core-includeprovenance special GET [base]/Organization?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	name	string	`GET [base]/Organization?name=[name]`
SHOULD	address	string	`GET [base]/Organization?address=[address]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Organization?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/Organization?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Organization?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Organization?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Organization?patient=[patient]&us-core-includeprovenance`

Patient

Supported Profiles: US Core Patient Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Patient resource using:
GET [base]/Patient/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD _id token GET [base]/Patient?_id=[id]

SHOULD birthdate date GET [base]/Patient?birthdate=[birthdate]

SHOULD family string GET [base]/Patient?family=[family]

SHOULD gender token GET [base]/Patient?gender=[system]|[code]

SHOULD given string GET [base]/Patient?given=[given]

SHOULD identifier token GET [base]/Patient?identifier=[system]|[code]

SHOULD name string GET [base]/Patient?name=[name]

SHOULD us-core-includeprovenance special GET [base]/Patient?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	_id	token	`GET [base]/Patient?_id=[id]`
SHOULD	birthdate	date	`GET [base]/Patient?birthdate=[birthdate]`
SHOULD	family	string	`GET [base]/Patient?family=[family]`
SHOULD	gender	token	`GET [base]/Patient?gender=[system]\|[code]`
SHOULD	given	string	`GET [base]/Patient?given=[given]`
SHOULD	identifier	token	`GET [base]/Patient?identifier=[system]\|[code]`
SHOULD	name	string	`GET [base]/Patient?name=[name]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Patient?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD family+gender string+token GET [base]/Patient?family=[family]&gender=[system]|[code]

SHOULD birthdate+family date+string GET [base]/Patient?birthdate=[birthdate]&family=[family]

SHOULD _id+us-core-includeprovenance token+special GET [base]/Patient?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Patient?patient=[patient]&us-core-includeprovenance

SHOULD birthdate+name date+string GET [base]/Patient?birthdate=[birthdate]&name=[name]

SHOULD gender+name token+string GET [base]/Patient?gender=[system]|[code]&name=[name]

Conformance	Parameter Combination	Types	Example
SHOULD	family+gender	string+token	`GET [base]/Patient?family=[family]&gender=[system]\|[code]`
SHOULD	birthdate+family	date+string	`GET [base]/Patient?birthdate=[birthdate]&family=[family]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Patient?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Patient?patient=[patient]&us-core-includeprovenance`
SHOULD	birthdate+name	date+string	`GET [base]/Patient?birthdate=[birthdate]&name=[name]`
SHOULD	gender+name	token+string	`GET [base]/Patient?gender=[system]\|[code]&name=[name]`

Practitioner

Supported Profiles: US Core Practitioner Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Practitioner resource using:
GET [base]/Practitioner/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD name string GET [base]/Practitioner?name=[name]

SHOULD identifier token GET [base]/Practitioner?identifier=[system]|[code]

SHOULD us-core-includeprovenance special GET [base]/Practitioner?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	name	string	`GET [base]/Practitioner?name=[name]`
SHOULD	identifier	token	`GET [base]/Practitioner?identifier=[system]\|[code]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Practitioner?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/Practitioner?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Practitioner?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Practitioner?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Practitioner?patient=[patient]&us-core-includeprovenance`

PractitionerRole

Supported Profiles: US Core PractitionerRole Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a PractitionerRole resource using:
GET [base]/PractitionerRole/[id]

A Client SHOULD be capable of supporting the following _includes:
PractitionerRole:endpoint - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint PractitionerRole:practitioner - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD specialty token GET [base]/PractitionerRole?specialty=[system]|[code]

SHOULD practitioner reference GET [base]/PractitionerRole?practitioner=[practitioner]

SHOULD us-core-includeprovenance special GET [base]/PractitionerRole?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	specialty	token	`GET [base]/PractitionerRole?specialty=[system]\|[code]`
SHOULD	practitioner	reference	`GET [base]/PractitionerRole?practitioner=[practitioner]`
SHOULD	us-core-includeprovenance	special	`GET [base]/PractitionerRole?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD _id+us-core-includeprovenance token+special GET [base]/PractitionerRole?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/PractitionerRole?patient=[patient]&us-core-includeprovenance

Conformance	Parameter Combination	Types	Example
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/PractitionerRole?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/PractitionerRole?patient=[patient]&us-core-includeprovenance`

Procedure

Supported Profiles: US Core Procedure Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Procedure resource using:
GET [base]/Procedure/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD status token GET [base]/Procedure?status=[status]

SHOULD patient reference GET [base]/Procedure?patient=[patient]

SHOULD date date GET [base]/Procedure?date=[date]

SHOULD code token GET [base]/Procedure?code=[system]|[code]

SHOULD us-core-includeprovenance special GET [base]/Procedure?us-core-includeprovenance

Conformance	Parameter	Type	Example
SHOULD	status	token	`GET [base]/Procedure?status=[status]`
SHOULD	patient	reference	`GET [base]/Procedure?patient=[patient]`
SHOULD	date	date	`GET [base]/Procedure?date=[date]`
SHOULD	code	token	`GET [base]/Procedure?code=[system]\|[code]`
SHOULD	us-core-includeprovenance	special	`GET [base]/Procedure?us-core-includeprovenance`

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example

SHOULD patient+status reference+token GET [base]/Procedure?patient=[patient]&status=[status]

SHOULD patient+code+date reference+token+date GET [base]/Procedure?patient=[patient]&code=[system]|[code]&date=[date]

SHOULD _id+us-core-includeprovenance token+special GET [base]/Procedure?_id=[id]&us-core-includeprovenance

SHOULD patient+us-core-includeprovenance reference+special GET [base]/Procedure?patient=[patient]&us-core-includeprovenance

SHOULD patient+date reference+date GET [base]/Procedure?patient=[patient]&date=[date]

Conformance	Parameter Combination	Types	Example
SHOULD	patient+status	reference+token	`GET [base]/Procedure?patient=[patient]&status=[status]`
SHOULD	patient+code+date	reference+token+date	`GET [base]/Procedure?patient=[patient]&code=[system]\|[code]&date=[date]`
SHOULD	_id+us-core-includeprovenance	token+special	`GET [base]/Procedure?_id=[id]&us-core-includeprovenance`
SHOULD	patient+us-core-includeprovenance	reference+special	`GET [base]/Procedure?patient=[patient]&us-core-includeprovenance`
SHOULD	patient+date	reference+date	`GET [base]/Procedure?patient=[patient]&date=[date]`

Provenance

Supported Profiles: US Core Provenance Profile

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread, history-instance.
MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

A Client SHALL be capable of fetching a Provenance resource using:
GET [base]/Provenance/[id]

ValueSet

Operation Summary:

SHOULD support the $expand operation
A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions.