. Page versions: R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R3 R2
StructureDefinition for referralrequest
{
"resourceType": "StructureDefinition",
"id": "ReferralRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ReferralRequest",
"name": "ReferralRequest",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ReferralRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ReferralRequest",
"short": "A request for referral or transfer of care",
"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 organisation.",
"alias": [
"ReferralRequest\rTransferOfCare Request"
],
"min": 1,
"max": "1",
"type": [
{
"code": "ReferralRequest"
}
]
},
{
"path": "ReferralRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ReferralRequest.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ReferralRequest.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ReferralRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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\n\nNot 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).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ReferralRequest.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ReferralRequest.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ReferralRequest.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ReferralRequest.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ReferralRequest.status",
"short": "draft | sent | active | cancelled | rejected | completed",
"definition": "The workflow status of the referral or transfer of care request.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ReferralStatus",
"strength": "required",
"description": "The status of the referral",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/referralstatus"
}
}
},
{
"path": "ReferralRequest.identifier",
"short": "Identifier of request",
"definition": "Business Id that uniquely identifies the referral/care transfer request instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.type",
"short": "Referral/Transition of care request type",
"definition": "An indication of the type of referral (or where applicable the type of transfer of care) request.",
"comments": "Examples of referral type:\r- consultation; \r second opinion; \r third opinion\r- Assume management\r- Request for procedure(s)\r\rHL7 v2.8 Example - Table 0336:\rS = second opinion\rp = patient preference\ro = provider ordered\rw = work load.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.specialty",
"short": "The clinical specialty (discipline) that the referral is requested for",
"definition": "Indication of the clinical domain or discipline to which the referral or transfer of care request is sent.",
"comments": "Examples:\rCardiology\rGastroenterology\rDiabetology.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.priority",
"short": "Urgency of referral / transfer of care request",
"definition": "An indication of the urgency of referral (or where applicable the type of transfer of care) request.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.patient",
"short": "Patient referred to care or transfer",
"definition": "The patient who is the subject of a referral or transfer of care request.",
"comments": "Referral of family, group or community is to be catered for by profiles.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.requester",
"short": "Requester of referral / transfer of care",
"definition": "The healthcare provider or provider organization who/which initaited the referral/transfer of care request. Can also be Patient (a self referral).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.recipient",
"short": "Receiver of referral / transfer of care request",
"definition": "The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.",
"comments": "There will be a primary receiver.\rBut the request can be received by any number of \"copied to\" providers or organisations.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.encounter",
"short": "Encounter",
"definition": "The encounter at which the request for referral or transfer of care is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.dateSent",
"short": "Date referral/transfer of care request is sent",
"definition": "Date/DateTime the request for referral or transfer of care is sent by the author.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.reason",
"short": "Reason for referral / Transfer of care request",
"definition": "Description of clinical condition indicating why referral/transfer of care is requested.",
"comments": "Examples:\r\"2nd degree AV block\"\r\rOral Health example ReferralReasonCode:\r01 = Pathological Anomalies\r02 = Disabled (physical or mental)\r03 = Complexity of Treatment\r04 = Seizure Disorders\r05 = Extensive Surgery\r06 = Surgical Complexity\r07 = Rampant decay\r08 = Medical History (to provide details upon request)\r09 = Temporal Mandibular Joint Anomalies\r10 = Accidental Injury\r11 = Anaesthesia complications (local or general)\r12 = Developmental Anomalies\r13 = Behavioral Management.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.description",
"short": "A textual description of the referral",
"definition": "The reason gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.",
"comments": "This would be a good candidate for a 'markdown' data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.serviceRequested",
"short": "Service(s) requested",
"definition": "The service(s) that is/are requested to be provided to the patient.",
"comments": "Examples:\r\"cardiac pacemaker insertion\"\r\rHL7 v3 Concept domain - ReferralReasonCode examples:\r- Specialized medical assistance\r- Other care requirement.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.supportingInformation",
"short": "Additonal information to support referral or transfer of care request",
"definition": "Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care.",
"comments": "Examples include:\rPresenting problems/chief complaints\rMedical History\rFamily History\rAlerts\rAllergy/Intolerance and Adverse Reactions\rMedications\rObservations/Assessments (may include cognitive and fundtional assessments)\rDiagnostic Reports\rCare Plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.fulfillmentTime",
"short": "Requested service(s) fulfillment time",
"definition": "The period of time within which the services identified in the referral/transfer of care is specified or required to occur.",
"requirements": "Use cases:\r(1) to indicate that the requested service is not to happen before a specified date\r(2) to indicate that the requested service must happen before a specified date\r(3) to indicate that the requested service must happen during the specified dates (\"low\" and \"high\" values).",
"alias": [
"EffectiveTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"path": "ReferralRequest",
"short": "A request for referral or transfer of care",
"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 organisation.",
"alias": [
"ReferralRequest\rTransferOfCare Request"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ReferralRequest.status",
"short": "draft | sent | active | cancelled | rejected | completed",
"definition": "The workflow status of the referral or transfer of care request.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ReferralStatus",
"strength": "required",
"description": "The status of the referral",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/referralstatus"
}
}
},
{
"path": "ReferralRequest.identifier",
"short": "Identifier of request",
"definition": "Business Id that uniquely identifies the referral/care transfer request instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.type",
"short": "Referral/Transition of care request type",
"definition": "An indication of the type of referral (or where applicable the type of transfer of care) request.",
"comments": "Examples of referral type:\r- consultation; \r second opinion; \r third opinion\r- Assume management\r- Request for procedure(s)\r\rHL7 v2.8 Example - Table 0336:\rS = second opinion\rp = patient preference\ro = provider ordered\rw = work load.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.specialty",
"short": "The clinical specialty (discipline) that the referral is requested for",
"definition": "Indication of the clinical domain or discipline to which the referral or transfer of care request is sent.",
"comments": "Examples:\rCardiology\rGastroenterology\rDiabetology.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.priority",
"short": "Urgency of referral / transfer of care request",
"definition": "An indication of the urgency of referral (or where applicable the type of transfer of care) request.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.patient",
"short": "Patient referred to care or transfer",
"definition": "The patient who is the subject of a referral or transfer of care request.",
"comments": "Referral of family, group or community is to be catered for by profiles.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.requester",
"short": "Requester of referral / transfer of care",
"definition": "The healthcare provider or provider organization who/which initaited the referral/transfer of care request. Can also be Patient (a self referral).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.recipient",
"short": "Receiver of referral / transfer of care request",
"definition": "The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.",
"comments": "There will be a primary receiver.\rBut the request can be received by any number of \"copied to\" providers or organisations.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.encounter",
"short": "Encounter",
"definition": "The encounter at which the request for referral or transfer of care is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.dateSent",
"short": "Date referral/transfer of care request is sent",
"definition": "Date/DateTime the request for referral or transfer of care is sent by the author.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.reason",
"short": "Reason for referral / Transfer of care request",
"definition": "Description of clinical condition indicating why referral/transfer of care is requested.",
"comments": "Examples:\r\"2nd degree AV block\"\r\rOral Health example ReferralReasonCode:\r01 = Pathological Anomalies\r02 = Disabled (physical or mental)\r03 = Complexity of Treatment\r04 = Seizure Disorders\r05 = Extensive Surgery\r06 = Surgical Complexity\r07 = Rampant decay\r08 = Medical History (to provide details upon request)\r09 = Temporal Mandibular Joint Anomalies\r10 = Accidental Injury\r11 = Anaesthesia complications (local or general)\r12 = Developmental Anomalies\r13 = Behavioral Management.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.description",
"short": "A textual description of the referral",
"definition": "The reason gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.",
"comments": "This would be a good candidate for a 'markdown' data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.serviceRequested",
"short": "Service(s) requested",
"definition": "The service(s) that is/are requested to be provided to the patient.",
"comments": "Examples:\r\"cardiac pacemaker insertion\"\r\rHL7 v3 Concept domain - ReferralReasonCode examples:\r- Specialized medical assistance\r- Other care requirement.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.supportingInformation",
"short": "Additonal information to support referral or transfer of care request",
"definition": "Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care.",
"comments": "Examples include:\rPresenting problems/chief complaints\rMedical History\rFamily History\rAlerts\rAllergy/Intolerance and Adverse Reactions\rMedications\rObservations/Assessments (may include cognitive and fundtional assessments)\rDiagnostic Reports\rCare Plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.fulfillmentTime",
"short": "Requested service(s) fulfillment time",
"definition": "The period of time within which the services identified in the referral/transfer of care is specified or required to occur.",
"requirements": "Use cases:\r(1) to indicate that the requested service is not to happen before a specified date\r(2) to indicate that the requested service must happen before a specified date\r(3) to indicate that the requested service must happen during the specified dates (\"low\" and \"high\" values).",
"alias": [
"EffectiveTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"isSummary": true
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:23+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change