ERP ServiceRequest DispenseRequest

Übersicht über das Profil

NameDescriptionCanonical_URLStatusVersionBasiert auf
ERPServiceRequestDispenseRequest

ServiceRequest that is used to supply a recipe

https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-requestdraft1.2http://hl7.org/fhir/StructureDefinition/ServiceRequest

Über das Profil

Motivation

Als zentrales Element in einer Anfrage gelten in dieser Spezifikation ServiceRequests. Diese Bündeln die Informationen für eine konkrete Anfrage an einen anderen Leistungserbringer. Folgende Begriffe werden in diesem IG für diesen ServiceRequests genutzt:

  • ServiceRequest meint den Request als Basisprofil von HL7
  • ERPServiceRequestDispenseRequest meint konkret dieses Profil in diesem Projekt
  • Dispensieranfrage ist der fachliche Begriff für dieses Profil

Der ERPServiceRequestDispenseRequest ist eine Anfrage zur Belieferung eines Präparates an eine ausliefernde Apotheke. Alle für die Apotheke relevanten Informationen sind in diesem ServiceRequest vorzuhalten, bzw. zu referenzieren.

Dieses Profil wird auch genutzt, um eine Pflegeeinrichtung über die Dispensierung einer Verordnung zu informieren.

Die Identifikation als ERPServiceRequestDispenseRequest (Belieferungsanfrage) wird über .code.coding.code = #dispense-request angegeben.

Inhalt des Profils

Folgende Ansichten existieren auf das Profil:

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
EPrescriptionTokenS I0..1Extension(ERPServiceRequestEPrescriptionToken)
modifierExtension?! I0..*Extension
requestIdΣ1..1ERPServiceRequestRequestIdentifier
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..*Reference(ServiceRequest)
requisitionS Σ1..1ERPServiceRequestProcedureIdentifier
statusS Σ ?!1..1codeBinding
intentΣ ?!1..1codeBindingFixed Value
categoryΣ0..*CodeableConcept
priorityS Σ0..1codeBinding
doNotPerformΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
orderDetailΣ I0..*CodeableConcept
quantityQuantityQuantity
quantityRatioRatio
quantityRangeRange
subjectS Σ I1..1Reference(ERPServiceRequestPatient)
encounterΣ I0..1Reference(Encounter)
occurrenceDateTimedateTime
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
authoredOnS Σ1..1dateTime
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeS Σ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
performerTypeΣ0..1CodeableConcept
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..*CodeableConcept
locationReferenceΣ I0..*Reference(Location)
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..*Reference(Coverage | ClaimResponse)
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
specimenΣ I0..*Reference(Specimen)
bodySiteΣ0..*CodeableConcept
id0..1string
extensionI0..*Extension
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeS Σ1..1dateTime
textΣ1..1markdown
patientInstructionΣ0..1string
relevantHistoryI0..*Reference(Provenance)
ServiceRequest
DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
Cardinality0...*
Aliasdiagnostic request, referral, referral request, transfer of care request
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • prr-1: orderDetail SHALL only be present if code is present
    orderDetail.empty() or code.exists()
  • servicerequest-dispense-request-1: If the status is active, then requester must be present.
    status = 'active' implies requester.exists()
  • servicerequest-dispense-request-2: If the status is active, then the e-prescription-token must be present.
    status = 'active' implies extension('EPrescriptionToken').exists()
  • servicerequest-dispense-request-3: If the status is active, then the requester type must be Care Facility.
    status = 'active' implies requester.type = 'PFL'
  • servicerequest-dispense-request-4: If the status is completed, then the dispense data must be present.
    status = 'completed' implies supportingInfo.where(type='MedicationDispense').exists()
  • servicerequest-dispense-request-5: If the dispense data is present, then the dispense medication must be present.
    supportingInfo.where(type='MedicationDispense').exists() implies supportingInfo.where(type='Medication').exists()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request
  • v2: ORC
  • rim: Act[moodCode<=INT]
ServiceRequest.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

ServiceRequest.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.text
DefinitionA human-readable narrative that contains a summary of the resource and can 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
ServiceRequest.contained
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.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
ServiceRequest.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.extension:EPrescriptionToken
DefinitionOptional Extension Element - found in all resources.
Cardinality0...1
TypeExtension(ERPServiceRequestEPrescriptionToken)
Must SupportTrue
Aliasextensions, user content
Comments

