Vermittlungscode (ServiceRequest)


Fachlicher Kontext

Scope Art
Vermittlungscodestatus abrufen Ausgabeparameter (als Teil des Result Bundles)

Wie auf der Seite Vermittlungscode beschrieben, enthält die vorliegende Ressource neben dem Business-Identifier für eine Vermittlung noch folgende (mit dem Vermittlungscode assoziierte) Informationen:

  • Dringlichkeit
  • Status
  • Zeitpunkt der letzten Statusänderung
  • Leistungsmerkmalszuweisung

Diese Daten sind notwendig, um bei der Operation zum Abrufen des Status' eines Vermittlungscodes (siehe Vermittlungscodestatus abrufen) zusätzliche Informationen zu selbigem zurückgeben zu können. (Bei allen anderen Operationen muss nur die zugehörige bzw. zugrundeliegende Vermittlung identifiziert werden, weshalb nur der Business-Identifier dieser Vermittlung als Identifier-Ressource benötigt wird.)

Weiterführende Informationen und ein Vergleich zum Identifier-Profil sind ebenfalls auf der eingangs erwähnten Seite Vermittlungscode zu finden.

Details zur Benachrichtigung über Statusänderungen sind auf der Seite Workflow unter dem gleichnamigen Punkt Benachrichtigung über Statusänderungen zu finden.


FHIR-Profil

Name KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode
Type ServiceRequest
Base Definition http://hl7.org/fhir/StructureDefinition/ServiceRequest (Version: R4)
Canonical URL https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..0id
lastUpdatedΣ1..1instant
sourceΣ0..0uri
id0..1string
extensionI0..*Extension
value1..1System.StringPattern
securityΣ0..0CodingBinding
tagΣ0..0Coding
implicitRulesΣ ?!0..0uri
language0..0codeBinding
id0..1string
extensionI0..*Extension
statusS1..1codeBindingFixed Value
divS I1..1xhtml
contained0..0Resource
statusLeistungsmerkmalzuweisungS I1..1Extension(Coding)
modifierExtension?! I0..*Extension
identifierS Σ1..1KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode
instantiatesCanonicalΣ0..0canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..0uri
basedOnΣ I0..0Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..0Reference(ServiceRequest)
requisitionΣ0..0Identifier
statusS Σ ?!1..1codeBinding
intentS Σ ?!1..1codeBindingFixed Value
categoryΣ0..0CodeableConcept
priorityS Σ1..1codeBinding
doNotPerformΣ ?!0..0boolean
codeΣ0..0CodeableConcept
orderDetailΣ I0..0CodeableConcept
id0..1string
extensionI0..*Extension
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCodecode
value0..1System.String
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
encounterΣ I0..0Reference(Encounter)
authoredOnΣ0..0dateTime
requesterΣ I0..0Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)
performerTypeΣ0..0CodeableConcept
performerΣ I0..0Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..0CodeableConcept
locationReferenceΣ I0..0Reference(Location)
reasonCodeΣ0..0CodeableConcept
reasonReferenceΣ I0..0Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..0Reference(Coverage | ClaimResponse)
supportingInfoI0..0Reference(Resource)
specimenΣ I0..0Reference(Specimen)
bodySiteΣ0..0CodeableConcept
note0..0Annotation
patientInstructionΣ0..0string
relevantHistoryI0..0Reference(Provenance)
ServiceRequest
DefinitionEine Vermittlung im Kontext des 116117 Terminservices besteht aus einem Vermittlungscode, dem aktuellen Status der Vermittlung und der Angabe, ob Leistungsmerkmale mit diesem Vermittlungscode verknüpft sind.
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()
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.
Cardinality1...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.meta.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.meta.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.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...0
Typeid
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.meta.lastUpdated
DefinitionZeitpunkt, an dem sich der Status eines Vermittlungscodes verändert hat
Cardinality1...1
Typeinstant
SummaryTrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...0
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...*
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

