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 - Detailed Descriptions

Definitions for the profile-referralrequest-stu3 Profile.

1. ReferralRequest
Definition | 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.
Control | 0..*
Alternate Names | ReferralRequest TransferOfCare Request
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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()) dom-4: 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())
2. ReferralRequest.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. ReferralRequest.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
4. ReferralRequest.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
5. ReferralRequest.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable Max Binding: All Languages
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
6. ReferralRequest.text
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
7. ReferralRequest.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
8. ReferralRequest.extension
Definition | An Extension
Control | 0..*
Type | Extension
9. ReferralRequest.extension:ReferralRequestInsurance
Definition | Indicates coverage relevant to the request.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(insurance) (Extension Type: Reference(CoverageSTU3))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. ReferralRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
11. ReferralRequest.identifier
Definition | Business identifier that uniquely identifies the referral/care transfer request instance.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
12. ReferralRequest.definition
Definition | A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
Control | 1..1
Type | Reference(ActivityDefinition | PlanDefinition)
Must Support | true
13. ReferralRequest.basedOn
Definition | Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
Control | 1..1
Type | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3)
Must Support | true
Alternate Names | fulfills
14. ReferralRequest.replaces
Definition | Completed or terminated request(s) whose function is taken by this new request.
Control | 0..*
Type | Reference(ReferralRequest)
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
Alternate Names | supersedes, prior, renewed order
Comments | potentially relevant for CRD in some situations.
15. ReferralRequest.groupIdentifier
Definition | The business identifier of the logical "grouping" request/order that this referral is a part of.
Control | 0..1
Type | Identifier
Requirements | Allows multiple orders to be collected as part of a single requisition.
Alternate Names | grouperId, requisition
16. ReferralRequest.status
Definition | The status of the authorization/intention reflected by the referral request record.
Control | 1..1
Binding | The status of the referral. The codes SHALL be taken from RequestStatus
Type | code
Is Modifier | true
Must Support | true
Requirements | Workflow status is handled by the Task resource.
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Fixed Value | draft
17. ReferralRequest.intent
Definition | Distinguishes the "level" of authorization/demand implicit in this request.
Control | 1..1
Binding | Codes identifying the stage lifecycle stage of a request The codes SHALL be taken from RequestIntent
Type | code
Is Modifier | true
Requirements | The same resource structure is used when capturing proposals/recommendations, plans and actual requests.
Alternate Names | category
Comments | potentially relevant for CRD in some situations.
18. ReferralRequest.type
Definition | An indication of the type of referral (or where applicable the type of transfer of care) request.
Control | 0..1
Binding | Codes for types of referral; e.g. consult, transfer, temporary transfer. For example codes, see SNOMED CT Patient Referral
Type | CodeableConcept
19. ReferralRequest.priority
Definition | An indication of the urgency of referral (or where applicable the type of transfer of care) request.
Control | 0..1
Binding | Codes indicating the relative priority of the referral. The codes SHALL be taken from RequestPriority
Type | code
20. ReferralRequest.serviceRequested
Definition | The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
Control | 1..1
Binding | Codes indicating the types of services that might be requested as part of a referral. For example codes, see Practice Setting Code Value Set
Type | CodeableConcept
Must Support | true
21. ReferralRequest.subject
Definition | The patient who is the subject of a referral or transfer of care request.
Control | 1..1
Type | Reference(PatientSTU3)
Must Support | true
Comments | Referral of family, group or community is to be catered for by profiles.
22. ReferralRequest.context
Definition | The encounter at which the request for referral or transfer of care is initiated.
Control | 0..1
Type | Reference(EncounterSTU3)
Alternate Names | encounter
Comments | potentially relevant for CRD in some situations.
23. ReferralRequest.occurrence[x]
Definition | The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
Control | 0..1
Type | Choice of: dateTime, Period
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Requirements | Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values).
Alternate Names | timing
Comments | When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.
24. ReferralRequest.authoredOn
Definition | Date/DateTime of creation for draft requests and date of activation for active requests.
Control | 1..1
Type | dateTime
Must Support | true
Alternate Names | createdOn
25. ReferralRequest.requester
Definition | The individual who initiated the request and has responsibility for its activation.
Control | 1..1
Type | BackboneElement
Must Support | true
Alternate Names | author
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) rfr-1: onBehalfOf can only be specified if agent is practitioner or device (: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not())
26. ReferralRequest.requester.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
27. ReferralRequest.requester.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
28. ReferralRequest.requester.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
29. ReferralRequest.requester.agent
Definition | The device, practitioner, etc. who initiated the request.
Control | 1..1
Type | Reference(PractitionerSTU3)
Must Support | true
30. ReferralRequest.requester.onBehalfOf
Definition | The organization the device or practitioner was acting on behalf of.
Control | 0..1 This element is affected by the following invariants: rfr-1
Type | Reference(Organization)
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.
Comments | potentially relevant for CRD in some situations.
31. ReferralRequest.specialty
Definition | Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
Control | 0..1
Binding | Codes indicating the types of capability the referred to service provider must have. For example codes, see PractitionerSpecialty
Type | CodeableConcept
Comments | potentially relevant for CRD in some situations.
32. ReferralRequest.recipient
Definition | The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
Control | 0..*
Type | Reference(PractitionerSTU3)
Must Support | true
Comments | There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations.
33. ReferralRequest.reasonCode
Definition | Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
Control | 0..*
Binding | Codes indicating why the referral is being requested. For example codes, see SNOMED CT Clinical Findings
Type | CodeableConcept
Must Support | true
34. ReferralRequest.reasonReference
Definition | Indicates another resource whose existence justifies this request.
Control | 0..*
Type | Reference(US Core Condition Profile | US Core Result Observation)
Must Support | true
Comments | potentially relevant for CRD in some situations.
35. ReferralRequest.description
Definition | The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
Control | 0..1
Type | string
36. ReferralRequest.supportingInfo
Definition | Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
Control | 0..*
Type | Reference(Resource)
Comments | potentially relevant for CRD in some situations.
37. ReferralRequest.note
Definition | Comments made about the referral request by any of the participants.
Control | 0..*
Type | Annotation
Comments | potentially relevant for CRD in some situations.
38. ReferralRequest.relevantHistory
Definition | Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
Control | 0..*
Type | Reference(Provenance)
Alternate Names | eventHistory
Comments | potentially relevant for CRD in some situations.