The token is of the form '/Task/{PrescriptionID}/$accept?ac={AccessCode}. See gemSpec_DM_eRp'.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.modifierExtension
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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.identifier
DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Cardinality1...*
TypeIdentifier
Must SupportTrue
SummaryTrue
Comments

The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.

SlicingUnordered, Open, by system(Pattern)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Request.identifier
  • w5: FiveWs.identifier
  • v2: ORC.2, ORC.3, RF1-6 / RF1-11,
  • rim: .identifier
  • quick: ClinicalStatement.identifier
ServiceRequest.identifier:requestId
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality1...1
TypeERPServiceRequestRequestIdentifier
SummaryTrue
Comments

For referencing and assignment of ServiceRequest, e.g. if one ServiceRequest is to replace another, it is important to be able to make this assignment with the identifier. Can be mapped via a UUID, for example.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Request.identifier
  • w5: FiveWs.identifier
  • v2: ORC.2, ORC.3, RF1-6 / RF1-11,
  • rim: .identifier
  • quick: ClinicalStatement.identifier
ServiceRequest.instantiatesCanonical
DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Cardinality0...*
Typecanonical(ActivityDefinition | PlanDefinition)
SummaryTrue
Comments

Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.instantiatesCanonical
  • v2: Varies by domain
  • rim: .outboundRelationship[typeCode=DEFN].target
ServiceRequest.instantiatesUri
DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Cardinality0...*
Typeuri
SummaryTrue
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.instantiatesUri
  • v2: Varies by domain
  • rim: .outboundRelationship[typeCode=DEFN].target
ServiceRequest.basedOn
DefinitionPlan/proposal/order fulfilled by this request.
Cardinality0...*
TypeReference(CarePlan | ServiceRequest | MedicationRequest)
SummaryTrue
Aliasfulfills
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.basedOn
  • v2: ORC.8 (plus others)
  • rim: .outboundRelationship[typeCode=FLFS].target
ServiceRequest.replaces
DefinitionThe request takes the place of the referenced completed or terminated request(s).
Cardinality0...*
TypeReference(ServiceRequest)
SummaryTrue
Aliassupersedes, prior, renewed order
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.replaces
  • v2: Handled by message location of ORC (ORC.1=RO or RU)
  • rim: .outboundRelationship[typeCode=RPLC].target
ServiceRequest.requisition
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality1...1
TypeERPServiceRequestProcedureIdentifier
Must SupportTrue
SummaryTrue
AliasgrouperId, groupIdentifier
Requirements

Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes.

Comments

Is to be understood as a case or process ID in order to be able to track which request the ServiceRequest belongs to.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Request.groupIdentifier
  • v2: ORC.4
  • rim: .inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier
ServiceRequest.status
DefinitionThe status of the order.
Cardinality1...1
Typecode
Binding

The status of a service order.

ServiceRequestStatusVS (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

If the status changes, this value is overwritten.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.status
  • w5: FiveWs.status
  • v2: ORC.5,RF1-1
  • rim: .status
  • quick: Action.currentStatus
ServiceRequest.intent
DefinitionWhether the request is a proposal, plan, an original order or a reflex order.
Cardinality1...1
Typecode
Binding

The kind of service request.

RequestIntent (required)
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

filler-order

Mappings
  • rim: n/a
  • workflow: Request.intent
  • w5: FiveWs.class
  • v2: N/A
  • rim: .moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)
ServiceRequest.category
DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Cardinality0...*
TypeCodeableConcept
Binding

Classification of the requested service.

ServiceRequestCategoryCodes (example)
SummaryTrue
Requirements

Used for filtering what service request are retrieved and displayed.

Comments

There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • v2: RF1-5
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="INT"].code
ServiceRequest.priority
DefinitionThe priority can be used to indicate the urgency of the request.
Cardinality0...1
Typecode
Binding

Identifies the level of importance to be assigned to actioning the request.

ServiceRequestPriorityVS (required)
Must SupportTrue
SummaryTrue
Comments

Allowed values: routine | urgent

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.priority
  • w5: FiveWs.grade
  • v2: TQ1.9, RF1-2
  • rim: .priorityCode
ServiceRequest.doNotPerform
DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed.
Cardinality0...1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.

Comments

In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.doNotPerform
  • rim: .actionNegationInd
ServiceRequest.code
DefinitionA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
Cardinality0...1
TypeCodeableConcept
Binding

Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

