ERP ServiceRequest Prescription Token

Übersicht über das Profil

NameDescriptionCanonical_URLStatusVersionBasiert auf
ERPServiceRequestEPrescriptionToken

Identifier containing an e-prescription token

https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-eprescription-tokendraft1.2http://hl7.org/fhir/StructureDefinition/Identifier

Über das Profil

Motivation

Dieses Identifier Profil wurde angelegt, damit der E-Rezept Token in einer bestätigten Rezept- und in einer Dispensieranforderung anzugeben.

Inhalt des Profils

Folgende Ansichten existieren auf das Profil:

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
Identifier
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality0...*
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
Identifier.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
Identifier.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
Identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

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: Role.code or implied by context
Identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

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: CX.5
  • rim: Role.code or implied by context
Identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

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

https://gematik.de/fhir/erp/sid/NamingSystemEPrescriptionToken

Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

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

123456


Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="erp-service-request-eprescription-token" />
    <url value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-eprescription-token" />
    <version value="1.2" />
    <name value="ERPServiceRequestEPrescriptionToken" />
    <title value="ERP Service Request EPrescription Token" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2025-01-01" />
    <publisher value="gematik GmbH" />
    <description value="Identifier containing an e-prescription token" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <type value="Identifier" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier" />
    <derivation value="constraint" />
    <differential>
        <element id="Identifier.system">
            <path value="Identifier.system" />
            <min value="1" />
            <fixedUri value="https://gematik.de/fhir/erp/sid/NamingSystemEPrescriptionToken" />
            <mustSupport value="true" />
        </element>
        <element id="Identifier.value">
            <path value="Identifier.value" />
            <short value="Specification of the e-prescription token" />
            <comment value="The token is of the form &#39;/Task/{PrescriptionID}/$accept?ac={AccessCode}. See [gemSpec_DM_eRp](https://fachportal.gematik.de/fachportal-import/files/gemSpec_DM_eRp_V1.5.0.pdf)&#39;." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "erp-service-request-eprescription-token",
    "url": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-eprescription-token",
    "version": "1.2",
    "name": "ERPServiceRequestEPrescriptionToken",
    "title": "ERP Service Request EPrescription Token",
    "status": "draft",
    "experimental": false,
    "date": "2025-01-01",
    "publisher": "gematik GmbH",
    "description": "Identifier containing an e-prescription token",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "type": "Identifier",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Identifier.system",
                "path": "Identifier.system",
                "min": 1,
                "fixedUri": "https://gematik.de/fhir/erp/sid/NamingSystemEPrescriptionToken",
                "mustSupport": true
            },
            {
                "id": "Identifier.value",
                "path": "Identifier.value",
                "short": "Specification of the e-prescription token",
                "comment": "The token is of the form '/Task/{PrescriptionID}/$accept?ac={AccessCode}. See [gemSpec_DM_eRp](https://fachportal.gematik.de/fachportal-import/files/gemSpec_DM_eRp_V1.5.0.pdf)'.",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

Terminologie Bindings

Folgende Bindings sind für diese Ressource spezifiziert:

Constraints

Folgende Constraints sind für diese Ressource spezifiziert: