CareConnect-CDS-ReferralRequest-1
This is the StructureDefinition overview for the CareConnect-CDS-ReferralRequest-1
The official URL for this profile is: https
Differential
| CareConnect-CDS-ReferralRequest-1 (ReferralRequest) | C | CareConnect-ReferralRequest-1 | There are no (further) constraints on this element Element idReferralRequestShort description A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed 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.
| |||
| id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idReferralRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idReferralRequest.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idReferralRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idReferralRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| referralRequestMethod | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:referralRequestMethodShort description The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... Alternate namesextensions, user content DefinitionThe method used to send or receive a Referral Request. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfReferral | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:sourceOfReferralShort description This represents the source of referral Alternate namesextensions, user content DefinitionThe source of referral for a Referral Request. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idReferralRequest.identifierShort description Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.identifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.identifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.identifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idReferralRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| definition | Σ C | 0..* | Reference(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idReferralRequest.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.basedOnShort description Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CareConnect-ReferralRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idReferralRequest.groupIdentifierShort description Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.statusShort description draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the authorization/intention reflected by the referral request record. Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of the referral. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.intentShort description proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Note that FHIR strings may not exceed 1MB in size Codes identifying the stage lifecycle stage of a request ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | S Σ | 1..1 | CodeableConcept | Element idReferralRequest.typeShort description Referral/Transition of care request type DefinitionAn indication of the type of referral (e.g. 'Hospital Discharge Notification to Social Care', 'GP Referral', etc.) Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for types of referral; e.g. consult, transfer, temporary transfer. SNOMED CT Patient Referral (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.type.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.type.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idReferralRequest.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.type.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.priorityShort description Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Note that FHIR strings may not exceed 1MB in size Codes indicating the relative priority of the referral. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| serviceRequested | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.serviceRequestedShort description Actions requested as part of the referral DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating the types of services that might be requested as part of a referral. Practice Setting Code Value Set (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 1..1 | Reference(CareConnect-CDS-Patient-1) | Element idReferralRequest.subjectShort description Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles. Reference(CareConnect-CDS-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| context | Σ C | 0..1 | Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1) | There are no (further) constraints on this element Element idReferralRequest.contextShort description Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.occurrence[x]Short description When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. 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). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.authoredOnShort description Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idReferralRequest.requesterShort description Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.requester.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| agent | Σ C | 1..1 | Reference(CareConnect-CDS-Practitioner-1) | Element idReferralRequest.requester.agentShort description Individual making the request DefinitionThe device, practitioner, etc. who initiated the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| onBehalfOf | Σ C | 1..1 | Reference(CareConnect-CDS-Organization-1) | Element idReferralRequest.requester.onBehalfOfShort description Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, rfr-1 Constraints
| ||
| specialty | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.specialtyShort description The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating the types of capability the referred to service provider must have. PractitionerSpecialty (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| recipient | Σ C | 0..* | Reference(CareConnect-HealthcareService-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | There are no (further) constraints on this element Element idReferralRequest.recipientShort description Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. Reference(CareConnect-HealthcareService-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.reasonCodeShort description Reason for referral / transfer of care request DefinitionDescription of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating why the referral is being requested. SNOMED CT Clinical Findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idReferralRequest.reasonReferenceShort description Why is service needed? DefinitionIndicates another resource whose existence justifies this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Condition-1 | CareConnect-Observation-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | S | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.descriptionShort description A textual description of the referral DefinitionThe 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. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idReferralRequest.supportingInfoShort description Additonal information to support referral or transfer of care request DefinitionAny 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idReferralRequest.noteShort description Comments made about referral request DefinitionComments made about the referral request by any of the participants. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.note.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Data typeReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | ||||
| authorString | string | There are no (further) constraints on this element Data type | ||||
| time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.textShort description The annotation - text content DefinitionThe text of the annotation. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idReferralRequest.relevantHistoryShort description Key events in history of request Alternate nameseventHistory DefinitionLinks 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. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Hybrid
| CareConnect-CDS-ReferralRequest-1 (ReferralRequest) | C | CareConnect-ReferralRequest-1 | There are no (further) constraints on this element Element idReferralRequestShort description A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed 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.
| |||
| id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idReferralRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idReferralRequest.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idReferralRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idReferralRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| referralRequestMethod | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:referralRequestMethodShort description The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... Alternate namesextensions, user content DefinitionThe method used to send or receive a Referral Request. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfReferral | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:sourceOfReferralShort description This represents the source of referral Alternate namesextensions, user content DefinitionThe source of referral for a Referral Request. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idReferralRequest.identifierShort description Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.identifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.identifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.identifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idReferralRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| definition | Σ C | 0..* | Reference(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idReferralRequest.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.basedOnShort description Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CareConnect-ReferralRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idReferralRequest.groupIdentifierShort description Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.statusShort description draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the authorization/intention reflected by the referral request record. Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of the referral. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.intentShort description proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Note that FHIR strings may not exceed 1MB in size Codes identifying the stage lifecycle stage of a request ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | S Σ | 1..1 | CodeableConcept | Element idReferralRequest.typeShort description Referral/Transition of care request type DefinitionAn indication of the type of referral (e.g. 'Hospital Discharge Notification to Social Care', 'GP Referral', etc.) Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for types of referral; e.g. consult, transfer, temporary transfer. SNOMED CT Patient Referral (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.type.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.type.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idReferralRequest.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.type.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.priorityShort description Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Note that FHIR strings may not exceed 1MB in size Codes indicating the relative priority of the referral. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| serviceRequested | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.serviceRequestedShort description Actions requested as part of the referral DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating the types of services that might be requested as part of a referral. Practice Setting Code Value Set (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 1..1 | Reference(CareConnect-CDS-Patient-1) | Element idReferralRequest.subjectShort description Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles. Reference(CareConnect-CDS-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| context | Σ C | 0..1 | Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1) | There are no (further) constraints on this element Element idReferralRequest.contextShort description Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.occurrence[x]Short description When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. 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). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.authoredOnShort description Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idReferralRequest.requesterShort description Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.requester.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| agent | Σ C | 1..1 | Reference(CareConnect-CDS-Practitioner-1) | Element idReferralRequest.requester.agentShort description Individual making the request DefinitionThe device, practitioner, etc. who initiated the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| onBehalfOf | Σ C | 1..1 | Reference(CareConnect-CDS-Organization-1) | Element idReferralRequest.requester.onBehalfOfShort description Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, rfr-1 Constraints
| ||
| specialty | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.specialtyShort description The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating the types of capability the referred to service provider must have. PractitionerSpecialty (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| recipient | Σ C | 0..* | Reference(CareConnect-HealthcareService-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | There are no (further) constraints on this element Element idReferralRequest.recipientShort description Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. Reference(CareConnect-HealthcareService-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.reasonCodeShort description Reason for referral / transfer of care request DefinitionDescription of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating why the referral is being requested. SNOMED CT Clinical Findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idReferralRequest.reasonReferenceShort description Why is service needed? DefinitionIndicates another resource whose existence justifies this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Condition-1 | CareConnect-Observation-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | S | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.descriptionShort description A textual description of the referral DefinitionThe 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. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idReferralRequest.supportingInfoShort description Additonal information to support referral or transfer of care request DefinitionAny 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idReferralRequest.noteShort description Comments made about referral request DefinitionComments made about the referral request by any of the participants. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.note.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Data typeReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | ||||
| authorString | string | There are no (further) constraints on this element Data type | ||||
| time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.textShort description The annotation - text content DefinitionThe text of the annotation. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idReferralRequest.relevantHistoryShort description Key events in history of request Alternate nameseventHistory DefinitionLinks 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. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Snapshot (default)
| CareConnect-CDS-ReferralRequest-1 (ReferralRequest) | C | CareConnect-ReferralRequest-1 | There are no (further) constraints on this element Element idReferralRequestShort description A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed 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.
| |||
| id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idReferralRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idReferralRequest.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idReferralRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idReferralRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| referralRequestMethod | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:referralRequestMethodShort description The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... Alternate namesextensions, user content DefinitionThe method used to send or receive a Referral Request. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfReferral | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:sourceOfReferralShort description This represents the source of referral Alternate namesextensions, user content DefinitionThe source of referral for a Referral Request. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idReferralRequest.identifierShort description Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.identifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.identifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.identifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idReferralRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| definition | Σ C | 0..* | Reference(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idReferralRequest.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.basedOnShort description Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CareConnect-ReferralRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idReferralRequest.groupIdentifierShort description Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.statusShort description draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the authorization/intention reflected by the referral request record. Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of the referral. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.intentShort description proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Note that FHIR strings may not exceed 1MB in size Codes identifying the stage lifecycle stage of a request ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | S Σ | 1..1 | CodeableConcept | Element idReferralRequest.typeShort description Referral/Transition of care request type DefinitionAn indication of the type of referral (e.g. 'Hospital Discharge Notification to Social Care', 'GP Referral', etc.) Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for types of referral; e.g. consult, transfer, temporary transfer. SNOMED CT Patient Referral (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.type.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.type.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idReferralRequest.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.type.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.priorityShort description Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Note that FHIR strings may not exceed 1MB in size Codes indicating the relative priority of the referral. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| serviceRequested | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.serviceRequestedShort description Actions requested as part of the referral DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating the types of services that might be requested as part of a referral. Practice Setting Code Value Set (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 1..1 | Reference(CareConnect-CDS-Patient-1) | Element idReferralRequest.subjectShort description Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles. Reference(CareConnect-CDS-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| context | Σ C | 0..1 | Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1) | There are no (further) constraints on this element Element idReferralRequest.contextShort description Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.occurrence[x]Short description When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. 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). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.authoredOnShort description Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idReferralRequest.requesterShort description Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.requester.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| agent | Σ C | 1..1 | Reference(CareConnect-CDS-Practitioner-1) | Element idReferralRequest.requester.agentShort description Individual making the request DefinitionThe device, practitioner, etc. who initiated the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| onBehalfOf | Σ C | 1..1 | Reference(CareConnect-CDS-Organization-1) | Element idReferralRequest.requester.onBehalfOfShort description Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, rfr-1 Constraints
| ||
| specialty | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.specialtyShort description The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating the types of capability the referred to service provider must have. PractitionerSpecialty (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| recipient | Σ C | 0..* | Reference(CareConnect-HealthcareService-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | There are no (further) constraints on this element Element idReferralRequest.recipientShort description Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. Reference(CareConnect-HealthcareService-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.reasonCodeShort description Reason for referral / transfer of care request DefinitionDescription of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes indicating why the referral is being requested. SNOMED CT Clinical Findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idReferralRequest.reasonReferenceShort description Why is service needed? DefinitionIndicates another resource whose existence justifies this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Condition-1 | CareConnect-Observation-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | S | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.descriptionShort description A textual description of the referral DefinitionThe 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. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idReferralRequest.supportingInfoShort description Additonal information to support referral or transfer of care request DefinitionAny 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idReferralRequest.noteShort description Comments made about referral request DefinitionComments made about the referral request by any of the participants. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.note.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Data typeReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | ||||
| authorString | string | There are no (further) constraints on this element Data type | ||||
| time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.textShort description The annotation - text content DefinitionThe text of the annotation. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idReferralRequest.relevantHistoryShort description Key events in history of request Alternate nameseventHistory DefinitionLinks 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. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
ReferralRequest Data Mapping
The table below provides the business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-CDS-ReferralRequest-1 profile. The CareConnect-CDS-ReferralRequest-1 profile is used to share details of referrals that have been recieved by the Local Authority.
| FHIR Element | Card. | Type | Description/Business Context |
|---|---|---|---|
| ReferralRequest.id | 1..1 | id | Logical id of Referral from Social Care System and used for referencing resource within the Bundle |
| ReferralRequest.status | 1..1 | code | Binding RequestStatus'active'=the authority are still actioning the referral'completed'=activity agsint the referral has all been undertaken'cancelled'=the referral was cancelled by the requestor or rejected by the authority |
| ReferralRequest.intent | 1..1 | code | Binding RequestIntent |
| ReferralRequest.type | 1..1 | CodeableConcept | An indication of the type of referral (e.g. 'Hospital Discharge Notification to Social Care', 'GP Referral', etc.) |
| ReferralRequest.type.coding | 0..* | coding | Optional codinig should an agreed ValueSet/CodeSystem of referral types be available |
| ReferralRequest.type.text | 1..1 | string | Plain text representation of type (e.g. Hospital Discharge Notification to Social Care, GP Referral, etc.)Note ReferralRequest.type.text will be the default element used by any UI consuming the service to display the type |
| ReferralRequest.subject | 1..1 | Reference (CareConnect-CDS-Patient-1) | Reference to Patient resource to whom the referral relates. |
| ReferralRequest.authoredOn | 1..1 | dateTime | Date referral was activated/recieved by the the Local Authority |
| ReferralRequest.requester.agent | 1..1 | Reference (CareConnect-CDS-Practitioner-1) | Reference to Practitioner resource who initiated the request |
| ReferralRequest.requester.onBehalfOf | 1..1 | Reference (CareConnect-CDS-Organization-1) | Reference to the Organization resource which the ReferralRequest.requester.agent was acting on behalf of |
| ReferralRequest.description | 0..* | string | Optional plain text narrative providing more details about the referral, e.g. rationale for referral / specific needs that need to be addressed by Social Care |