ProcedureCodes(SNOMEDCT) (example)
Must SupportTrue
SummaryTrue
Aliasservice requested
Comments

Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.code
  • w5: FiveWs.what[x]
  • v2: PR1-3 / OBR-4 (varies by domain)
  • rim: .code
  • quick: Procedure.procedureCode
ServiceRequest.code.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ServiceRequest.code.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.code.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
BindingServiceRequestTypeVS (required)
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

{
  "system": "https://gematik.de/fhir/erp-servicerequest/CodeSystem/service-request-type-cs",
  "code": "dispense-request"
}

Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ServiceRequest.code.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ServiceRequest.code.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.code.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

https://gematik.de/fhir/erp-servicerequest/CodeSystem/service-request-type-cs

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
ServiceRequest.code.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
ServiceRequest.code.coding.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

#dispense-request serves as a service request for a pharmacy to deliver a prescription.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

dispense-request

Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
ServiceRequest.code.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
ServiceRequest.code.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ServiceRequest.code.text
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.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
ServiceRequest.orderDetail
DefinitionAdditional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
Cardinality0...*
TypeCodeableConcept
Binding

Codified order entry details which are based on order context.

ServiceRequestOrderDetailsCodes (example)
SummaryTrue
Aliasdetailed instructions
Comments

For information from the medical record intended to support the delivery of the requested services, use the supportingInformation element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: NTE
  • rim: .code
  • quick: Procedure.procedureCode
ServiceRequest.quantity[x]
DefinitionAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
Cardinality0...1
TypeQuantity
SummaryTrue
Requirements

When ordering a service the number of service items may need to be specified separately from the the service item.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NTE
  • rim: .quantity
ServiceRequest.subject
DefinitionOn whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
Cardinality1...1
TypeReference(ERPServiceRequestPatient)
Must SupportTrue
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.subject
  • w5: FiveWs.subject[x]
  • v2: PID
  • rim: .participation[typeCode=SBJ].role
  • quick: ClinicalStatement.subject
  • w5: FiveWs.subject
ServiceRequest.encounter
DefinitionAn encounter that provides additional information about the healthcare context in which this request is made.
Cardinality0...1
TypeReference(Encounter)
SummaryTrue
Aliascontext
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.encounter
  • w5: FiveWs.context
  • v2: PV1
  • rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
  • quick: ClinicalStatement.encounter
ServiceRequest.occurrence[x]
DefinitionThe date/time at which the requested service should occur.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Aliasschedule
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.occurrence[x]
  • w5: FiveWs.planned
  • v2: TQ1/TQ2, OBR-7/OBR-8
  • rim: .effectiveTime
  • quick: Procedure.procedureSchedule
ServiceRequest.asNeeded[x]
DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Cardinality0...1
Typeboolean
Binding

A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

SNOMEDCTMedicationAsNeededReasonCodes (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code="Assertion"].value
  • quick: Proposal.prnReason.reason
ServiceRequest.authoredOn
DefinitionWhen the request transitioned to being actionable.
Cardinality1...1
TypedateTime
Must SupportTrue
SummaryTrue
AliasorderedOn
Comments

Is initially created and then no longer changed.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.authoredOn
  • w5: FiveWs.recorded
  • v2: ORC.9, RF1-7 / RF1-9
  • rim: .participation[typeCode=AUT].time
  • quick: Proposal.proposedAtTime
ServiceRequest.requester
DefinitionThe individual who initiated the request and has responsibility for its activation.
Cardinality0...1
TypeReference(ERPServiceRequestOrganization)
Must SupportTrue
SummaryTrue
Aliasauthor, orderer
Comments

The KIM address is already stored in the message header. Therefore, the preferred specification is to store a KBV_PR_FOR_Practitioner.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.requester
  • w5: FiveWs.author
  • v2: ORC.12, PRT
  • rim: .participation[typeCode=AUT].role
  • quick: ClinicalStatement.statementAuthor
ServiceRequest.requester.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ServiceRequest.requester.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.requester.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.requester.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality1...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
Must SupportTrue
SummaryTrue
Comments

This value helps the receiving Systems to identify the source of the request.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

PFL

Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.requester.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
ServiceRequest.requester.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.performerType
DefinitionDesired type of performer for doing the requested service.
Cardinality0...1
TypeCodeableConcept
Binding

Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

ParticipantRoles (example)
SummaryTrue
Aliasspecialty
Comments

This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.performerType
  • w5: FiveWs.actor
  • v2: PRT, RF!-3
  • rim: .participation[typeCode=PRF].role[scoper.determinerCode=KIND].code
ServiceRequest.performer
DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
Cardinality0...*
TypeReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
SummaryTrue
Aliasrequest recipient
Comments

If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.performer
  • w5: FiveWs.actor
  • v2: PRT, Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT
  • rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
ServiceRequest.locationCode
DefinitionThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
Cardinality0...*
TypeCodeableConcept
Binding

A location type where services are delivered.

v3.ServiceDeliveryLocationRoleType (example)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.actor
  • rim: .participation[typeCode=LOC].role[scoper.determinerCode=KIND].code
ServiceRequest.locationReference
DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
Cardinality0...*
TypeReference(Location)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.actor
  • rim: .participation[typeCode=LOC].role[scoper.determinerCode=INSTANCE]
ServiceRequest.reasonCode
DefinitionAn explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
Cardinality0...*
TypeCodeableConcept
Binding

Diagnosis or problem codes justifying the reason for requesting the service investigation.

ProcedureReasonCodes (example)
SummaryTrue
Comments

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use CodeableConcept.text element if the data is free (uncoded) text as shown in the CT Scan example.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.reasonCode
  • w5: FiveWs.why[x]
  • v2: ORC.16, RF1-10
  • rim: .reasonCode
ServiceRequest.reasonReference
DefinitionIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.
Cardinality0...*
TypeReference(Condition | Observation | DiagnosticReport | DocumentReference)
SummaryTrue
Comments

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in DiagnosticReport.conclusion and/or DiagnosticReport.conclusionCode. When using a reference to DocumentReference, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in ServiceRequest.reasonCode if the data is free (uncoded) text as shown in the CT Scan example.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.reasonReference
  • w5: FiveWs.why[x]
  • v2: ORC.16
  • rim: .outboundRelationship[typeCode=RSON].target
ServiceRequest.insurance
DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
Cardinality0...*
TypeReference(Coverage | ClaimResponse)
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.insurance
  • v2: IN1/IN2
  • rim: .outboundRelationship[typeCode=COVBY].target
ServiceRequest.supportingInfo
DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
Cardinality0...*
TypeReference(Resource)
Must SupportTrue
AliasAsk at order entry question, AOE
Comments

To represent information about how the services are to be delivered use the instructions element.

SlicingUnordered, Open, by type(Pattern)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.supportingInfo
  • v2: Accompanying segments
  • rim: .outboundRelationship[typeCode=PERT].target
ServiceRequest.supportingInfo:AbgabeDaten
DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
Cardinality0...1
TypeReference(GEM_ERP_PR_MedicationDispense)
Must SupportTrue
AliasAsk at order entry question, AOE
Comments

To represent information about how the services are to be delivered use the instructions element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.supportingInfo
  • v2: Accompanying segments
  • rim: .outboundRelationship[typeCode=PERT].target
ServiceRequest.supportingInfo:AbgabeDaten.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ServiceRequest.supportingInfo:AbgabeDaten.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeDaten.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeDaten.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality1...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

MedicationDispense

Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeDaten.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
ServiceRequest.supportingInfo:AbgabeDaten.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeArzneimittel
DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
Cardinality0...1
TypeReference(https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Medication)
Must SupportTrue
AliasAsk at order entry question, AOE
Comments

To represent information about how the services are to be delivered use the instructions element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.supportingInfo
  • v2: Accompanying segments
  • rim: .outboundRelationship[typeCode=PERT].target
ServiceRequest.supportingInfo:AbgabeArzneimittel.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ServiceRequest.supportingInfo:AbgabeArzneimittel.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeArzneimittel.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeArzneimittel.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality1...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

Medication

Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.supportingInfo:AbgabeArzneimittel.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
ServiceRequest.supportingInfo:AbgabeArzneimittel.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.specimen
DefinitionOne or more specimens that the laboratory procedure will use.
Cardinality0...*
TypeReference(Specimen)
SummaryTrue
Comments

Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: SPM
  • rim: .participation[typeCode=SPC].role
ServiceRequest.bodySite
DefinitionAnatomic location where the procedure should be performed. This is the target site.
Cardinality0...*
TypeCodeableConcept
Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)
SummaryTrue
Aliaslocation
Requirements

