US Core Implementation Guide
3.2.0 - ballot

This page is part of the US Core (v3.2.0: STU4 Ballot 1) 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

CapabilityStatement: US Core Server CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

US Core Server CapabilityStatement

  • Implementation Guide Version: 3.1.1
  • FHIR Version: 4.0.1
  • Supported formats: xml, json
  • Published: 2020-11-20
  • Published by: HL7 International - US Realm Steering Committee

This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and and the ONC U.S. Core Data for Interoperability (USCDI). 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 Server SHALL:

  1. Support the US Core Patient resource profile.
  2. Support at least one additional resource profile from the list of US Core Profiles.
  3. Implement the RESTful behavior according to the FHIR specification.
  4. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scopes
    • (Status 404): unknown resource
  5. Support json source formats for all US Core interactions.

The US Core Server SHOULD:

  1. Support xml source formats for all US Core interactions.
  2. Identify the US Core profiles supported as part of the FHIR meta.profile attribute for each instance.
  3. Support xml resource formats for all Argonaut questionnaire interactions.

Security:

  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

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 _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, patient+category+status, patient+category+date, patient+category+status+date Provenance:target
CareTeam US Core CareTeam Profile patient, status patient+status Provenance:target
Condition US Core Condition Profile category, clinical-status, patient, onset-date, code patient+category, patient+code, patient+clinical-status, patient+onset-date Provenance:target
Device US Core Implantable Device Profile patient, type patient+type Provenance:target
DiagnosticReport US Core DiagnosticReport Profile for Laboratory Results Reporting, US Core DiagnosticReport Profile for Report and Note exchange status, patient, category, code, date patient+category+date, patient+code, patient+status, patient+code+date, patient+category Provenance:target
DocumentReference US Core DocumentReference Profile _id, status, patient, category, type, date, period patient+category+date, patient+type+period, patient+type, patient+status, patient+category Provenance:target docref
Encounter US Core Encounter Profile _id, class, date, identifier, patient, status, type date+patient, class+patient, patient+status, patient+type Provenance:target
Goal US Core Goal Profile lifecycle-status, patient, target-date patient+target-date, patient+lifecycle-status Provenance:target
Immunization US Core Immunization Profile patient, status, date patient+date, patient+status Provenance:target
Location US Core Location Profile name, address, address-city, address-state, address-postalcode
Medication US Core Medication Profile
MedicationRequest US Core MedicationRequest Profile status, intent, patient, encounter, authoredon patient+intent+authoredon, patient+intent, patient+intent+status, patient+intent+encounter MedicationRequest:medication Provenance:target
Observation US Core Laboratory Result Observation Profile, US Core Vital Signs Profile, US Core Blood Pressure Profile, US Core BMI Profile, US Core Head Circumference Profile, US Core Body Height Profile, US Core Body Weight Profile, US Core Body Temperature Profile, US Core Heart Rate Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pediatric Head Occipital-frontal Circumference Percentile Profile, US Core Pediatric Weight for Height Observation Profile, US Core Pulse Oximetry Profile, US Core Respiratory Rate Profile, US Core Smoking Status Observation Profile status, category, code, date, patient patient+category+date, patient+code, patient+category+status, patient+code+date, patient+category Provenance:target
Organization US Core Organization Profile name, address
Patient US Core Patient Profile _id, birthdate, family, gender, given, identifier, name family+gender, gender+name, birthdate+name, birthdate+family Provenance:target
Practitioner US Core Practitioner Profile 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
ValueSet expand

AllergyIntolerance

Conformance Expectation: SHALL

Supported Profiles: US Core AllergyIntolerance Profile

Reference Policy: resolves

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 Server SHALL be capable of returning a AllergyIntolerance resource using: GET [base]/AllergyIntolerance/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY clinical-status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+clinical-status reference+token

CarePlan

Conformance Expectation: SHALL

Supported Profiles: US Core CarePlan Profile

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

Reference Policy: resolves

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 Server SHALL be capable of returning a CarePlan resource using: GET [base]/CarePlan/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY category token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.
MAY patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHALL patient+category reference+token
SHOULD patient+category+status reference+token+token
SHOULD patient+category+date reference+token+date
SHOULD patient+category+status+date reference+token+token+date

CareTeam

Conformance Expectation: SHALL

Supported Profiles: US Core CareTeam Profile

Reference Policy: resolves

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 Server SHALL be capable of returning a CareTeam resource using: GET [base]/CareTeam/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHALL patient+status reference+token

Condition

Conformance Expectation: SHALL

Supported Profiles: US Core Condition Profile

