Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

K.10.4 StructureDefinition: GAO Referral Request - Detailed Descriptions

Definitions for the gao-referralrequest Profile.

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.

Control0..*
TypeReferralRequest
Alternate NamesReferralRequest TransferOfCare Request
ReferralRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
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. Bundles always have an id, though it is usually a generated UUID.

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.

Control0..1
TypeMeta
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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

ReferralRequest.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
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).

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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

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.

Control0..*
TypeResource
Alternate Namesinline 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.

ReferralRequest.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

ReferralRequest.status
Definition

The workflow status of the referral or transfer of care request.

Control1..1
BindingThe status of the referral.
The codes SHALL be taken from ReferralStatus
Typecode
Is Modifiertrue
ReferralRequest.identifier
Definition

Business identifier that uniquely identifies the referral/care transfer request instance.

Control0..*
TypeIdentifier
ReferralRequest.date
Definition

Date/DateTime of creation for draft requests and date of activation for active requests.

Control0..1
TypedateTime
ReferralRequest.type
Definition

An indication of the type of referral (or where applicable the type of transfer of care) request.

Control0..1
BindingCodes for types of referral; e.g. consult, transfer, temporary transfer.
TypeCodeableConcept
Comments

Examples of referral type: - consultation; second opinion; third opinion - Assume management - Request for procedure(s) HL7 v2.8 Example - Table 0336: S = second opinion p = patient preference o = provider ordered w = work load.

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.

Control0..1
BindingCodes indicating the types of capability the referred to service provider must have.
For example codes, see PractitionerSpecialty
TypeCodeableConcept
ReferralRequest.priority
Definition

An indication of the urgency of referral (or where applicable the type of transfer of care) request.

Control0..1
BindingCodes indicating the relative priority of the referral.
For example codes, see DiagnosticOrderPriority
TypeCodeableConcept
ReferralRequest.patient
Definition

The patient who is the subject of a referral or transfer of care request.

Control0..1
TypeReference(Patient)
Comments

Referral of family, group or community is to be catered for by profiles.

ReferralRequest.requester
Definition

The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral).

Control0..1
TypeChoice of: Reference(Practitioner), Reference(Organization), Reference(Patient)
ReferralRequest.recipient
Definition

The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.

Control0..*
TypeChoice of: Reference(Practitioner), Reference(Organization)
Comments

There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations.

ReferralRequest.encounter
Definition

The encounter at which the request for referral or transfer of care is initiated.

Control0..1
TypeReference(Encounter)
ReferralRequest.dateSent
Definition

Date/DateTime the request for referral or transfer of care is sent by the author.

Control0..1
TypedateTime
ReferralRequest.reason
Definition

Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.

Control1..1
BindingCodes indicating why the referral is being requested.
TypeCodeableConcept
Requirements

The reason may assist in the evaluation of appropriateness.

Comments

The reason for the referral SHALL be provided.

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.

Control0..1
Typestring
ReferralRequest.serviceRequested
Definition

The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.

Control1..*
BindingCodes indicating the types of services that might be requested as part of a referral.
For example codes, see Practice Setting Code Value Set
TypeCodeableConcept
Requirements

The service must be described so that it can be evaluated for appropriateness.

Comments

At least one service requested SHALL be provided.

ReferralRequest.supportingInformation
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.

Control1..*
TypeReference(Resource)
Requirements

Supporting information is needed to provide the indication for the service.

Comments

Some supporting information supporting the order SHALL be provided.

ReferralRequest.fulfillmentTime
Definition

The period of time within which the services identified in the referral/transfer of care is specified or required to occur.

Control0..1
TypePeriod
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 NamesEffectiveTime