SlicingUnordered, Open, by value(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.meta.profile:kvdigitalProfil
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...1
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ServiceRequest.meta.profile:kvdigitalProfil.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.meta.profile:kvdigitalProfil.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.meta.profile:kvdigitalProfil.value
DefinitionPrimitive value for canonical
Cardinality1...1
TypeSystem.String
Pattern

https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode|1.0.0

ServiceRequest.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...0
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

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 subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
ServiceRequest.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...0
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

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 subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
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...0
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...0
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
DefinitionIn diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.
Cardinality0...1
TypeNarrative
Must SupportTrue
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.text.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.text.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.text.status
DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Cardinality1...1
Typecode
Binding

The status of a resource narrative.

NarrativeStatus (required)
Must SupportTrue
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())
Fixed Value

extensions

Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.text.div
DefinitionThe actual narrative content, a stripped down version of XHTML.
Cardinality1...1
Typexhtml
Must SupportTrue
Comments

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
    htmlChecks()
  • txt-2: The narrative SHALL have some non-whitespace content
    htmlChecks()
Mappings
  • rim: n/a
  • rim: N/A
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...0
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.
Cardinality1...1
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:statusLeistungsmerkmalzuweisung
DefinitionAngabe, ob dem Vermittlungscode Leistungsmerkmale zugewiesen sind
Cardinality1...1
TypeExtension(Coding)
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.

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
DefinitionDer Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116 117 Terminservices und besteht aus 12 alphanumerischen Zeichen (ohne Bindestriche).
Cardinality1...1
TypeKBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode
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.

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...0
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...0
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...0
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...0
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
DefinitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
Cardinality0...0
TypeIdentifier
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

Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

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
Definitiondraft (frei) = Der Vermittlungscode enthält aktuell keine Buchung. active (gebucht) = Der Vermittlungscode enthält aktuell eine Buchung. on-hold (reserviert) = Für den Vermittlungscode liegt aktuell nur eine Reservierung, aber noch keine Buchung vor. revoked (abgesagt) = Die letzte Buchung zu diesem Vermittlungscode wurde durch den Patienten, den Arzt oder die TSS abgesagt. completed (Vermittlungsfrist abgelaufen) = Der Vermittlungscode ist abgelaufen.
Cardinality1...1
Typecode
Binding

Status der Vermittlung

KBV_VS_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Status (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.

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)
Must SupportTrue
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

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...0
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
DefinitionDie Dringlichkeit einer Überweisung: routine = nicht dringend urgent = dringend asap = akut
Cardinality1...1
Typecode
Binding

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

KBV_VS_KV_DIGITAL_TS_DRITTE_Urgency (required)
Must SupportTrue
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
  • 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...0
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...0
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)
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.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...0
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...0
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(Patient | Group | Location | Device)
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.subject.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.subject.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.subject.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.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Ein Vermittlungscode ist an einen Patienten gebunden; die Patentientendaten dürfen jedoch aus datenschutzrechtlichen Gründen nicht herausgegeben werden. Daher ist subject.reference durch die Extension data-absent-reason erweitert.

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.subject.reference.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.subject.reference.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.
Cardinality1...1
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.subject.reference.extension:dataAbsentReason
DefinitionProvides a reason why the expected value or elements in the element that is extended are missing.
Cardinality1...1
TypeExtension(code)
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.

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
  • rim: ANY.nullFlavor
ServiceRequest.subject.reference.extension:dataAbsentReason.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.subject.reference.extension:dataAbsentReason.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...0
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.subject.reference.extension:dataAbsentReason.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://hl7.org/fhir/StructureDefinition/data-absent-reason

Mappings
  • rim: N/A
ServiceRequest.subject.reference.extension:dataAbsentReason.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typecode
Binding

Used to specify why the normally expected content of the data element is missing.

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

masked

Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.subject.reference.value
DefinitionPrimitive value for string
Cardinality0...1
TypeSystem.String
ServiceRequest.subject.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).
Cardinality0...0
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())
Mappings
  • rim: n/a
  • rim: N/A
ServiceRequest.subject.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...0
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.subject.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
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.encounter
DefinitionAn encounter that provides additional information about the healthcare context in which this request is made.
Cardinality0...0
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...0
TypedateTime
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...0
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.
Cardinality0...0
TypedateTime
SummaryTrue
AliasorderedOn
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...0
TypeReference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)
SummaryTrue
Aliasauthor, orderer
Comments