Knowing where the procedure is performed is important for tracking if multiple sites are possible.

Comments

Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: SPM
  • rim: targetSiteCode
  • quick: Procedure.targetBodySite
ServiceRequest.note
DefinitionAny other notes and comments made about the service request. For example, internal billing notes.
Cardinality0...*
TypeAnnotation
Must SupportTrue
Comments

Any use cases that are not specified can be placed here in free text.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act
  • workflow: Request.note
  • v2: NTE
  • rim: .inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]
  • quick: ClinicalStatement.additionalText
ServiceRequest.note.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ServiceRequest.note.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.note.author[x]
DefinitionThe individual responsible for making the annotation.
Cardinality0...1
TypeReference(Practitioner | Patient | RelatedPerson | Organization)
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
ServiceRequest.note.time
DefinitionIndicates when this particular annotation was made.
Cardinality1...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

This is used in order to sort the Annotations

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.effectiveTime
ServiceRequest.note.text
DefinitionThe text of the annotation in markdown format.
Cardinality1...1
Typemarkdown
SummaryTrue
Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.text
ServiceRequest.patientInstruction
DefinitionInstructions in terms that are understood by the patient or consumer.
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NTE
  • rim: .text
ServiceRequest.relevantHistory
DefinitionKey events in the history of the request.
Cardinality0...*
TypeReference(Provenance)
Comments

