US-Core CI Build

This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

US Core Server

Formats: XML, JSON, Turtle

US Core Server

(Requirements Definition)

Published: 2016-08-10 (draft)

Published by: U.S. Office of the National Coordinator (ONC)

This profile defines the expected capabilities of the US Core Server actor when conforming to the US-Core IG The statement includes the complete list of actual profiles, RESTful operations, search parameters supported by US Core Servers. US Core Requesters have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

General

FHIR Version: 1.8.0
Accepts elements from future versions: extensions
Supported formats: xml, json
Supported profiles:

US CORE ALLERGYINTOLERANCE

US CORE CAREPLAN

US CORE CARETEAM

US CORE CONDITION

US CORE DEVICE

US CORE GOAL

US CORE IMMUNIZATION

US CORE DIAGNOSTICREPORT

US CORE OBSERVATIONRESULTS

US CORE LOCATION

US CORE MEDICATION

US CORE MEDICATIONREQUEST

US CORE VITALSIGNS

US CORE PATIENT

US CORE PRACT

US CORE PROCEDURE

REST behavior

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 2. Implement REST behavior according to the FHIR specification 3. Support json resource formats for all US Core interactions. 4. Identify the US Core profile(s) supported as part of the FHIR Meta profile attribute for each instance. 5. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.

The US Core Server SHOULD:

1. Support xml resource formats for all US Core interactions.

Security:

US Core Servers SHALL implement the security requirements documented in the US-Core IG.

Profile summary

Profile (Resource) Search Read Read Version Instance History Resource History Create Update Delete
US CORE PATIENT (Patient) SHALL SHALL SHOULD SHOULD
US CORE ALLERGYINTOLERANCE (AllergyIntolerance) SHALL SHALL SHOULD SHOULD
US CORE CAREPLAN (CarePlan) SHALL SHALL SHOULD SHOULD
US CORE CARETEAM (CareTeam) SHALL SHALL SHOULD SHOULD
US CORE CONDITION (Condition) SHALL SHALL SHOULD SHOULD
US CORE DEVICE (Device) SHALL SHALL SHOULD SHOULD
US CORE GOAL (Goal) SHALL SHALL SHOULD SHOULD
US CORE IMMUNIZATION (Immunization) SHALL SHALL SHOULD SHOULD
US CORE DIAGNOSTICREPORT (DiagnosticReport) SHALL SHALL SHOULD SHOULD
US CORE OBSERVATIONRESULTS (Observation) SHALL SHALL SHOULD SHOULD
US CORE MEDICATION (Medication) SHOULD SHOULD SHOULD SHOULD
US CORE MEDICATIONSTATEMENT (MedicationStatement) SHALL SHALL SHOULD SHOULD
US CORE MEDICATIONREQUEST (MedicationRequest) SHALL SHALL SHOULD SHOULD
US CORE SMOKINGSTATUS (Observation) SHALL SHALL SHOULD SHOULD
US CORE VITALSIGNS (Observation) SHALL SHALL SHOULD SHOULD
US CORE PROCEDURE (Procedure) SHALL SHALL SHOULD SHOULD


Patient

Profile: US CORE PATIENT

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core patient resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core patients by id

  history-instance SHOULD

Allows review of changes to US Core patient instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core patient instance

Search

Parameter Conformance Type Definition & Chaining
name SHALL string

todo

family SHALL string
given SHALL string
identifier SHALL token
gender SHALL token
birthdate SHALL date


AllergyIntolerance

Profile: US CORE ALLERGYINTOLERANCE

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core AllergyIntolerance resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core AllergyIntolerance by id

  history-instance SHOULD

Allows review of changes to US Core AllergyIntolerance instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core AllergyIntolerance instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference


CarePlan

Profile: US CORE CAREPLAN

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core careplan resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core careplan by id

  history-instance SHOULD

Allows review of changes to US Core careplan instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core careplan instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
category SHALL token
status SHALL token
date SHALL date

The server SHALL support the date search modifiers 'ge','le','eq' for this profile



CareTeam

Profile: US CORE CARETEAM

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core careteam resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core careteam by id

  history-instance SHOULD