This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.

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.performerType
DefinitionDesired type of performer for doing the requested service.
Cardinality0...0
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...0
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...0
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...0
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...0
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...0
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...0
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...0
TypeReference(Resource)
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.specimen
DefinitionOne or more specimens that the laboratory procedure will use.
Cardinality0...0
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...0
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...0
TypeAnnotation
Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

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.patientInstruction
DefinitionInstructions in terms that are understood by the patient or consumer.
Cardinality0...0
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...0
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="KBV-PR-KV-DIGITAL-TS-DRITTE-ServiceRequest-Vermittlungscode" />
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <url value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode" />
    <version value="1.0.0" />
    <name value="KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode" />
    <title value="KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode" />
    <status value="active" />
    <date value="2024-01" />
    <publisher value="kv.digital GmbH" />
    <contact>
        <name value="kv.digital GmbH" />
        <telecom>
            <system value="url" />
            <value value="https://www.kv.digital" />
        </telecom>
    </contact>
    <description value="Eine Vermittlung im Kontext des 116117 Terminservices besteht aus einem Vermittlungscode, dem aktuellen Status der Vermittlung und der Angabe, ob Leistungsmerkmale mit diesem Vermittlungscode verkn&#252;pft sind." />
    <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" />
            <short value="Vermittlung eines Patienten" />
            <definition value="Eine Vermittlung im Kontext des 116117 Terminservices besteht aus einem Vermittlungscode, dem aktuellen Status der Vermittlung und der Angabe, ob Leistungsmerkmale mit diesem Vermittlungscode verkn&#252;pft sind." />
        </element>
        <element id="ServiceRequest.meta">
            <path value="ServiceRequest.meta" />
            <min value="1" />
        </element>
        <element id="ServiceRequest.meta.versionId">
            <path value="ServiceRequest.meta.versionId" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.meta.lastUpdated">
            <path value="ServiceRequest.meta.lastUpdated" />
            <short value="Zeitpunkt der Status&#228;nderung" />
            <definition value="Zeitpunkt, an dem sich der Status eines Vermittlungscodes ver&#228;ndert hat" />
            <min value="1" />
        </element>
        <element id="ServiceRequest.meta.source">
            <path value="ServiceRequest.meta.source" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.meta.profile">
            <path value="ServiceRequest.meta.profile" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="value" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="ServiceRequest.meta.profile:kvdigitalProfil">
            <path value="ServiceRequest.meta.profile" />
            <sliceName value="kvdigitalProfil" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ServiceRequest.meta.profile:kvdigitalProfil.value">
            <path value="ServiceRequest.meta.profile.value" />
            <min value="1" />
            <patternCanonical value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode|1.0.0" />
        </element>
        <element id="ServiceRequest.meta.security">
            <path value="ServiceRequest.meta.security" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.meta.tag">
            <path value="ServiceRequest.meta.tag" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.implicitRules">
            <path value="ServiceRequest.implicitRules" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.language">
            <path value="ServiceRequest.language" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.text">
            <path value="ServiceRequest.text" />
            <definition value="In diesem Element k&#246;nnen die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden d&#252;rfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.text.status">
            <path value="ServiceRequest.text.status" />
            <fixedCode value="extensions" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.text.div">
            <path value="ServiceRequest.text.div" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.contained">
            <path value="ServiceRequest.contained" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.extension">
            <path value="ServiceRequest.extension" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.extension:statusLeistungsmerkmalzuweisung">
            <path value="ServiceRequest.extension" />
            <sliceName value="statusLeistungsmerkmalzuweisung" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Specialty_Assignment" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="ServiceRequest.identifier">
            <path value="ServiceRequest.identifier" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.instantiatesCanonical">
            <path value="ServiceRequest.instantiatesCanonical" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.instantiatesUri">
            <path value="ServiceRequest.instantiatesUri" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.basedOn">
            <path value="ServiceRequest.basedOn" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.replaces">
            <path value="ServiceRequest.replaces" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.requisition">
            <path value="ServiceRequest.requisition" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.status">
            <path value="ServiceRequest.status" />
            <short value="draft | active | on-hold | revoked | completed" />
            <definition value="draft (frei) = Der Vermittlungscode enth&#228;lt aktuell keine Buchung.\n\nactive (gebucht) = Der Vermittlungscode enth&#228;lt aktuell eine Buchung.\n\non-hold (reserviert) = F&#252;r den Vermittlungscode liegt aktuell nur eine Reservierung, aber noch keine Buchung vor.\n\nrevoked (abgesagt) = Die letzte Buchung zu diesem Vermittlungscode wurde durch den Patienten, den Arzt oder die TSS abgesagt.\n\ncompleted (Vermittlungsfrist abgelaufen) = Der Vermittlungscode ist abgelaufen." />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <description value="Status der Vermittlung" />
                <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Status" />
            </binding>
        </element>
        <element id="ServiceRequest.intent">
            <path value="ServiceRequest.intent" />
            <fixedCode value="order" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.category">
            <path value="ServiceRequest.category" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.priority">
            <path value="ServiceRequest.priority" />
            <short value="routine | urgent | asap" />
            <definition value="Die Dringlichkeit einer &#220;berweisung:\nroutine = nicht dringend\nurgent = dringend\nasap = akut" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Urgency" />
            </binding>
        </element>
        <element id="ServiceRequest.doNotPerform">
            <path value="ServiceRequest.doNotPerform" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.code">
            <path value="ServiceRequest.code" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.orderDetail">
            <path value="ServiceRequest.orderDetail" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.quantity[x]">
            <path value="ServiceRequest.quantity[x]" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.subject">
            <path value="ServiceRequest.subject" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.subject.reference">
            <path value="ServiceRequest.subject.reference" />
            <comment value="Ein Vermittlungscode ist an einen Patienten gebunden; die Patentientendaten d&#252;rfen jedoch aus datenschutzrechtlichen Gr&#252;nden nicht herausgegeben werden. Daher ist subject.reference durch die Extension data-absent-reason erweitert." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.subject.reference.extension">
            <path value="ServiceRequest.subject.reference.extension" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.subject.reference.extension:dataAbsentReason">
            <path value="ServiceRequest.subject.reference.extension" />
            <sliceName value="dataAbsentReason" />
            <min value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" />
            </type>
            <mustSupport value="true" />
            <isModifier value="false" />
        </element>
        <element id="ServiceRequest.subject.reference.extension:dataAbsentReason.value[x]">
            <path value="ServiceRequest.subject.reference.extension.value[x]" />
            <fixedCode value="masked" />
            <mustSupport value="true" />
        </element>
        <element id="ServiceRequest.subject.type">
            <path value="ServiceRequest.subject.type" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.subject.identifier">
            <path value="ServiceRequest.subject.identifier" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.subject.display">
            <path value="ServiceRequest.subject.display" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.encounter">
            <path value="ServiceRequest.encounter" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.occurrence[x]">
            <path value="ServiceRequest.occurrence[x]" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.asNeeded[x]">
            <path value="ServiceRequest.asNeeded[x]" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.authoredOn">
            <path value="ServiceRequest.authoredOn" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.requester">
            <path value="ServiceRequest.requester" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.performerType">
            <path value="ServiceRequest.performerType" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.performer">
            <path value="ServiceRequest.performer" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.locationCode">
            <path value="ServiceRequest.locationCode" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.locationReference">
            <path value="ServiceRequest.locationReference" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.reasonCode">
            <path value="ServiceRequest.reasonCode" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.reasonReference">
            <path value="ServiceRequest.reasonReference" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.insurance">
            <path value="ServiceRequest.insurance" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.supportingInfo">
            <path value="ServiceRequest.supportingInfo" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.specimen">
            <path value="ServiceRequest.specimen" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.bodySite">
            <path value="ServiceRequest.bodySite" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.note">
            <path value="ServiceRequest.note" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.patientInstruction">
            <path value="ServiceRequest.patientInstruction" />
            <max value="0" />
        </element>
        <element id="ServiceRequest.relevantHistory">
            <path value="ServiceRequest.relevantHistory" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "KBV-PR-KV-DIGITAL-TS-DRITTE-ServiceRequest-Vermittlungscode",
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode",
    "version": "1.0.0",
    "name": "KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode",
    "title": "KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode",
    "status": "active",
    "date": "2024-01",
    "publisher": "kv.digital GmbH",
    "contact":  [
        {
            "name": "kv.digital GmbH",
            "telecom":  [
                {
                    "system": "url",
                    "value": "https://www.kv.digital"
                }
            ]
        }
    ],
    "description": "Eine Vermittlung im Kontext des 116117 Terminservices besteht aus einem Vermittlungscode, dem aktuellen Status der Vermittlung und der Angabe, ob Leistungsmerkmale mit diesem Vermittlungscode verknüpft sind.",
    "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",
                "short": "Vermittlung eines Patienten",
                "definition": "Eine Vermittlung im Kontext des 116117 Terminservices besteht aus einem Vermittlungscode, dem aktuellen Status der Vermittlung und der Angabe, ob Leistungsmerkmale mit diesem Vermittlungscode verknüpft sind."
            },
            {
                "id": "ServiceRequest.meta",
                "path": "ServiceRequest.meta",
                "min": 1
            },
            {
                "id": "ServiceRequest.meta.versionId",
                "path": "ServiceRequest.meta.versionId",
                "max": "0"
            },
            {
                "id": "ServiceRequest.meta.lastUpdated",
                "path": "ServiceRequest.meta.lastUpdated",
                "short": "Zeitpunkt der Statusänderung",
                "definition": "Zeitpunkt, an dem sich der Status eines Vermittlungscodes verändert hat",
                "min": 1
            },
            {
                "id": "ServiceRequest.meta.source",
                "path": "ServiceRequest.meta.source",
                "max": "0"
            },
            {
                "id": "ServiceRequest.meta.profile",
                "path": "ServiceRequest.meta.profile",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "value"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "ServiceRequest.meta.profile:kvdigitalProfil",
                "path": "ServiceRequest.meta.profile",
                "sliceName": "kvdigitalProfil",
                "min": 1,
                "max": "1"
            },
            {
                "id": "ServiceRequest.meta.profile:kvdigitalProfil.value",
                "path": "ServiceRequest.meta.profile.value",
                "min": 1,
                "patternCanonical": "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode|1.0.0"
            },
            {
                "id": "ServiceRequest.meta.security",
                "path": "ServiceRequest.meta.security",
                "max": "0"
            },
            {
                "id": "ServiceRequest.meta.tag",
                "path": "ServiceRequest.meta.tag",
                "max": "0"
            },
            {
                "id": "ServiceRequest.implicitRules",
                "path": "ServiceRequest.implicitRules",
                "max": "0"
            },
            {
                "id": "ServiceRequest.language",
                "path": "ServiceRequest.language",
                "max": "0"
            },
            {
                "id": "ServiceRequest.text",
                "path": "ServiceRequest.text",
                "definition": "In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.text.status",
                "path": "ServiceRequest.text.status",
                "fixedCode": "extensions",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.text.div",
                "path": "ServiceRequest.text.div",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.contained",
                "path": "ServiceRequest.contained",
                "max": "0"
            },
            {
                "id": "ServiceRequest.extension",
                "path": "ServiceRequest.extension",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.extension:statusLeistungsmerkmalzuweisung",
                "path": "ServiceRequest.extension",
                "sliceName": "statusLeistungsmerkmalzuweisung",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Specialty_Assignment"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "ServiceRequest.identifier",
                "path": "ServiceRequest.identifier",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.instantiatesCanonical",
                "path": "ServiceRequest.instantiatesCanonical",
                "max": "0"
            },
            {
                "id": "ServiceRequest.instantiatesUri",
                "path": "ServiceRequest.instantiatesUri",
                "max": "0"
            },
            {
                "id": "ServiceRequest.basedOn",
                "path": "ServiceRequest.basedOn",
                "max": "0"
            },
            {
                "id": "ServiceRequest.replaces",
                "path": "ServiceRequest.replaces",
                "max": "0"
            },
            {
                "id": "ServiceRequest.requisition",
                "path": "ServiceRequest.requisition",
                "max": "0"
            },
            {
                "id": "ServiceRequest.status",
                "path": "ServiceRequest.status",
                "short": "draft | active | on-hold | revoked | completed",
                "definition": "draft (frei) = Der Vermittlungscode enthält aktuell keine Buchung.\n\nactive (gebucht) = Der Vermittlungscode enthält aktuell eine Buchung.\n\non-hold (reserviert) = Für den Vermittlungscode liegt aktuell nur eine Reservierung, aber noch keine Buchung vor.\n\nrevoked (abgesagt) = Die letzte Buchung zu diesem Vermittlungscode wurde durch den Patienten, den Arzt oder die TSS abgesagt.\n\ncompleted (Vermittlungsfrist abgelaufen) = Der Vermittlungscode ist abgelaufen.",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "Status der Vermittlung",
                    "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Status"
                }
            },
            {
                "id": "ServiceRequest.intent",
                "path": "ServiceRequest.intent",
                "fixedCode": "order",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.category",
                "path": "ServiceRequest.category",
                "max": "0"
            },
            {
                "id": "ServiceRequest.priority",
                "path": "ServiceRequest.priority",
                "short": "routine | urgent | asap",
                "definition": "Die Dringlichkeit einer Überweisung:\nroutine = nicht dringend\nurgent = dringend\nasap = akut",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Urgency"
                }
            },
            {
                "id": "ServiceRequest.doNotPerform",
                "path": "ServiceRequest.doNotPerform",
                "max": "0"
            },
            {
                "id": "ServiceRequest.code",
                "path": "ServiceRequest.code",
                "max": "0"
            },
            {
                "id": "ServiceRequest.orderDetail",
                "path": "ServiceRequest.orderDetail",
                "max": "0"
            },
            {
                "id": "ServiceRequest.quantity[x]",
                "path": "ServiceRequest.quantity[x]",
                "max": "0"
            },
            {
                "id": "ServiceRequest.subject",
                "path": "ServiceRequest.subject",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.subject.reference",
                "path": "ServiceRequest.subject.reference",
                "comment": "Ein Vermittlungscode ist an einen Patienten gebunden; die Patentientendaten dürfen jedoch aus datenschutzrechtlichen Gründen nicht herausgegeben werden. Daher ist subject.reference durch die Extension data-absent-reason erweitert.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.subject.reference.extension",
                "path": "ServiceRequest.subject.reference.extension",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.subject.reference.extension:dataAbsentReason",
                "path": "ServiceRequest.subject.reference.extension",
                "sliceName": "dataAbsentReason",
                "min": 1,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
                        ]
                    }
                ],
                "mustSupport": true,
                "isModifier": false
            },
            {
                "id": "ServiceRequest.subject.reference.extension:dataAbsentReason.value[x]",
                "path": "ServiceRequest.subject.reference.extension.value[x]",
                "fixedCode": "masked",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.subject.type",
                "path": "ServiceRequest.subject.type",
                "max": "0"
            },
            {
                "id": "ServiceRequest.subject.identifier",
                "path": "ServiceRequest.subject.identifier",
                "max": "0"
            },
            {
                "id": "ServiceRequest.subject.display",
                "path": "ServiceRequest.subject.display",
                "max": "0"
            },
            {
                "id": "ServiceRequest.encounter",
                "path": "ServiceRequest.encounter",
                "max": "0"
            },
            {
                "id": "ServiceRequest.occurrence[x]",
                "path": "ServiceRequest.occurrence[x]",
                "max": "0"
            },
            {
                "id": "ServiceRequest.asNeeded[x]",
                "path": "ServiceRequest.asNeeded[x]",
                "max": "0"
            },
            {
                "id": "ServiceRequest.authoredOn",
                "path": "ServiceRequest.authoredOn",
                "max": "0"
            },
            {
                "id": "ServiceRequest.requester",
                "path": "ServiceRequest.requester",
                "max": "0"
            },
            {
                "id": "ServiceRequest.performerType",
                "path": "ServiceRequest.performerType",
                "max": "0"
            },
            {
                "id": "ServiceRequest.performer",
                "path": "ServiceRequest.performer",
                "max": "0"
            },
            {
                "id": "ServiceRequest.locationCode",
                "path": "ServiceRequest.locationCode",
                "max": "0"
            },
            {
                "id": "ServiceRequest.locationReference",
                "path": "ServiceRequest.locationReference",
                "max": "0"
            },
            {
                "id": "ServiceRequest.reasonCode",
                "path": "ServiceRequest.reasonCode",
                "max": "0"
            },
            {
                "id": "ServiceRequest.reasonReference",
                "path": "ServiceRequest.reasonReference",
                "max": "0"
            },
            {
                "id": "ServiceRequest.insurance",
                "path": "ServiceRequest.insurance",
                "max": "0"
            },
            {
                "id": "ServiceRequest.supportingInfo",
                "path": "ServiceRequest.supportingInfo",
                "max": "0"
            },
            {
                "id": "ServiceRequest.specimen",
                "path": "ServiceRequest.specimen",
                "max": "0"
            },
            {
                "id": "ServiceRequest.bodySite",
                "path": "ServiceRequest.bodySite",
                "max": "0"
            },
            {
                "id": "ServiceRequest.note",
                "path": "ServiceRequest.note",
                "max": "0"
            },
            {
                "id": "ServiceRequest.patientInstruction",
                "path": "ServiceRequest.patientInstruction",
                "max": "0"
            },
            {
                "id": "ServiceRequest.relevantHistory",
                "path": "ServiceRequest.relevantHistory",
                "max": "0"
            }
        ]
    }
}