Reference Policy: resolves

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 Server SHALL be capable of returning a Condition resource using: GET [base]/Condition/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY category token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY clinical-status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY onset-date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.
MAY code token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+category reference+token
SHOULD patient+code reference+token
SHOULD patient+clinical-status reference+token
SHOULD patient+onset-date reference+date

Device

Conformance Expectation: SHALL

Supported Profiles: US Core Implantable Device Profile

Resource Specific Documentation:

  • Implantable medical devices that have UDI information SHALL represent this information in either carrierAIDC or carrierHRF.
    • UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants.
    • Servers are not required to support both carrierAIDC and carrierHR.

  • For Implantable medical devices that have UDI information, at least one of the Production Identifiers (UDI-PI) SHALL be present.

  • 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.

  • In the [Quick Start] section below, searching for all devices is described. Records of implanted devices MAY be queried against UDI data including:

    • UDI HRF string (udi-carrier)
    • UDI Device Identifier (udi-di)
    • Manufacturer (manufacturer)
    • Model number (model)

    Implementers MAY also adopt custom SearchParameters for searching by:

    • lot numbers
    • serial number
    • expiration date
    • manufacture date
    • distinct identifier

Reference Policy: resolves

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 Server SHALL be capable of returning a Device resource using: GET [base]/Device/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Device?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY type token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+type reference+token

DiagnosticReport

Conformance Expectation: SHALL

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

Reference Policy: resolves

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 Server SHALL be capable of returning a DiagnosticReport resource using: GET [base]/DiagnosticReport/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY category token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY code token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHALL patient+category+date reference+token+date
SHALL patient+code reference+token
SHOULD patient+status reference+token
SHOULD patient+code+date reference+token+date
SHALL patient+category reference+token

DocumentReference

Conformance Expectation: SHALL

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

Reference Policy: resolves

Profile Interaction Summary:

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

Operation Summary:

  • SHALL support the $docref operation

    A server SHALL be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. MAY provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server SHALL provide references to last or current encounter. SHOULD document what resources, if any, are returned as included resources

    GET [base]/DocumentReference/$docref?patient=[id]

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a DocumentReference resource using: GET [base]/DocumentReference/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL _id token -
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY category token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY type token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.
MAY period date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHALL patient+category+date reference+token+date
SHOULD patient+type+period reference+token+date
SHALL patient+type reference+token
SHOULD patient+status reference+token
SHALL patient+category reference+token

Encounter

Conformance Expectation: SHALL

Supported Profiles: US Core Encounter Profile

Resource Specific Documentation:

  • The Encounter resource can represent a reason using either a code with Encounter.reasonCode, or a reference with Encounter.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 intent of this profile is to support where the encounter occurred. The location address can be represented by either by the Location referenced by Encounter.location.location or indirectly through the Organization referenced by Encounter.serviceProvider.
    • Although both are marked as must support, the server systems are not required to support both Encounter.location.location and Encounter.serviceProvider, but they SHALL support at least one of these elements.
    • The client application SHALL support both elements.
    • if using Encounter.locatison.location it SHOULD conform to US Core Location. However, as a result of implementation feedback, it MAY reference the base FHIR Location resource. See this guidance on [Referencing US Core Profiles]

Reference Policy: resolves

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 Server SHALL be capable of returning a Encounter resource using: GET [base]/Encounter/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL _id token -
MAY class token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.
SHOULD identifier token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY type token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHALL date+patient date+reference
SHOULD class+patient token+reference
SHOULD patient+status reference+token
SHOULD patient+type reference+token

Goal

Conformance Expectation: SHALL

Supported Profiles: US Core Goal Profile

Reference Policy: resolves

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 Server SHALL be capable of returning a Goal resource using: GET [base]/Goal/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY lifecycle-status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY target-date date

A client SHALL provide a value precise to the day.

A server SHALL support a value a value precise to the day.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+target-date reference+date
SHOULD patient+lifecycle-status reference+token

Immunization

Conformance Expectation: SHALL

Supported Profiles: US Core Immunization Profile

Resource Specific Documentation:

  • Based upon the ONC U.S. Core Data for Interoperability (USCDI) v1 requirements, CVX vaccine codes are required and the NDC vaccine codes SHOULD be supported as translations to them.

Reference Policy: resolves

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 Server SHALL be capable of returning a Immunization resource using: GET [base]/Immunization/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+date reference+date
SHOULD patient+status reference+token

Location

Conformance Expectation: SHALL

Supported Profiles: US Core Location Profile

Resource Specific Documentation:

  • The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they SHOULD be used as the default profile if referenced by another US Core profile.

Reference Policy: resolves

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 Server SHALL be capable of returning a Location resource using: GET [base]/Location/[id]

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL name string -
SHALL address string -
SHOULD address-city string -
SHOULD address-state string -
SHOULD address-postalcode string -