This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.relevantHistory
  • v2: N/A
  • rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="erp-service-request-dispense-request" />
    <url value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" />
    <version value="1.2" />
    <name value="ERPServiceRequestDispenseRequest" />
    <title value="ERP Service Request Dispense Request" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2025-01-01" />
    <publisher value="gematik GmbH" />
    <description value="ServiceRequest that is used to supply a recipe" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="ServiceRequest" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ServiceRequest" />
    <derivation value="constraint" />
    <differential>
        <element id="ServiceRequest">
            <path value="ServiceRequest" />
            <constraint>
                <key value="servicerequest-dispense-request-1" />
                <severity value="error" />
                <human value="If the status is active, then requester must be present." />
                <expression value="status = &#39;active&#39; implies requester.exists()" />
                <source value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" />
            </constraint>
            <constraint>
                <key value="servicerequest-dispense-request-2" />
                <severity value="error" />
                <human value="If the status is active, then the e-prescription-token must be present." />
                <expression value="status = &#39;active&#39; implies extension(&#39;EPrescriptionToken&#39;).exists()" />
                <source value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" />
            </constraint>
            <constraint>
                <key value="servicerequest-dispense-request-3" />
                <severity value="error" />
                <human value="If the status is active, then the requester type must be Care Facility." />
                <expression value="status = &#39;active&#39; implies requester.type = &#39;PFL&#39;" />
                <source value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" />
            </constraint>
            <constraint>
                <key value="servicerequest-dispense-request-4" />
                <severity value="error" />
                <human value="If the status is completed, then the dispense data must be present." />
                <expression value="status = &#39;completed&#39; implies supportingInfo.where(type=&#39;MedicationDispense&#39;).exists()" />
                <source value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" />
            </constraint>
            <constraint>
                <key value="servicerequest-dispense-request-5" />
                <severity value="error" />
                <human value="If the dispense data is present, then the dispense medication must be present." />
                <expression value="supportingInfo.where(type=&#39;MedicationDispense&#39;).exists() implies supportingInfo.where(type=&#39;Medication&#39;).exists()" />
                <source value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" />
            </constraint>
        </element>
        <element id="ServiceRequest.extension">
            <path value="ServiceRequest.extension" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.extension:EPrescriptionToken">
            <path value="ServiceRequest.extension" />
            <sliceName value="EPrescriptionToken" />
            <short value="The e-prescription token for delivery to the pharmacy can be provided here." />
            <comment value="The token is of the form &#39;/Task/{PrescriptionID}/$accept?ac={AccessCode}. See [gemSpec_DM_eRp](https://fachportal.gematik.de/fachportal-import/files/gemSpec_DM_eRp_V1.5.0.pdf)&#39;." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/eprescription-token-ex" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.identifier">
            <path value="ServiceRequest.identifier" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="system" />
                </discriminator>
                <description value="Defines identifiers to be used in a process" />
                <rules value="open" />
            </slicing>
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.identifier:requestId">
            <path value="ServiceRequest.identifier" />
            <sliceName value="requestId" />
            <short value="Identifier that uniquely references a ServiceRequest." />
            <comment value="For referencing and assignment of ServiceRequest, e.g. if one ServiceRequest is to replace another, it is important to be able to make this assignment with the identifier. Can be mapped via a UUID, for example." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-identifier" />
            </type>
        </element>
        <element id="ServiceRequest.requisition">
            <path value="ServiceRequest.requisition" />
            <short value="Identifier of the process. All ServiceRequests within a process receive the same ID." />
            <comment value="Is to be understood as a case or process ID in order to be able to track which request the ServiceRequest belongs to." />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-procedure-identifier" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.status">
            <path value="ServiceRequest.status" />
            <short value="Indicates the processing status of a service request." />
            <comment value="If the status changes, this value is overwritten." />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-status-vs" />
            </binding>
        </element>
        <element id="ServiceRequest.intent">
            <path value="ServiceRequest.intent" />
            <fixedCode value="filler-order" />
        </element>
        <element id="ServiceRequest.priority">
            <path value="ServiceRequest.priority" />
            <short value="Indicates the urgency of the request." />
            <definition value="The priority can be used to indicate the urgency of the request." />
            <comment value="Allowed values: routine | urgent" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-priority-vs" />
            </binding>
        </element>
        <element id="ServiceRequest.code">
            <path value="ServiceRequest.code" />
            <short value="Indicates the type of service request." />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.code.coding">
            <path value="ServiceRequest.code.coding" />
            <min value="1" />
            <max value="1" />
            <fixedCoding>
                <system value="https://gematik.de/fhir/erp-servicerequest/CodeSystem/service-request-type-cs" />
                <code value="dispense-request" />
            </fixedCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-type-vs" />
            </binding>
        </element>
        <element id="ServiceRequest.code.coding.system">
            <path value="ServiceRequest.code.coding.system" />
            <min value="1" />
        </element>
        <element id="ServiceRequest.code.coding.code">
            <path value="ServiceRequest.code.coding.code" />
            <comment value="#dispense-request serves as a service request for a pharmacy to deliver a prescription." />
            <min value="1" />
        </element>
        <element id="ServiceRequest.subject">
            <path value="ServiceRequest.subject" />
            <short value="Patient for whom a dispense is requested on behalf of the patient." />
            <type>
                <code value="Reference" />
                <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-patient" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.occurrence[x]">
            <path value="ServiceRequest.occurrence[x]" />
            <short value="Indicates the date when the medication should be delivered." />
            <type>
                <code value="dateTime" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.authoredOn">
            <path value="ServiceRequest.authoredOn" />
            <short value="Creation date of the request." />
            <comment value="Is initially created and then no longer changed." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.requester">
            <path value="ServiceRequest.requester" />
            <short value="Inquiring facility or practitioner." />
            <comment value="The KIM address is already stored in the message header. Therefore, the preferred specification is to store a KBV_PR_FOR_Practitioner." />
            <type>
                <code value="Reference" />
                <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.requester.type">
            <path value="ServiceRequest.requester.type" />
            <short value="Care Facility as requester for the dispensation of the prescription" />
            <comment value="This value helps the receiving Systems to identify the source of the request." />
            <min value="1" />
            <fixedUri value="PFL" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.supportingInfo">
            <path value="ServiceRequest.supportingInfo" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="type" />
                </discriminator>
                <description value="Supporting information about dispense" />
                <rules value="open" />
            </slicing>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.supportingInfo:AbgabeDaten">
            <path value="ServiceRequest.supportingInfo" />
            <sliceName value="AbgabeDaten" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_MedicationDispense" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.supportingInfo:AbgabeDaten.type">
            <path value="ServiceRequest.supportingInfo.type" />
            <short value="Dispense data that is also sent to the e-prescription server." />
            <min value="1" />
            <fixedUri value="MedicationDispense" />
        </element>
        <element id="ServiceRequest.supportingInfo:AbgabeArzneimittel">
            <path value="ServiceRequest.supportingInfo" />
            <sliceName value="AbgabeArzneimittel" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Medication" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.supportingInfo:AbgabeArzneimittel.type">
            <path value="ServiceRequest.supportingInfo.type" />
            <short value="Medication data that is also sent to the e-prescription server." />
            <min value="1" />
            <fixedUri value="Medication" />
        </element>
        <element id="ServiceRequest.note">
            <path value="ServiceRequest.note" />
            <short value="Further information on the dispense request." />
            <comment value="Any use cases that are not specified can be placed here in free text." />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.note.time">
            <path value="ServiceRequest.note.time" />
            <comment value="This is used in order to sort the Annotations" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "erp-service-request-dispense-request",
    "url": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request",
    "version": "1.2",
    "name": "ERPServiceRequestDispenseRequest",
    "title": "ERP Service Request Dispense Request",
    "status": "draft",
    "experimental": false,
    "date": "2025-01-01",
    "publisher": "gematik GmbH",
    "description": "ServiceRequest that is used to supply a recipe",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "ServiceRequest",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ServiceRequest",
                "path": "ServiceRequest",
                "constraint":  [
                    {
                        "key": "servicerequest-dispense-request-1",
                        "severity": "error",
                        "human": "If the status is active, then requester must be present.",
                        "expression": "status = 'active' implies requester.exists()",
                        "source": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request"
                    },
                    {
                        "key": "servicerequest-dispense-request-2",
                        "severity": "error",
                        "human": "If the status is active, then the e-prescription-token must be present.",
                        "expression": "status = 'active' implies extension('EPrescriptionToken').exists()",
                        "source": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request"
                    },
                    {
                        "key": "servicerequest-dispense-request-3",
                        "severity": "error",
                        "human": "If the status is active, then the requester type must be Care Facility.",
                        "expression": "status = 'active' implies requester.type = 'PFL'",
                        "source": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request"
                    },
                    {
                        "key": "servicerequest-dispense-request-4",
                        "severity": "error",
                        "human": "If the status is completed, then the dispense data must be present.",
                        "expression": "status = 'completed' implies supportingInfo.where(type='MedicationDispense').exists()",
                        "source": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request"
                    },
                    {
                        "key": "servicerequest-dispense-request-5",
                        "severity": "error",
                        "human": "If the dispense data is present, then the dispense medication must be present.",
                        "expression": "supportingInfo.where(type='MedicationDispense').exists() implies supportingInfo.where(type='Medication').exists()",
                        "source": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request"
                    }
                ]
            },
            {
                "id": "ServiceRequest.extension",
                "path": "ServiceRequest.extension",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.extension:EPrescriptionToken",
                "path": "ServiceRequest.extension",
                "sliceName": "EPrescriptionToken",
                "short": "The e-prescription token for delivery to the pharmacy can be provided here.",
                "comment": "The token is of the form '/Task/{PrescriptionID}/$accept?ac={AccessCode}. See [gemSpec_DM_eRp](https://fachportal.gematik.de/fachportal-import/files/gemSpec_DM_eRp_V1.5.0.pdf)'.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/eprescription-token-ex"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.identifier",
                "path": "ServiceRequest.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "system"
                        }
                    ],
                    "rules": "open",
                    "description": "Defines identifiers to be used in a process"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.identifier:requestId",
                "path": "ServiceRequest.identifier",
                "sliceName": "requestId",
                "short": "Identifier that uniquely references a ServiceRequest.",
                "comment": "For referencing and assignment of ServiceRequest, e.g. if one ServiceRequest is to replace another, it is important to be able to make this assignment with the identifier. Can be mapped via a UUID, for example.",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-identifier"
                        ]
                    }
                ]
            },
            {
                "id": "ServiceRequest.requisition",
                "path": "ServiceRequest.requisition",
                "short": "Identifier of the process. All ServiceRequests within a process receive the same ID.",
                "comment": "Is to be understood as a case or process ID in order to be able to track which request the ServiceRequest belongs to.",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-procedure-identifier"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.status",
                "path": "ServiceRequest.status",
                "short": "Indicates the processing status of a service request.",
                "comment": "If the status changes, this value is overwritten.",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-status-vs"
                }
            },
            {
                "id": "ServiceRequest.intent",
                "path": "ServiceRequest.intent",
                "fixedCode": "filler-order"
            },
            {
                "id": "ServiceRequest.priority",
                "path": "ServiceRequest.priority",
                "short": "Indicates the urgency of the request.",
                "definition": "The priority can be used to indicate the urgency of the request.",
                "comment": "Allowed values: routine | urgent",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-priority-vs"
                }
            },
            {
                "id": "ServiceRequest.code",
                "path": "ServiceRequest.code",
                "short": "Indicates the type of service request.",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.code.coding",
                "path": "ServiceRequest.code.coding",
                "min": 1,
                "max": "1",
                "fixedCoding": {
                    "code": "dispense-request",
                    "system": "https://gematik.de/fhir/erp-servicerequest/CodeSystem/service-request-type-cs"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-type-vs"
                }
            },
            {
                "id": "ServiceRequest.code.coding.system",
                "path": "ServiceRequest.code.coding.system",
                "min": 1
            },
            {
                "id": "ServiceRequest.code.coding.code",
                "path": "ServiceRequest.code.coding.code",
                "comment": "#dispense-request serves as a service request for a pharmacy to deliver a prescription.",
                "min": 1
            },
            {
                "id": "ServiceRequest.subject",
                "path": "ServiceRequest.subject",
                "short": "Patient for whom a dispense is requested on behalf of the patient.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.occurrence[x]",
                "path": "ServiceRequest.occurrence[x]",
                "short": "Indicates the date when the medication should be delivered.",
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.authoredOn",
                "path": "ServiceRequest.authoredOn",
                "short": "Creation date of the request.",
                "comment": "Is initially created and then no longer changed.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.requester",
                "path": "ServiceRequest.requester",
                "short": "Inquiring facility or practitioner.",
                "comment": "The KIM address is already stored in the message header. Therefore, the preferred specification is to store a KBV_PR_FOR_Practitioner.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.requester.type",
                "path": "ServiceRequest.requester.type",
                "short": "Care Facility as requester for the dispensation of the prescription",
                "comment": "This value helps the receiving Systems to identify the source of the request.",
                "min": 1,
                "fixedUri": "PFL",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.supportingInfo",
                "path": "ServiceRequest.supportingInfo",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "type"
                        }
                    ],
                    "rules": "open",
                    "description": "Supporting information about dispense"
                },
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.supportingInfo:AbgabeDaten",
                "path": "ServiceRequest.supportingInfo",
                "sliceName": "AbgabeDaten",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_MedicationDispense"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.supportingInfo:AbgabeDaten.type",
                "path": "ServiceRequest.supportingInfo.type",
                "short": "Dispense data that is also sent to the e-prescription server.",
                "min": 1,
                "fixedUri": "MedicationDispense"
            },
            {
                "id": "ServiceRequest.supportingInfo:AbgabeArzneimittel",
                "path": "ServiceRequest.supportingInfo",
                "sliceName": "AbgabeArzneimittel",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Medication"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.supportingInfo:AbgabeArzneimittel.type",
                "path": "ServiceRequest.supportingInfo.type",
                "short": "Medication data that is also sent to the e-prescription server.",
                "min": 1,
                "fixedUri": "Medication"
            },
            {
                "id": "ServiceRequest.note",
                "path": "ServiceRequest.note",
                "short": "Further information on the dispense request.",
                "comment": "Any use cases that are not specified can be placed here in free text.",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.note.time",
                "path": "ServiceRequest.note.time",
                "comment": "This is used in order to sort the Annotations",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

Terminologie Bindings

Folgende Bindings sind für diese Ressource spezifiziert:

PathConformanceValueSet
ServiceRequest.statusrequiredhttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-status-vs
ServiceRequest.priorityrequiredhttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-priority-vs
ServiceRequest.code.codingrequiredhttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-request-type-vs

Constraints

Folgende Constraints sind für diese Ressource spezifiziert:

PfadIdGradeDetailsExpression
ServiceRequestservicerequest-dispense-request-1errorIf the status is active, then requester must be present.status = 'active' implies requester.exists()
ServiceRequestservicerequest-dispense-request-2errorIf the status is active, then the e-prescription-token must be present.status = 'active' implies extension('EPrescriptionToken').exists()
ServiceRequestservicerequest-dispense-request-3errorIf the status is active, then the requester type must be Care Facility.status = 'active' implies requester.type = 'PFL'
ServiceRequestservicerequest-dispense-request-4errorIf the status is completed, then the dispense data must be present.status = 'completed' implies supportingInfo.where(type='MedicationDispense').exists()
ServiceRequestservicerequest-dispense-request-5errorIf the dispense data is present, then the dispense medication must be present.supportingInfo.where(type='MedicationDispense').exists() implies supportingInfo.where(type='Medication').exists()