Allows review of changes to US Core careteam instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core careteam instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
status SHALL token


Condition

Profile: US CORE CONDITION

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core condition resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core condition by id

  history-instance SHOULD

Allows review of changes to US Core condition instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core condition instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
category SHALL token
clinicalstatus SHALL token


Device

Profile: US CORE DEVICE

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core device resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core device by id

  history-instance SHOULD

Allows review of changes to US Core device instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core device instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference


Goal

Profile: US CORE GOAL

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core Goal resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core Goal by id

  history-instance SHOULD

Allows review of changes to US Core Goal instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core Goal instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
date SHALL date

The server SHALL support the date search modifiers 'ge','le','eq' for this profile



Immunization

Profile: US CORE IMMUNIZATION

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core immunization resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core immunization by id

  history-instance SHOULD

Allows review of changes to US Core immunization instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core immunization instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference


DiagnosticReport

Profile: US CORE DIAGNOSTICREPORT

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core diagnosticreport resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core diagnosticreport by id

  history-instance SHOULD

Allows review of changes to US Core diagnosticreport instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core diagnosticreport instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
category SHALL token
code SHALL token
date SHALL date

The server SHALL support the date search modifiers 'ge','le','eq' for this profile



Observation

Profile: US CORE OBSERVATIONRESULTS

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core observation results resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core observation results by id

  history-instance SHOULD

Allows review of changes to US Core observation results instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core observation results instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
category SHALL token
code SHALL token
date SHALL date

The server SHALL support the date search modifiers 'ge','le','eq' for this profile



Medication

Profile: US CORE MEDICATION

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

Interactions

Name Conformance Description
  search-type SHOULD

IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows discovery of existing US Core Medication resources using different search criteria.

  read SHOULD

IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows retrieval of a specific US Core Medication by id

  history-instance SHOULD

Allows review of changes to US Core Medication instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core Medication instance



MedicationStatement

Profile: US CORE MEDICATIONSTATEMENT

The MedicationStatement and MedicationRequest resources can represent a medication, using either a code or refer to a Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. The server application can choose any one way or more than one method, but if the an external reference to Medication is used, the server SHALL support the include parameter for searching this element. The client application must support both methods.

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core medicationstatement resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core medicationstatement by id

  history-instance SHOULD

Allows review of changes to US Core medicationstatement instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core medicationstatement instance

Search

Supported Includes: MedicationStatement.medicationReference

Parameter Conformance Type Definition & Chaining
patient SHALL reference


MedicationRequest

Profile: US CORE MEDICATIONREQUEST

The MedicationStatement and MedicationRequest resources can represent a medication, using either a code or refer to a Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. The server application can choose any one way or more than one method, but if the an external reference to Medication is used, the server SHALL support the include parameter for searching this element. The client application must support both methods.

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core medicationrequest resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core medicationrequest by id

  history-instance SHOULD

Allows review of changes to US Core medicationrequest instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core medicationrequest instance

Search

Supported Includes: MedicationRequest.medicationReference

Parameter Conformance Type Definition & Chaining
patient SHALL reference


Observation

Profile: US CORE SMOKINGSTATUS

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core smokingstatus resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core smokingstatus by id

  history-instance SHOULD

Allows review of changes to US Core smokingstatus instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core smokingstatus instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
code SHALL token


Observation

Profile: US CORE VITALSIGNS

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core vitalsigns resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core vitalsigns by id

  history-instance SHOULD

Allows review of changes to US Core vitalsigns instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core vitalsigns instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
category SHALL token
code SHALL token
date SHALL date

The server SHALL support the date search modifiers 'ge','le','eq' for this profile



Procedure

Profile: US CORE PROCEDURE

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing US Core procedure resources using different search criteria

  read SHALL

Allows retrieval of a specific US Core procedure by id

  history-instance SHOULD

Allows review of changes to US Core procedure instance over time

  vread SHOULD

Allows retrieval of a historical version of a US Core procedure instance

Search

Parameter Conformance Type Definition & Chaining
patient SHALL reference
date SHALL date

The server SHALL support the date search modifiers 'ge','le','eq' for this profile