Qi-Core Implementation Guide (Release 2.1 Trial-Use Ballot)

This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-referralrequest

Examples:

Referral for Procedure 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-referralrequest

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

This profile builds on ReferralRequest.

This profile was published on Mon Aug 21 00:00:00 AEST 2017 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*A request for referral or transfer of care
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... referralrequest-reasonRefused I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/referralrequest-reasonRefused
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... definition Σ0..*Reference(ActivityDefinition), Reference(PlanDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(ReferralRequest), Reference(CarePlan), Reference(ProcedureRequest)Request fulfilled by this request
... replaces Σ0..*Reference(ReferralRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... type SΣ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example)
... priority SΣ0..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required)
... serviceRequested SΣ0..*CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... subject SΣ1..1Reference(QICore-Patient), Reference(Group)Patient referred to care or transfer
... context SΣ0..1Reference(QICore-ReferralRequest), Reference(EpisodeOfCare)Originating encounter
... occurrence[x] SΣ0..1dateTime, PeriodWhen the service(s) requested in the referral should occur
... authoredOn SΣ0..1dateTimeDate of creation/activation
... requester SΣI0..1BackboneElementWho/what is requesting service
.... 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(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson), Reference(Device)Individual making the request
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... specialty S0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient SΣ0..*Reference(QICore-Practitioner), Reference(QICore-Organization)Receiver of referral / transfer of care request
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Why is service needed?
... description 0..1stringA textual description of the referral
... supportingInfo 0..*Reference(Resource)Additonal information to support referral or transfer of care request
... note 0..*AnnotationComments made about referral request
... relevantHistory 0..*Reference(Provenance)Key events in history of request

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*A request for referral or transfer of care
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... referralrequest-reasonRefused I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/referralrequest-reasonRefused
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... definition Σ0..*Reference(ActivityDefinition), Reference(PlanDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(ReferralRequest), Reference(CarePlan), Reference(ProcedureRequest)Request fulfilled by this request
... replaces Σ0..*Reference(ReferralRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... type SΣ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example)
... priority SΣ0..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required)
... serviceRequested SΣ0..*CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... subject SΣ1..1Reference(QICore-Patient), Reference(Group)Patient referred to care or transfer
... context SΣ0..1Reference(QICore-ReferralRequest), Reference(EpisodeOfCare)Originating encounter
... occurrence[x] SΣ0..1dateTime, PeriodWhen the service(s) requested in the referral should occur
... authoredOn SΣ0..1dateTimeDate of creation/activation
... requester SΣI0..1BackboneElementWho/what is requesting service
.... 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(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson), Reference(Device)Individual making the request
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... specialty S0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient SΣ0..*Reference(QICore-Practitioner), Reference(QICore-Organization)Receiver of referral / transfer of care request
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Why is service needed?
... description 0..1stringA textual description of the referral
... supportingInfo 0..*Reference(Resource)Additonal information to support referral or transfer of care request
... note 0..*AnnotationComments made about referral request
... relevantHistory 0..*Reference(Provenance)Key events in history of request

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
ReferralRequest.languageCommon LanguagesextensibleCommon Languages
ReferralRequest.statusRequestStatusrequiredRequestStatus
ReferralRequest.intentRequestIntentrequiredRequestIntent
ReferralRequest.typeSNOMED CT Patient ReferralexampleSNOMED CT Patient Referral
ReferralRequest.priorityRequestPriorityrequiredRequestPriority
ReferralRequest.serviceRequestedPractice Setting Code Value SetexamplePractice Setting Code Value Set
ReferralRequest.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
ReferralRequest.reasonCodeSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ReferralRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ReferralRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ReferralRequestIf 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-3ReferralRequestIf 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-1ReferralRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ReferralRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ReferralRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ReferralRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ReferralRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
rfr-1ReferralRequest.requesteronBehalfOf can only be specified if agent is practitioner or device
: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()