Medication

Conformance Expectation: SHALL

Supported Profiles: US Core Medication Profile

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.

Reference Policy: resolves

Profile Interaction Summary:

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

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Medication resource using: GET [base]/Medication/[id]

MedicationRequest

Conformance Expectation: SHALL

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

  • 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 using MedicationRequest.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.

Reference Policy: resolves

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 Server SHALL be capable of returning a MedicationRequest resource using: GET [base]/MedicationRequest/[id]
  • A Server SHOULD be capable of supporting the following _includes: MedicationRequest:medication - GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY intent token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY encounter reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY authoredon date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+intent+authoredon reference+token+date
SHALL patient+intent reference+token
SHALL patient+intent+status reference+token+token
SHOULD patient+intent+encounter reference+token+reference

Observation

Conformance Expectation: SHALL

Supported Profiles: US Core Laboratory Result Observation Profile, US Core Vital Signs Profile, US Core Blood Pressure Profile, US Core BMI Profile, US Core Head Circumference Profile, US Core Body Height Profile, US Core Body Weight Profile, US Core Body Temperature Profile, US Core Heart Rate Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pediatric Head Occipital-frontal Circumference Percentile Profile, US Core Pediatric Weight for Height Observation Profile, US Core Pulse Oximetry Profile, US Core Respiratory Rate Profile, US Core Smoking Status Observation Profile

Resource Specific Documentation:

  • Systems SHOULD support Observation.effectivePeriod to accurately represent laboratory 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.

Reference Policy: resolves

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 Server SHALL be capable of returning a Observation resource using: GET [base]/Observation/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY category token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY code token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.
MAY patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

Search Parameter Combination Summary:

Conformance Parameter Combination Types
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
SHALL patient+category reference+token

Organization

Conformance Expectation: SHALL

Supported Profiles: US Core Organization Profile

Reference Policy: resolves

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 Server SHALL be capable of returning a Organization resource using: GET [base]/Organization/[id]

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL name string -
SHALL address string -

Patient

Conformance Expectation: SHALL

Supported Profiles: US Core Patient Profile

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.
  1. contact detail (e.g. a telephone number or an email address)
  2. a communication language
  3. a race
  4. an ethnicity
  5. a birth sex*
  6. previous name
    • Previous name is represented by providing an end date in the Patient.name.period element for a previous name.
  7. suffix
    • Suffix is represented using the Patient.name.suffix element.

Reference Policy: resolves

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 Server SHALL be capable of returning a Patient resource using: GET [base]/Patient/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL _id token -
MAY birthdate date

A client SHALL provide a value precise to the day.

A server SHALL support a value a value precise to the day.
MAY family string
  • A server SHALL support a value precise to the day.
MAY gender token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
MAY given string -
SHALL identifier token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL name string -

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD family+gender string+token
SHALL gender+name token+string
SHALL birthdate+name date+string
SHOULD birthdate+family date+string

Practitioner

Conformance Expectation: SHALL

Supported Profiles: US Core Practitioner Profile

Reference Policy: resolves

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 Server SHALL be capable of returning a Practitioner resource using: GET [base]/Practitioner/[id]

Search Parameter Summary:

Conformance Parameter Type Documentation
SHALL name string -
SHALL identifier token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

PractitionerRole

Conformance Expectation: SHALL

Supported Profiles: US Core PractitionerRole Profile

Resource Specific Documentation:

  • The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they SHOULD be used as the default profile if referenced by another US Core profile.

Reference Policy: resolves

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 Server SHALL be capable of returning a PractitionerRole resource using: GET [base]/PractitionerRole/[id]
  • A Server 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 Documentation
SHALL specialty token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL practitioner reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

Procedure

Conformance Expectation: SHALL

Supported Profiles: US Core Procedure Profile

Resource Specific Documentation:

  • A procedure including an implantable device SHOULD use Procedure.focalDevice with a reference to the [US Core Implantable Device Profile].

Reference Policy: resolves

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 Server SHALL be capable of returning a Procedure resource using: GET [base]/Procedure/[id]
  • A Server SHALL be capable of supporting the following _revincludes: Provenance:target - GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Documentation
MAY status token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.
SHALL patient reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.
MAY date date

A client SHALL provide a value precise to the second + time offset.

A server SHALL support a value precise to the second + time offset.
MAY code token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

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

Provenance

Conformance Expectation: SHALL

Supported Profiles: US Core Provenance Profile

Resource Specific Documentation:

  • 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.

Reference Policy: resolves

Profile Interaction Summary:

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

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Provenance resource using: GET [base]/Provenance/[id]

ValueSet

Conformance Expectation: SHOULD

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.