US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure | Version: 8.0.0 | |||
Standards status: Trial-use | Computable Name: USCoreProcedureProfile | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.52 | ||||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
The US Core Procedure Profile inherits from the FHIR Procedure resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Procedures Data Class. It sets minimum expectations for the Procedure resource to record, search, and fetch procedure information associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each Procedure Must Have:
Each Procedure Must Support:
Additional USCDI Requirements:
This Additional USCDI Requirements element is not Mandatory or Must Support but is required for ONC Health IT certification testing and is included in the formal definition of the profile and the Procedure examples.
*see guidance below
Profile Specific Implementation Guidance:
Procedure.performed
is mandatory if Procedure.status
is "completed" or "in-progress".Procedure.code
has an additional binding of "current" and a base "preferred" binding.
Procedure.focalDevice
referencing the US Core Implantable Device Profile.See the Screening and Assessments guidance page for more information when exchanging Social Determinants of Health (SDOH) Procedures
Procedure.basedOn
linking the Procedure to the US Core ServiceRequest Profile that includes either ServiceRequest.reasonCode
or ServiceRequest.reasonReference
. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's Procedure.reasonCode
or Procedure.reasonReference
. Depending on the procedure being documented, a Server will select the appropriate Profile to use.
Procedure.reasonCode
and Procedure.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.
Procedure.reasonReference
:
Procedure.reasonReference
. Clients SHALL support all target resources in Procedure.reasonReference
.Usage:
Changes since version 7.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to procedure data SHALL support these US Core SMART Scopes:
<patient|user|system>/Procedure.rs
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching for all procedures for a patient using the patient
search parameter:
GET [base]/Procedure?patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Procedure resources for the specified patient (how to search by reference)
SHALL support searching using the combination of the patient
and date
search parameters:
date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/Procedure?patient={Type/}[id]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Procedure resources for the specified patient and date (how to search by reference and how to search by token)
The following search parameter combinations SHOULD be supported:
patient
and status
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/Procedure?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Procedure resources for the specified patient and status (how to search by reference and how to search by token)
patient
and code
and date
search parameters:
code
(e.g.code={system|}[code],{system|}[code],...
)date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/Procedure?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Procedure resources for the specified patient and date and procedure code(s). SHOULD support search by multiple codes. (how to search by reference and how to search by token and how to search by date)