INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-ReferralRequest-1

Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

The official URL for this profile is: 

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-ReferralRequest-1

Formal Views of Profile Content

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

This structure is derived from ReferralRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*ReferralRequest
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... Extension-CareConnect-ReferralRequestMethod-1 0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
... Extension-CareConnect-SourceOfReferral-1 0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... basedOn 0..*Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)
... replaces 0..*Reference(CareConnect-ReferralRequest-1)
... groupIdentifier
.... assigner 0..1Reference(CareConnect-Organization-1)
... subject 1..1Reference(Group | CareConnect-Patient-1)
... context 0..1Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)
... requester
.... agent 1..1Reference(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... onBehalfOf 0..1Reference(CareConnect-Organization-1)
... recipient 0..*Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1)
... reasonReference 0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)
... note
.... author[x] 0..1
..... authorStringstring
..... authorReferenceReference(CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*ReferralRequestA 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)
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
... Extension-CareConnect-ReferralRequestMethod-1 I0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
... Extension-CareConnect-SourceOfReferral-1 I0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... replaces Σ0..*Reference(CareConnect-ReferralRequest-1)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example)
... priority Σ0..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required)
... serviceRequested Σ0..*CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... subject Σ1..1Reference(Group | CareConnect-Patient-1)Patient referred to care or transfer
... context Σ0..1Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)Originating encounter
... occurrence[x] Σ0..1When the service(s) requested in the referral should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeDate of creation/activation
... requester ΣI0..1BackboneElementWho/what is requesting service
rfr-1: onBehalfOf can only be specified if agent is practitioner or device
.... 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(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)Individual making the request
.... onBehalfOf ΣI0..1Reference(CareConnect-Organization-1)Organization agent is acting for
... specialty 0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient Σ0..*Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1)Receiver of referral / transfer of care request
... reasonCode Σ0..*CodeableConceptReason for referral / transfer of care request
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorStringstring
..... authorReferenceReference(CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... relevantHistory 0..*Reference(Provenance)Key events in history of request

doco Documentation for this format

Differential View

This structure is derived from ReferralRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*ReferralRequest
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... Extension-CareConnect-ReferralRequestMethod-1 0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
... Extension-CareConnect-SourceOfReferral-1 0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... basedOn 0..*Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)
... replaces 0..*Reference(CareConnect-ReferralRequest-1)
... groupIdentifier
.... assigner 0..1Reference(CareConnect-Organization-1)
... subject 1..1Reference(Group | CareConnect-Patient-1)
... context 0..1Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)
... requester
.... agent 1..1Reference(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... onBehalfOf 0..1Reference(CareConnect-Organization-1)
... recipient 0..*Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1)
... reasonReference 0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)
... note
.... author[x] 0..1
..... authorStringstring
..... authorReferenceReference(CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*ReferralRequestA 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)
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
... Extension-CareConnect-ReferralRequestMethod-1 I0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
... Extension-CareConnect-SourceOfReferral-1 I0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... replaces Σ0..*Reference(CareConnect-ReferralRequest-1)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example)
... priority Σ0..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required)
... serviceRequested Σ0..*CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... subject Σ1..1Reference(Group | CareConnect-Patient-1)Patient referred to care or transfer
... context Σ0..1Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)Originating encounter
... occurrence[x] Σ0..1When the service(s) requested in the referral should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeDate of creation/activation
... requester ΣI0..1BackboneElementWho/what is requesting service
rfr-1: onBehalfOf can only be specified if agent is practitioner or device
.... 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(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)Individual making the request
.... onBehalfOf ΣI0..1Reference(CareConnect-Organization-1)Organization agent is acting for
... specialty 0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient Σ0..*Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1)Receiver of referral / transfer of care request
... reasonCode Σ0..*CodeableConceptReason for referral / transfer of care request
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorStringstring
..... authorReferenceReference(CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... relevantHistory 0..*Reference(Provenance)Key events in history of request

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ReferralRequest.languageextensibleCommon Languages
Max Binding: All Languages
ReferralRequest.identifier.userequiredIdentifierUse
ReferralRequest.identifier.typeextensibleIdentifier Type Codes
ReferralRequest.groupIdentifier.userequiredIdentifierUse
ReferralRequest.groupIdentifier.typeextensibleIdentifier Type Codes
ReferralRequest.statusrequiredRequestStatus
ReferralRequest.intentrequiredRequestIntent
ReferralRequest.typeexampleSNOMED CT Patient Referral
ReferralRequest.priorityrequiredRequestPriority
ReferralRequest.serviceRequestedexamplePractice Setting Code Value Set
ReferralRequest.specialtyexamplePractitionerSpecialty
ReferralRequest.reasonCodeexampleSNOMED CT Clinical Findings

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.extension:referralRequestMethodAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ReferralRequest.extension:referralRequestMethodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ReferralRequest.extension:sourceOfReferralAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ReferralRequest.extension:sourceOfReferralMust 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()