QI-Core Implementation Guide: STU 3.2 (v3.2.0 for FHIR 3.0.1)

This page is part of the Quality Improvement Core Framework (v3.2.0: STU 3) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 7.0.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-qicore-procedurerequest

Examples:

Request for Appendectomy Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedurerequest

Profile of ProcedureRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on ProcedureRequest.

This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*A request for a procedure or diagnostic to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... procedurerequest-reasonRefused I0..1CodeableConceptReason for refusal
URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-reasonRefused
... procedurerequest-approachBodySite I0..*Reference(BodySite)The requested access point or points used for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-approachBodySite
... qicore-procedurerequest-appropriatenessScore 0..1code, decimalExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedurerequest-appropriatenessScore
Binding: RAND Appropriateness Scores (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(Resource)What request fulfills
... replaces Σ0..*Reference(Resource)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if procedure should not be performed
... category Σ0..*CodeableConceptClassification of procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code SΣ1..1CodeableConceptWhat is being requested/ordered
Binding: US Core Procedure Codes (preferred)
... subject SΣ1..1Reference(QICore-Patient)Individual the service is ordered for
... context SΣ0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which request was created
... occurrence[x] SΣ0..1dateTime, Period, TimingWhen procedure should occur
... asNeeded[x] SΣ0..1boolean, CodeableConceptPreconditions for procedure or diagnostic
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... authoredOn SΣ0..1dateTimeDate request signed
... requester ΣI0..1BackboneElementWho/what is requesting procedure or diagnostic
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(QICore-Device | QICore-Practitioner | QICore-Organization)Individual making the request
.... onBehalfOf Σ0..1Reference(Organization)Organization agent is acting for
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..1Reference(QICore-Practitioner | QICore-Organization | QICore-Patient | QICore-Device | QICore-RelatedPerson | HealthcareService)Requested perfomer
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for test
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition | Observation)Explanation/Justification for test
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite SΣ0..*CodeableConceptLocation on Body
Binding: SNOMED CT Body Structures (example)
... note 0..*AnnotationComments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*A request for a procedure or diagnostic to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... procedurerequest-reasonRefused I0..1CodeableConceptReason for refusal
URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-reasonRefused
... procedurerequest-approachBodySite I0..*Reference(BodySite)The requested access point or points used for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-approachBodySite
... qicore-procedurerequest-appropriatenessScore 0..1code, decimalExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedurerequest-appropriatenessScore
Binding: RAND Appropriateness Scores (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(Resource)What request fulfills
... replaces Σ0..*Reference(Resource)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if procedure should not be performed
... category Σ0..*CodeableConceptClassification of procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code SΣ1..1CodeableConceptWhat is being requested/ordered
Binding: US Core Procedure Codes (preferred)
... subject SΣ1..1Reference(QICore-Patient)Individual the service is ordered for
... context SΣ0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which request was created
... occurrence[x] SΣ0..1dateTime, Period, TimingWhen procedure should occur
... asNeeded[x] SΣ0..1boolean, CodeableConceptPreconditions for procedure or diagnostic
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... authoredOn SΣ0..1dateTimeDate request signed
... requester ΣI0..1BackboneElementWho/what is requesting procedure or diagnostic
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(QICore-Device | QICore-Practitioner | QICore-Organization)Individual making the request
.... onBehalfOf Σ0..1Reference(Organization)Organization agent is acting for
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..1Reference(QICore-Practitioner | QICore-Organization | QICore-Patient | QICore-Device | QICore-RelatedPerson | HealthcareService)Requested perfomer
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for test
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition | Observation)Explanation/Justification for test
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite SΣ0..*CodeableConceptLocation on Body
Binding: SNOMED CT Body Structures (example)
... note 0..*AnnotationComments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ProcedureRequest.statusrequiredRequestStatus
ProcedureRequest.codepreferredUS Core Procedure Codes
ProcedureRequest.asNeeded[x]exampleSNOMED CT Medication As Needed Reason Codes
ProcedureRequest.reasonCodeexampleProcedure Reason Codes
ProcedureRequest.bodySiteexampleSNOMED CT Body Structures

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ProcedureRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ProcedureRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ProcedureRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ProcedureRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1ProcedureRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())