STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. 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

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-referralrequest

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*A request for referral or transfer of care
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
Binding: Reasons for rejecting a referral request (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... basedOn 0..*Reference(ReferralRequest | CarePlan | DiagnosticRequest | ProcedureRequest)Request fulfilled by this request
... parent ∑0..1IdentifierComposite request this is part of
... status ?!S1..1codedraft | active | cancelled | completed | entered-in-error
Binding: ReferralStatus (required)
... category ?!∑1..1codeproposal | plan | request
Binding: ReferralCategory (required)
... type S0..1CodeableConceptReferral/Transition of care request type
Binding: (unbound) (example)
... priority S0..1CodeableConceptUrgency of referral / transfer of care request
Binding: SNOMED CT Priorities Codes (preferred)
... patient S0..1Reference(Profile qicore-patient)Information about an individual or animal receiving health care services
... context S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... fulfillmentTime S0..1PeriodRequested service(s) fulfillment time
... authored S0..1dateTimeDate of creation/activation
... requester S0..1Reference(Profile qicore-practitioner | Profile qicore-organization | Profile qicore-patient)Requester of referral / transfer of care
... specialty S0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient S0..*Reference(Profile qicore-practitioner | Profile qicore-organization)Receiver of referral / transfer of care request
... reason S0..1CodeableConceptReason for referral / transfer of care request
Binding: (unbound) (example)
... description 0..1stringA textual description of the referral
... serviceRequested S0..*CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... supportingInformation ∑0..*Reference(Resource)Additonal information to support referral or transfer of care request

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*A request for referral or transfer of care
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
Binding: Reasons for rejecting a referral request (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... basedOn 0..*Reference(ReferralRequest | CarePlan | DiagnosticRequest | ProcedureRequest)Request fulfilled by this request
... parent ∑0..1IdentifierComposite request this is part of
... status ?!S1..1codedraft | active | cancelled | completed | entered-in-error
Binding: ReferralStatus (required)
... category ?!∑1..1codeproposal | plan | request
Binding: ReferralCategory (required)
... type S0..1CodeableConceptReferral/Transition of care request type
Binding: (unbound) (example)
... priority S0..1CodeableConceptUrgency of referral / transfer of care request
Binding: SNOMED CT Priorities Codes (preferred)
... patient S0..1Reference(Profile qicore-patient)Information about an individual or animal receiving health care services
... context S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... fulfillmentTime S0..1PeriodRequested service(s) fulfillment time
... authored S0..1dateTimeDate of creation/activation
... requester S0..1Reference(Profile qicore-practitioner | Profile qicore-organization | Profile qicore-patient)Requester of referral / transfer of care
... specialty S0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient S0..*Reference(Profile qicore-practitioner | Profile qicore-organization)Receiver of referral / transfer of care request
... reason S0..1CodeableConceptReason for referral / transfer of care request
Binding: (unbound) (example)
... description 0..1stringA textual description of the referral
... serviceRequested S0..*CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... supportingInformation ∑0..*Reference(Resource)Additonal information to support referral or transfer of care request

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
ReferralRequest.languageCommon LanguagesextensibleCommon Languages
ReferralRequest.extension
http://hl7.org/fhir/StructureDefinition/referralrequest-reasonRefused		Reasons for rejecting a referral requestexampleReasons for rejecting a referral request
ReferralRequest.statusReferralStatusrequiredReferralStatus
ReferralRequest.categoryReferralCategoryrequiredReferralCategory
ReferralRequest.type?extexample
ReferralRequest.prioritySNOMED CT Priorities CodespreferredSNOMED CT Priorities Codes
ReferralRequest.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
ReferralRequest.reason?extexample
ReferralRequest.serviceRequestedPractice Setting Code Value SetexamplePractice Setting Code Value Set

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ReferralRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ReferralRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ReferralRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ReferralRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1ReferralRequest.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1ReferralRequest.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.