Anmerkungen

In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Feldern.

Feld Anmerkung
ServiceRequest.meta.lastUpdated

Auch wenn es sich um ein Meta-Datum handelt, ist der Zeitpunkt der letzten Statusänderung relevant für die Implementierung, wenn bspw. abgeglichen werden soll, ob sich der Status des Vermittlungscodes seit der letzten Abfrage geändert hat (weitere Informationen dazu sind auf der Seite Workflow unter dem Punkt Benachrichtigung über Statusänderungen zu finden).

Der Zeitstempel bezieht sich ausschließlich auf die Änderung des Status', niemals auf andere Änderungen der Ressource (wobei sich die Werte der anderen Felder aktuell auch nicht mehr ändern sollten, sobald die Ressource erstellt wurde).
ServiceRequest.identifier siehe Vermittlungscode (Identifier)
ServiceRequest.status

Da im Basis-Profil für dieses Feld ein Wert aus dem CodeSystem RequestStatus erzwungen wird, wurde basierend darauf das ValueSet Vermittlungscode_Status erstellt, das nur die für die Terminschnittstelle für Dritte relevanten Werte zulässt. Da einige Codings dadurch keinen sprechenden Namen mehr haben, wurde in der Definition des Feldes die Bedeutung der Codings im Kontext des 116117 Terminservice beschrieben.

