US Core Requestor
(Requirements Definition)
Published: 2015-04-02 (draft)
Published by: U.S. Office of the National Coordinator (ONC)
This profile defines the expected capabilities of the US Core Requestor actor when conforming to the US Core IG.
General
FHIR Version: |
1.8.0 |
Accepts elements from future versions: |
extensions |
Supported formats: |
xml, json |
REST behavior
The US Core Requestor SHOULD support querying of one or more FHIR resources using appropriate US Core profile(s), RESTful operations defined for the profile and Search parameters identified for the profile.
Security:
US Core Requestors SHALL implement applicable security requirements documented in the US Core IG.
Profile summary
Operations:
patient-everything SHOULD
Patient
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core patient resources using different search criteria
|
read
|
SHOULD |
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
|
AllergyIntolerance
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core AllergyIntolerance resources using different search criteria
|
read
|
SHOULD |
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
|
CarePlan
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core careplan resources using different search criteria
|
read
|
SHOULD |
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
|
CarePlan
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core careteam resources using different search criteria
|
read
|
SHOULD |
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
|
Condition
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core condition resources using different search criteria
|
read
|
SHOULD |
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
|
Device
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core device resources using different search criteria
|
read
|
SHOULD |
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
|
Goal
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core goal resources using different search criteria
|
read
|
SHOULD |
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
|
Immunization
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core immunization resources using different search criteria
|
read
|
SHOULD |
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
|
DiagnosticReport
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core diagnosticreport resources using different search criteria
|
read
|
SHOULD |
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
|
Observation
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core resultobs resources using different search criteria
|
read
|
SHOULD |
Allows retrieval of a specific US Core resultobs by id
|
history-instance
|
SHOULD |
Allows review of changes to US Core resultobs instance over time
|
vread
|
SHOULD |
Allows retrieval of a historical version of a US Core resultobs instance
|
Medication
Profile:
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:
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. include: http://hl7.org/fhir/2017Jan/search.html#include contained: http://hl7.org/fhir/2017Jan/references.html#contained Medication:http://hl7.org/fhir/2017Jan/medication.html
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core medicationstatement resources using different search criteria
|
read
|
SHOULD |
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
|
MedicationRequest
Profile:
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. include: http://hl7.org/fhir/2017Jan/search.html#include contained: http://hl7.org/fhir/2017Jan/references.html#contained Medication:http://hl7.org/fhir/2017Jan/medication.html
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core medicationorder resources using different search criteria
|
read
|
SHOULD |
Allows retrieval of a specific US Core medicationorder by id
|
history-instance
|
SHOULD |
Allows review of changes to US Core medicationorder instance over time
|
vread
|
SHOULD |
Allows retrieval of a historical version of a US Core medicationorder instance
|
Observation
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core smokingstatus resources using different search criteria
|
read
|
SHOULD |
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
|
Observation
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core vitalsigns resources using different search criteria
|
read
|
SHOULD |
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
|
Procedure
Profile:
Interactions
Name |
Conformance |
Description |
search-type
|
SHOULD |
Allows discovery of existing US Core procedure resources using different search criteria
|
read
|
SHOULD |
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
|