This page is part of the US Core (v7.0.0-ballot: STU7 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.1.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client | Version: 7.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: UsCoreClientCapabilityStatement | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
This 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.
Raw OpenAPI-Swagger Definition file | Download
The US Core Client SHALL:
Security:
Summary of System Wide Interactions
transaction
interaction.batch
interaction.search-system
interaction.history-system
interaction.Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
---|---|---|---|---|---|
AllergyIntolerance | US Core AllergyIntolerance Profile | clinical-status, patient patient+clinical-status | - | Provenance:target | - |
CarePlan | US Core CarePlan Profile | category, date, patient, status patient+category+status+date, patient+category+date, patient+category, patient+category+status | - | Provenance:target | - |
CareTeam | US Core CareTeam Profile | patient, status, role patient+status, patient+role | CareTeam:participant:PractitionerRole, CareTeam:participant:Practitioner, CareTeam:participant:Patient, CareTeam:participant:RelatedPerson | Provenance:target | - |
Condition | US Core Condition Encounter Diagnosis Profile, US Core Condition Problems and Health Concerns Profile | category, clinical-status, patient, onset-date, asserted-date, recorded-date, abatement-date, code, encounter patient+category, patient+asserted-date, patient+onset-date, patient+code, patient+recorded-date, patient+abatement-date, patient+category+clinical-status, patient+category+encounter, patient+clinical-status | - | Provenance:target | - |
Coverage | US Core Coverage Profile | patient | - | Provenance:target | - |
Device | US Core Implantable Device Profile | patient, type, status patient+status, patient+type | - | Provenance:target | - |
DiagnosticReport | US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting | status, patient, category, code, date patient+category, patient+category+date, patient+code, patient+status, patient+code+date | - | Provenance:target | - |
DocumentReference | US Core DocumentReference Profile | _id, status, patient, category, type, date, period patient+category, patient+category+date, patient+type+period, patient+type, patient+status | - | Provenance:target | docref |
Encounter | US Core Encounter Profile | _id, class, date, identifier, patient, location, status, type, discharge-disposition class+patient, patient+location, patient+status, patient+discharge-disposition, patient+type, date+patient | - | Provenance:target | - |
Endpoint | - | - | - | - | - |
Goal | US Core Goal Profile | lifecycle-status, patient, target-date, description patient+target-date, patient+description, patient+lifecycle-status | - | Provenance:target | - |
HealthcareService | - | - | - | - | - |
Immunization | US Core Immunization Profile | patient, status, date patient+status, patient+date | - | Provenance:target | - |
Location | US Core Location Profile | name, address, address-city, address-state, address-postalcode | - | - | - |
Media | - | - | - | - | - |
Medication | US Core Medication Profile | - | - | - | - |
MedicationDispense | US Core MedicationDispense Profile | status, type, patient patient+status, patient+status+type | MedicationDispense:medication | Provenance:target | - |
MedicationRequest | US Core MedicationRequest Profile | status, intent, patient, encounter, authoredon patient+intent+encounter, patient+intent+authoredon, patient+intent, patient+intent+status | MedicationRequest:medication | Provenance:target | - |
Observation | US Core Laboratory Result Observation Profile, US Core Observation Pregnancy Status Profile, US Core Observation Pregnancy Intent Profile, US Core Observation Occupation Profile, US Core Respiratory Rate Profile, US Core Simple Observation Profile, US Core Treatment Intervention Preference Profile, US Core Care Experience Preference Profile, US Core Heart Rate Profile, US Core Body Temperature Profile, US Core Pediatric Weight for Height Observation Profile, US Core Pulse Oximetry Profile, US Core Smoking Status Observation Profile, US Core Observation Sexual Orientation Profile, US Core Head Circumference Profile, US Core Body Height Profile, US Core BMI Profile, US Core Observation Screening Assessment Profile, US Core Average Blood Pressure Profile, US Core Blood Pressure Profile, US Core Observation Clinical Result Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pediatric Head Occipital Frontal Circumference Percentile Profile, US Core Body Weight Profile, US Core Vital Signs Profile | status, category, code, date, patient patient+category, patient+category+date, patient+code, patient+category+status, patient+code+date | - | Provenance:target | - |
Organization | US Core Organization Profile | name, address | - | - | - |
Patient | US Core Patient Profile | _id, birthdate, death-date, family, gender, given, identifier, name birthdate+name, birthdate+family, family+gender, death-date+family, gender+name | - | Provenance:target | - |
Practitioner | US Core Practitioner Profile | _id, name, identifier | - | - | - |
PractitionerRole | US Core PractitionerRole Profile | specialty, practitioner | PractitionerRole:endpoint, PractitionerRole:practitioner | - | - |
Procedure | US Core Procedure Profile | status, patient, date, code patient+status, patient+code+date, patient+date | - | Provenance:target | - |
Provenance | US Core Provenance Profile | - | - | - | - |
Questionnaire | SDC Base Questionnaire Profile | - | - | - | - |
QuestionnaireResponse | US Core QuestionnaireResponse Profile | _id, patient, status, authored, questionnaire patient+authored, patient+status, patient+questionnaire | - | Provenance:target | - |
RelatedPerson | US Core RelatedPerson Profile | _id, patient, name patient+name | - | Provenance:target | - |
ServiceRequest | US Core ServiceRequest Profile | status, patient, category, code, authored, _id patient+category+authored, patient+category, patient+code+authored, patient+code, patient+status | - | Provenance:target | - |
Specimen | US Core Specimen Profile | _id, patient | - | - | - |
ValueSet | - | - | - | - | expand |
Conformance Expectation: SHALL
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/AllergyIntolerance/[id]
GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ clinical-status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
- Additional considerations for systems aligning with HL7 Consolidated (C-CDA) Care Plan requirements:
- US Core Goal SHOULD be present in CarePlan.goal
- US Core Condition SHOULD be present in CarePlan.addresses
- Assement and Plan MAY be included as narrative text
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/CarePlan/[id]
GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ category+ status+ date | reference+token+token+date |
SHOULD | patient+ category+ date | reference+token+date |
SHALL | patient+ category | reference+token |
SHOULD | patient+ category+ status | reference+token+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:
- US Core Practitioner Profile
- US Core PractitionerRole Profile
- US Core Patient Profile
- US Core RelatedPerson Profile
- Although both US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references, but SHALL support at least one of them.
- The client application SHALL support all four profile references.
- Bacause the US Core PractitionerRole Profile supplies the provider's location and contact information and a reference to the Practitioner, server systems SHOULD reference it instead of the US Core Practitioner Profile.
- Servers that supports only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider's location and contact information using only the Practitioner resource.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/CareTeam/[id]
GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRole
GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Practitioner
GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Patient
GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPerson
GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHOULD | role | token |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | patient+ status | reference+token |
SHOULD | patient+ role | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
- For Encounter Diagnosis use the US Core Condition Encounter Diagnosis Profile.
- When
Condition.category
is "encounter-diagnosis" the encounter, SHOULD be referenced inCondition.encounter
.- For Problems and Health Concerns use the US Core Condition Problems and Health Concerns Profile.
- When
Condition.category
is a "problems-list-item", the `Condition.clinicalStatus SHOULD NOT be unknown.- There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension,
Condition.onsetDateTime
, orCondition.recordedDate
.
- Although all three are marked as must support, the server is not required to support all.
- A server SHALL support
Condition.recordedDate
.- A server SHALL support at least one of the assertedDate Extension and
Condition.onsetDateTime
. A server may support both, which means they support all three elements.- The client application SHALL support all three elements.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Condition/[id]
GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | patient+ category | reference+token |
SHOULD | patient+ asserted-date | reference+date |
SHOULD | patient+ onset-date | reference+date |
SHOULD | patient+ code | reference+token |
SHOULD | patient+ recorded-date | reference+date |
SHOULD | patient+ abatement-date | reference+date |
SHOULD | patient+ category+ clinical-status | reference+token+token |
SHOULD | patient+ category+ encounter | reference+token+reference |
SHOULD | patient+ clinical-status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Coverage/[id]
GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
Implantable medical devices that have UDI information SHALL represent the UDI code in
Device.udiCarrier.carrierHRF
.
- All of the five UDI-PI elements that are present in the UDI code SHALL be represented in the corresponding US Core Implantable Device Profile element.
UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they SHOULD be included to support historical reports of implantable medical devices as follows:
manufacturer ->
Device.manufacturer
model ->Device.model
Servers SHOULD support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Device/[id]
GET [base]/Device?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ status | reference+token |
SHOULD | patient+ type | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Supported Profiles:
Reference Policy
Profile Interaction Summary:
create
†, search-type
, read
.vread
, history-instance
.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:
GET [base]/DiagnosticReport/[id]
GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | patient+ category | reference+token |
SHALL | patient+ category+ date | reference+token+date |
SHALL | patient+ code | reference+token |
SHOULD | patient+ status | reference+token |
SHOULD | patient+ code+ date | reference+token+date |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHALL
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- The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using
DocumentReference.attachment.url
or the content as inline base64 encoded data usingDocumentReference.attachment.data
.
- Although both are marked as must support, the server system is not required to support an address, and inline base64 encoded data, but SHALL support at least one of these elements.
- The client application SHALL support both elements.
- The
content.url
may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.
- If the endpoint is outside the FHIR base URL, it SHOULD NOT require additional authorization to access.
- If there are multiple
DocumentReference.content
element repetitions, these SHALL all represent the same document in different format or attachment metadata. The content element SHALL not contain different versions of the same content. For version handling use multiple DocumentReferences withDocumentReference.relatesTo
- Every DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference SHALL be present either in
DocumentReference.custodian
or accessible in the Provenance resource targeting the DocumentReference usingProvenance.agent.who
orProvenance.agent.onBehalfOf
.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
create
, search-type
, read
.vread
, history-instance
.update
, patch
, delete
, history-type
.Operation Summary:
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:
GET [base]/DocumentReference/[id]
GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | _id | token |
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | patient+ category | reference+token |
SHALL | patient+ category+ date | reference+token+date |
SHOULD | patient+ type+ period | reference+token+date |
SHALL | patient+ type | reference+token |
SHOULD | patient+ status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHALL
Resource Specific Documentation:
The Encounter resource can represent a reason using either a code with
Encounter.reasonCode
, or a reference withEncounter.reasonReference
to Condition or other resource.
- Although both are marked as must support, the server systems are not required to support both a code and a reference, but they SHALL support at least one of these elements.
- The client application SHALL support both elements.
- if
Encounter.reasonReference
references an Observation, it SHOULD conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)The location address can be represented by either by the Location referenced by
Encounter.location.location
or indirectly through the Organization referenced byEncounter.serviceProvider
.
- Although both are marked as must support, the server systems are not required to support both
Encounter.location.location
andEncounter.serviceProvider
, but they SHALL support at least one of these elements.- The client application SHALL support both elements.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Encounter/[id]
GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | _id | token |
SHOULD | identifier | token |
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | class+ patient | token+reference |
SHOULD | patient+ location | reference+reference |
SHOULD | patient+ status | reference+token |
SHOULD | patient+ discharge-disposition | reference+token |
SHOULD | patient+ type | reference+token |
SHALL | date+ patient | date+reference |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
The Media Resource is a Must Suppot referenced resource when using the US Core PracitionerRole Profile.
Reference Policy
Profile Interaction Summary:
read
, vread
.create
, search-type
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Endpoint/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
- Although both
Goal.startDate
andGoal.target.dueDate
are marked as must support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both elements.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Goal/[id]
GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ target-date | reference+date |
SHOULD | patient+ description | reference+token |
SHOULD | patient+ lifecycle-status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
Conformance Expectation: MAY
Resource Specific Documentation:
The HealthcareService Resource is a referenced resource when using the US Core PracitionRole Profile and subject to constraint us-core-13: "SHALL have a practitioner, an organization, a healthcare service, or a location."
Reference Policy
Profile Interaction Summary:
read
, vread
.create
, search-type
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/HealthcareService/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
- Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes SHOULD be supported as translations to them.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Immunization/[id]
GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ status | reference+token |
SHOULD | patient+ date | reference+date |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHALL
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Location/[id]
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | name | string |
SHALL | address | string |
SHOULD | address-city | string |
SHOULD | address-state | string |
SHOULD | address-postalcode | string |
Conformance Expectation: SHALL
Resource Specific Documentation:
The Media Resource is a Must Suppot referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.
Reference Policy
Profile Interaction Summary:
read
, vread
.create
, search-type
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Media/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
- The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ SHALL be supported.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
read
.vread
, history-instance
.create
, search-type
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Medication/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
- The MedicationDispense 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 dispense records for all medications for a patient using one of or both:
GET /MedicationDispense?patient=[id]
GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/MedicationDispense/[id]
GET [base]/MedicationDispense?[parameter=value]&_include=MedicationDispense:medication
GET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ status | reference+token |
SHOULD | patient+ status+ type | reference+token+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
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
- The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in
MedicationRequest.reportedBoolean
, or a reference usingMedicationRequest.reportedReference
to Practitioner or other resource.
- Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but SHALL choose to support at least one of these elements.
- The client application SHALL support both elements.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/MedicationRequest/[id]
GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication
GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ intent+ encounter | reference+token+reference |
SHOULD | patient+ intent+ authoredon | reference+token+date |
SHALL | patient+ intent | reference+token |
SHALL | patient+ intent+ status | reference+token+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHALL
Resource Specific Documentation:
- Systems SHOULD support
Observation.effectivePeriod
to accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).- An Observation without a value, SHALL include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it
- Systems that never provide an observation without a value are not required to support
Observation.dataAbsentReason
- An
Observation.component
without a value, SHALL include a reason why the data is absent.
- Systems that never provide an component observation without a component value are not required to support
Observation.component.dataAbsentReason
.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Observation/[id]
GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | patient+ category | reference+token |
SHALL | patient+ category+ date | reference+token+date |
SHALL | patient+ code | reference+token |
SHOULD | patient+ category+ status | reference+token+token |
SHOULD | patient+ code+ date | reference+token+date |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
- Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) identifiers for
Organization.Identifier
.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Organization/[id]
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | name | string |
SHALL | address | string |
Conformance Expectation: SHALL
Resource Specific Documentation:
For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.
- contact detail (e.g. a telephone number or an email address)
- a communication language
- a race
- an ethnicity
- a birth sex*
- previous name
- Previous name is represented by providing an end date in the
Patient.name.period
element for a previous name.- suffix
- Suffix is represented using the
Patient.name.suffix
element.The Patient's Social Security Numbers SHOULD NOT be used as a patient identifier in
Patient.identifier.value
.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Patient/[id]
GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | _id | token |
SHALL | identifier | token |
SHALL | name | string |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | birthdate+ name | date+string |
SHOULD | birthdate+ family | date+string |
SHOULD | family+ gender | string+token |
SHOULD | death-date+ family | date+string |
SHALL | gender+ name | token+string |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
A server SHALL support a value precise to the day.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
Servers that support only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Practitioner/[id]
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHOULD | _id | token |
SHALL | name | string |
SHALL | identifier | token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
- Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile SHOULD be used as the default profile if referenced by another US Core profile.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/PractitionerRole/[id]
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | specialty | token |
SHALL | practitioner | reference |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.
- Only LOINC concepts that reflect actual procedures SHOULD be used
A procedure including an implantable device SHOULD use
Procedure.focalDevice
with a reference to the US Core Implantable Device Profile.The Reason or justification for a referral or consultation is communicated through:
ServiceRequest.reason
orServiceRequest.reason
, andProcedure.basedOn
that links the Procedure to the US Core ServiceRequest Profile.
ServiceRequest.reasonCode
andServiceRequest.reasonReference
are marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.- As documented here, when using
ServiceRequest.reasonReference
, the referenced resources SHOULD be a US Core Profile.Procedure.reasonCode
orProcedure.reasonReference
when the Procedure does not have an associated ServiceRequest.
- Although both
Procedure.reasonCode
andProcedure.reasonReference
are marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.- As documented here, when using
Procedure.reasonReference
, the referenced resources SHOULD be a US Core Profile.Certifying Servers and Clients SHALL support options 1 and 2 as Additional USCDI Requirements.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Procedure/[id]
GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ status | reference+token |
SHOULD | patient+ code+ date | reference+token+date |
SHALL | patient+ date | reference+date |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
- The US Core Provenance resource SHALL be supported for these US Core resources:
- AllergyIntolerance
- CarePlan
- CareTeam
- Condition
- Coverage
- Device
- DiagnosticReport
- DocumentReference
- Encounter
- Goal
- Immunization
- MedicationDispense
- MedicationRequest
- Observation
- Patient
- Procedure
- QuestionnaireResponse
- RelatedPerson
- ServiceRequest
- If a system receives a provider in
Provenance.agent.who
as free text they must capture who sent them the information as the organization. On request they SHALL provide this organization as the source and MAY include the free text provider.- Systems that need to know the activity has occurred SHOULD populate the activity.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
read
.vread
, history-instance
.create
, search-type
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Provenance/[id]
Conformance Expectation: SHOULD
Resource Specific Documentation:
US Core defines two ways to represent the questions and responses to screening and assessment instruments:
- Observation: US Core Observation Screening Assessment Profile
- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
Supported Profiles:
Profile Interaction Summary:
read
, vread
.create
, search-type
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Questionnaire/[id]
Conformance Expectation: SHOULD
Resource Specific Documentation:
US Core defines two ways to represent the questions and responses to screening and assessment instruments:
- Observation: US Core Observation Screening Assessment Profile
- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
Supported Profiles:
Profile Interaction Summary:
search-type
, read
, vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/QuestionnaireResponse/[id]
GET [base]/QuestionnaireResponse?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | _id | token |
SHALL | patient | reference |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ authored | reference+date |
SHOULD | patient+ status | reference+token |
SHOULD | patient+ questionnaire | reference+reference |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/RelatedPerson/[id]
GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | _id | token |
SHOULD | patient | reference |
SHOULD | name | string |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHOULD | patient+ name | reference+string |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHALL
Resource Specific Documentation:
The Reason or justification for a referral or consultation is communicated through:
ServiceRequest.reason
orServiceRequest.reason
, andProcedure.basedOn
that links the Procedure to the US Core ServiceRequest Profile.
ServiceRequest.reasonCode
andServiceRequest.reasonReference
are marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.- As documented here, when using
ServiceRequest.reasonReference
, the referenced resources SHOULD be a US Core Profile.Procedure.reasonCode
orProcedure.reasonReference
when the Procedure does not have an associated ServiceRequest.
- Although both
Procedure.reasonCode
andProcedure.reasonReference
are marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.- As documented here, when using
Procedure.reasonReference
, the referenced resources SHOULD be a US Core Profile.Certifying Servers and Clients SHALL support options 1 and 2 as Additional USCDI Requirements.
Supported Profiles:
Reference Policy
Profile Interaction Summary:
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/ServiceRequest/[id]
GET [base]/ServiceRequest?[parameter=value]&_revinclude=Provenance:target
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | patient | reference |
SHALL | _id | token |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Types |
---|---|---|
SHALL | patient+ category+ authored | reference+token+date |
SHALL | patient+ category | reference+token |
SHOULD | patient+ code+ authored | reference+token+date |
SHALL | patient+ code | reference+token |
SHOULD | patient+ status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHALL
Supported Profiles:
Reference Policy
Profile Interaction Summary:
read
.vread
, history-instance
.create
, search-type
, update
, patch
, delete
, history-type
.Fetch and Search Criteria:
GET [base]/Specimen/[id]
Search Parameter Summary:
Conformance | Parameter | Type |
---|---|---|
SHALL | _id | token |
SHOULD | patient | reference |
Conformance Expectation: SHOULD
Operation Summary:
If a server supports DocumentReference for creating, using, and sharing clinical notes, it SHOULD also support the context
and contextdirection
parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server.