0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: ReferralRequestSTU3

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-referralrequest-stu3

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from ReferralRequest

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

- unable to summarise profile http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 (no profile found)
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-encounter-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-practitioner-stu3
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance

This structure is derived from ReferralRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ReferralRequest |  | 0..* |  |
ext-insurance | S | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
identifier | S | 0..* | Identifier |
definition | S | 1..1 | Reference(ActivityDefinition | PlanDefinition) |
basedOn | S | 1..1 | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3) |
replaces |  | 0..* | Reference(ReferralRequest) |
groupIdentifier |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
intent |  | 1..1 | code |
type |  | 0..1 | CodeableConcept |
priority |  | 0..1 | code |
serviceRequested | S | 1..1 | CodeableConcept |
subject | S | 1..1 | Reference(PatientSTU3) |
context |  | 0..1 | Reference(EncounterSTU3) |
occurrence[x] | S | 0..1 | dateTime, Period |
authoredOn | S | 1..1 | dateTime |
requester | S | 1..1 | BackboneElement |
agent | S | 1..1 | Reference(PractitionerSTU3) |
onBehalfOf |  | 0..1 | Reference(Organization) |
specialty |  | 0..1 | CodeableConcept |
recipient | S | 0..* | Reference(PractitionerSTU3) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference | S | 0..* | Reference(US Core Condition Profile | US Core Result Observation) |
description |  | 0..1 | string |
supportingInfo |  | 0..* | Reference(Resource) |
note |  | 0..* | Annotation |
relevantHistory |  | 0..* | Reference(Provenance) |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ReferralRequest | I | 0..* |  | A request for referral or transfer of care
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
ext-insurance | S I | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business identifier
definition | S Σ | 1..1 | Reference(ActivityDefinition | PlanDefinition) | Instantiates protocol or definition
basedOn | S Σ | 1..1 | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3) | Request fulfilled by this request
replaces | Σ | 0..* | Reference(ReferralRequest) | Request(s) replaced by this request
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of
status | ?!S Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) Fixed Value: draft
intent | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required)
type | Σ | 0..1 | CodeableConcept | Referral/Transition of care request type Binding: SNOMED CT Patient Referral (example)
priority | Σ | 0..1 | code | Urgency of referral / transfer of care request Binding: RequestPriority (required)
serviceRequested | S Σ | 1..1 | CodeableConcept | Actions requested as part of the referral Binding: Practice Setting Code Value Set (example)
subject | S Σ | 1..1 | Reference(PatientSTU3) | Patient referred to care or transfer
context | Σ | 0..1 | Reference(EncounterSTU3) | Originating encounter
occurrence[x] | S Σ | 0..1 | dateTime, Period | When the service(s) requested in the referral should occur
authoredOn | S Σ | 1..1 | dateTime | Date of creation/activation
requester | S Σ I | 1..1 | BackboneElement | Who/what is requesting service
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
agent | S Σ | 1..1 | Reference(PractitionerSTU3) | Individual making the request
onBehalfOf | Σ I | 0..1 | Reference(Organization) | Organization agent is acting for
specialty |  | 0..1 | CodeableConcept | The clinical specialty (discipline) that the referral is requested for Binding: PractitionerSpecialty (example)
recipient | S Σ | 0..* | Reference(PractitionerSTU3) | Receiver of referral / transfer of care request
reasonCode | S Σ | 0..* | CodeableConcept | Reason for referral / transfer of care request Binding: SNOMED CT Clinical Findings (example)
reasonReference | S Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation) | Why is service needed?
description |  | 0..1 | string | A textual description of the referral
supportingInfo |  | 0..* | Reference(Resource) | Additonal information to support referral or transfer of care request
note |  | 0..* | Annotation | Comments made about referral request
relevantHistory |  | 0..* | Reference(Provenance) | Key events in history of request
Documentation for this format

This structure is derived from ReferralRequest

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

- unable to summarise profile http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 (no profile found)
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-encounter-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-practitioner-stu3
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance

Differential View

This structure is derived from ReferralRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ReferralRequest |  | 0..* |  |
ext-insurance | S | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
identifier | S | 0..* | Identifier |
definition | S | 1..1 | Reference(ActivityDefinition | PlanDefinition) |
basedOn | S | 1..1 | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3) |
replaces |  | 0..* | Reference(ReferralRequest) |
groupIdentifier |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
intent |  | 1..1 | code |
type |  | 0..1 | CodeableConcept |
priority |  | 0..1 | code |
serviceRequested | S | 1..1 | CodeableConcept |
subject | S | 1..1 | Reference(PatientSTU3) |
context |  | 0..1 | Reference(EncounterSTU3) |
occurrence[x] | S | 0..1 | dateTime, Period |
authoredOn | S | 1..1 | dateTime |
requester | S | 1..1 | BackboneElement |
agent | S | 1..1 | Reference(PractitionerSTU3) |
onBehalfOf |  | 0..1 | Reference(Organization) |
specialty |  | 0..1 | CodeableConcept |
recipient | S | 0..* | Reference(PractitionerSTU3) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference | S | 0..* | Reference(US Core Condition Profile | US Core Result Observation) |
description |  | 0..1 | string |
supportingInfo |  | 0..* | Reference(Resource) |
note |  | 0..* | Annotation |
relevantHistory |  | 0..* | Reference(Provenance) |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ReferralRequest | I | 0..* |  | A request for referral or transfer of care
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
ext-insurance | S I | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business identifier
definition | S Σ | 1..1 | Reference(ActivityDefinition | PlanDefinition) | Instantiates protocol or definition
basedOn | S Σ | 1..1 | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3) | Request fulfilled by this request
replaces | Σ | 0..* | Reference(ReferralRequest) | Request(s) replaced by this request
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of
status | ?!S Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) Fixed Value: draft
intent | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required)
type | Σ | 0..1 | CodeableConcept | Referral/Transition of care request type Binding: SNOMED CT Patient Referral (example)
priority | Σ | 0..1 | code | Urgency of referral / transfer of care request Binding: RequestPriority (required)
serviceRequested | S Σ | 1..1 | CodeableConcept | Actions requested as part of the referral Binding: Practice Setting Code Value Set (example)
subject | S Σ | 1..1 | Reference(PatientSTU3) | Patient referred to care or transfer
context | Σ | 0..1 | Reference(EncounterSTU3) | Originating encounter
occurrence[x] | S Σ | 0..1 | dateTime, Period | When the service(s) requested in the referral should occur
authoredOn | S Σ | 1..1 | dateTime | Date of creation/activation
requester | S Σ I | 1..1 | BackboneElement | Who/what is requesting service
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
agent | S Σ | 1..1 | Reference(PractitionerSTU3) | Individual making the request
onBehalfOf | Σ I | 0..1 | Reference(Organization) | Organization agent is acting for
specialty |  | 0..1 | CodeableConcept | The clinical specialty (discipline) that the referral is requested for Binding: PractitionerSpecialty (example)
recipient | S Σ | 0..* | Reference(PractitionerSTU3) | Receiver of referral / transfer of care request
reasonCode | S Σ | 0..* | CodeableConcept | Reason for referral / transfer of care request Binding: SNOMED CT Clinical Findings (example)
reasonReference | S Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation) | Why is service needed?
description |  | 0..1 | string | A textual description of the referral
supportingInfo |  | 0..* | Reference(Resource) | Additonal information to support referral or transfer of care request
note |  | 0..* | Annotation | Comments made about referral request
relevantHistory |  | 0..* | Reference(Provenance) | Key events in history of request
Documentation for this format

Other representations of profile: Schematron

### Terminology Bindings

Path | Conformance | ValueSet / Code
ReferralRequest.status | required | Fixed Value: draft
ReferralRequest.serviceRequested | example | Practice Setting Code Value Set
ReferralRequest.reasonCode | example | SNOMED CT Clinical Findings

### Constraints

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