Informationen zur Benachrichtigung über Statusänderungen sind auf der Seite Workflow im gleichnamigen Abschnitt Benachrichtigung über Statusänderungen zu finden.
ServiceRequest.intent Dieses Feld wird als solches eigentlich nicht benötigt. Da dieses jedoch vom Basisprofil mit einer Kardinalität von 1..1 erzwungen wird, ist hierfür der fixed value order vorgeschrieben.
ServiceRequest.subject Dieses Feld wird durch das Basis-Profil mit einer Kardinalität von 1..1 erzwungen, kann durch die Systeme der Terminschnittstelle für Dritte jedoch nicht befüllt werden, da im Kontext des 116117 Terminservice ein Vermittlungscode zwar an einen Patienten gebunden ist, Patientendaten von den Systemen der Terminschnittstelle für Dritte aus datenschutzrechtlichen Gründen jedoch nicht gespeichert oder zurückgegeben werden dürfen. Daher ist unter .subject.reference die Extension dataAbsentReason mit dem fixed value masked zu finden.

Beispiele

Alle Beispiele sind hier im vorliegenden Projekt zu finden.


<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="42814323-80ae-40e8-9eee-a0bc4257a639" />
    <meta>
        <lastUpdated value="2024-02-02T08:17:48Z" />
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode|1.0.0" />
    </meta>
    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Specialty_Assignment">
        <valueCoding>
            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Specialty_Assignment" />
            <code value="​gebunden" />
            <display value="Es sind Leistungsmerkmale mit dem Vermittlungscode assoziiert." />
        </valueCoding>
    </extension>
    <identifier>
        <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_KV_DIGITAL_TS_DRITTE_Vermittlungscode" />
        <value value="XN6XF4UPZ5KP" />
    </identifier>
    <status value="active" />
    <intent value="order" />
    <priority value="urgent" />
    <subject>
        <reference>
            <extension url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
                <valueCode value="masked" />
            </extension>
        </reference>
    </subject>
</ServiceRequest>