Operation Definition: Provide Dispensation

NameDefinition
$provide-dispensationhttps://gematik.de/fhir/epa-medication/OperationDefinition/provide-dispensation-OP

Anforderungen

Invocations

URL: [base]/$provide-dispensation

Parameters (In)

NameCardinalityTypeDocumentation
dispensation1..*
dispensation.medicationDispense1..1MedicationDispense
dispensation.medication1..1Medication
performerInstitution1..1Organization

Tätige Leistungserbringerinstitution, die die Schreiboperation generell ausübt. Die Angabe der Leistungserbringerinstitution ist mandatorisch, denn hier erfolgt die Übereinstimmungsprüfung hinsichtlich der aktuell zugreifenden LEI.

Return Values (Out)

NameCardinalityTypeDocumentation
dispensation1..*
dispensation.medicationDispense0..1MedicationDispense
dispensation.medication0..1Medication
dispensation.operationOutcome0..1OperationOutcome

OperationDefinition
<OperationDefinition xmlns="http://hl7.org/fhir">
    <id value="provide-dispensation-OP" />
    <url value="https://gematik.de/fhir/epa-medication/OperationDefinition/provide-dispensation-OP" />
    <version value="1.1.1" />
    <name value="Provide Dispensation" />
    <title value="Provide Dispensation" />
    <status value="active" />
    <kind value="operation" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="The $provide-dispensation operation in the ePA Medication Service is used to record information about the dispensing of non-prescription dispensations." />
    <code value="provide-dispensation" />
    <system value="true" />
    <type value="false" />
    <instance value="false" />
    <inputProfile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-provide-dispensation-input-parameters" />
    <outputProfile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-dispensation-output-parameters" />
    <parameter>
        <name value="dispensation" />
        <use value="in" />
        <min value="1" />
        <max value="*" />
        <part>
            <name value="medicationDispense" />
            <use value="in" />
            <min value="1" />
            <max value="1" />
            <type value="MedicationDispense" />
        </part>
        <part>
            <name value="medication" />
            <use value="in" />
            <min value="1" />
            <max value="1" />
            <type value="Medication" />
        </part>
    </parameter>
    <parameter>
        <name value="performerInstitution" />
        <use value="in" />
        <min value="1" />
        <max value="1" />
        <documentation value="T&#228;tige Leistungserbringerinstitution, die die Schreiboperation generell aus&#252;bt. Die Angabe der Leistungserbringerinstitution ist mandatorisch, denn hier erfolgt die &#220;bereinstimmungspr&#252;fung hinsichtlich der aktuell zugreifenden LEI." />
        <type value="Organization" />
    </parameter>
    <parameter>
        <name value="dispensation" />
        <use value="out" />
        <min value="1" />
        <max value="*" />
        <part>
            <name value="medicationDispense" />
            <use value="out" />
            <min value="0" />
            <max value="1" />
            <type value="MedicationDispense" />
        </part>
        <part>
            <name value="medication" />
            <use value="out" />
            <min value="0" />
            <max value="1" />
            <type value="Medication" />
        </part>
        <part>
            <name value="operationOutcome" />
            <use value="out" />
            <min value="0" />
            <max value="1" />
            <type value="OperationOutcome" />
        </part>
    </parameter>
</OperationDefinition>
{
    "resourceType": "OperationDefinition",
    "id": "provide-dispensation-OP",
    "url": "https://gematik.de/fhir/epa-medication/OperationDefinition/provide-dispensation-OP",
    "title": "Provide Dispensation",
    "description": "The $provide-dispensation operation in the ePA Medication Service is used to record information about the dispensing of non-prescription dispensations.",
    "version": "1.1.1",
    "status": "active",
    "publisher": "gematik GmbH",
    "date": "2024-08-14",
    "name": "Provide Dispensation",
    "kind": "operation",
    "code": "provide-dispensation",
    "system": true,
    "type": false,
    "instance": false,
    "inputProfile": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-provide-dispensation-input-parameters",
    "outputProfile": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-dispensation-output-parameters",
    "parameter":  [
        {
            "name": "dispensation",
            "use": "in",
            "min": 1,
            "max": "*",
            "part":  [
                {
                    "name": "medicationDispense",
                    "type": "MedicationDispense",
                    "use": "in",
                    "min": 1,
                    "max": "1"
                },
                {
                    "name": "medication",
                    "type": "Medication",
                    "use": "in",
                    "min": 1,
                    "max": "1"
                }
            ]
        },
        {
            "name": "performerInstitution",
            "type": "Organization",
            "use": "in",
            "min": 1,
            "max": "1",
            "documentation": "Tätige Leistungserbringerinstitution, die die Schreiboperation generell ausübt. Die Angabe der Leistungserbringerinstitution ist mandatorisch, denn hier erfolgt die Übereinstimmungsprüfung hinsichtlich der aktuell zugreifenden LEI."
        },
        {
            "name": "dispensation",
            "use": "out",
            "min": 1,
            "max": "*",
            "part":  [
                {
                    "name": "medicationDispense",
                    "type": "MedicationDispense",
                    "use": "out",
                    "min": 0,
                    "max": "1"
                },
                {
                    "name": "medication",
                    "type": "Medication",
                    "use": "out",
                    "min": 0,
                    "max": "1"
                },
                {
                    "name": "operationOutcome",
                    "type": "OperationOutcome",
                    "use": "out",
                    "min": 0,
                    "max": "1"
                }
            ]
        }
    ]
}

Input-Parameterprofil

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I0..0Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1EPANonPrescriptionMedicationDispense
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1EPAMedication
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1OrganizationDirectory
partΣ0..0see (parameter)
Parameters
DefinitionThis resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.
Cardinality0...*
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Mappings
  • rim: Entity. Role, or Act
  • v2: n/a
  • rim: n/a
Parameters.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.

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

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

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

A human language.

CommonLanguages (preferred)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter
DefinitionA parameter passed to or received from the operation.
Cardinality2...*
TypeBackboneElement
SummaryTrue
SlicingUnordered, Closed, by name(Pattern)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Mappings
  • rim: n/a
Parameters.parameter.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
Parameters.parameter.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
Parameters.parameter.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...1
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter.resource
DefinitionIf the parameter is a whole resource.
Cardinality0...1
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

Mappings
  • rim: Entity. Role, or Act
Parameters.parameter.part
DefinitionA named part of a multi-part parameter.
Cardinality0...*
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation
DefinitionA parameter passed to or received from the operation.
Cardinality1...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Mappings
  • rim: n/a
Parameters.parameter:dispensation.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
Parameters.parameter:dispensation.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
Parameters.parameter:dispensation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

dispensation

Mappings
  • rim: n/a
Parameters.parameter:dispensation.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.resource
DefinitionIf the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

Mappings
  • rim: Entity. Role, or Act
Parameters.parameter:dispensation.part
DefinitionA named part of a multi-part parameter.
Cardinality2...*
Typesee (parameter)
Must SupportTrue
SummaryTrue
Comments

Only one level of nested parameters is allowed.

SlicingUnordered, Closed, by name(Pattern)
Parameters.parameter:dispensation.part:medicationDispense
DefinitionA named part of a multi-part parameter.
Cardinality1...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:medicationDispense.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
Parameters.parameter:dispensation.part:medicationDispense.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
Parameters.parameter:dispensation.part:medicationDispense.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.part:medicationDispense.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

medicationDispense

Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medicationDispense.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medicationDispense.resource
DefinitionIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
Cardinality1...1
TypeEPANonPrescriptionMedicationDispense
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

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()
  • mdd-1: whenHandedOver cannot be before whenPrepared
    whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Supply[moodCode=EVN]
Parameters.parameter:dispensation.part:medicationDispense.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:medication
DefinitionA named part of a multi-part parameter.
Cardinality1...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:medication.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
Parameters.parameter:dispensation.part:medication.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
Parameters.parameter:dispensation.part:medication.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.part:medication.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

medication

Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medication.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medication.resource
DefinitionThis resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
Cardinality1...1
TypeEPAMedication
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

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()
  • epa-med-1: Medication code, name, or ingredients must be specified
    code.exists() or ingredient.exists()
  • epa-med-2: Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference
    extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()
  • epa-med-3: Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference
    extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()
Mappings
  • rim: Entity. Role, or Act
  • script10.6: NewRx/MedicationPrescribed -or- RxFill/MedicationDispensed -or- RxHistoryResponse/MedicationDispensed -or- RxHistoryResponse/MedicationPrescribed
  • rim: ManufacturedProduct[classCode=ADMM]
Parameters.parameter:dispensation.part:medication.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:performerInstitution
DefinitionA parameter passed to or received from the operation.
Cardinality1...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Mappings
  • rim: n/a
Parameters.parameter:performerInstitution.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
Parameters.parameter:performerInstitution.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
Parameters.parameter:performerInstitution.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:performerInstitution.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

performerInstitution

Mappings
  • rim: n/a
Parameters.parameter:performerInstitution.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:performerInstitution.resource
DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
Cardinality1...1
TypeOrganizationDirectory
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

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()
  • org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
    (identifier.count() + name.count()) > 0
Mappings
  • rim: Entity. Role, or Act
  • v2: (also see master files messages)
  • rim: Organization(classCode=ORG, determinerCode=INST)
  • servd: Organization
Parameters.parameter:performerInstitution.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-op-provide-dispensation-input-parameters" />
    <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-provide-dispensation-input-parameters" />
    <version value="1.1.1" />
    <name value="EPAOpProvideDispensationInputParameters" />
    <title value="EPA Operation Provide Dispensation Input-Parameters" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="EPA Operation Provide Dispensation Input-Parameters" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Parameters" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Parameters" />
    <derivation value="constraint" />
    <differential>
        <element id="Parameters.parameter">
            <path value="Parameters.parameter" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="name" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="2" />
        </element>
        <element id="Parameters.parameter:dispensation">
            <path value="Parameters.parameter" />
            <sliceName value="dispensation" />
            <min value="1" />
            <max value="*" />
        </element>
        <element id="Parameters.parameter:dispensation.name">
            <path value="Parameters.parameter.name" />
            <patternString value="dispensation" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.value[x]">
            <path value="Parameters.parameter.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.resource">
            <path value="Parameters.parameter.resource" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part">
            <path value="Parameters.parameter.part" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="name" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="2" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense">
            <path value="Parameters.parameter.part" />
            <sliceName value="medicationDispense" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="medicationDispense" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="MedicationDispense" />
                <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-nonrescription-medication-dispense" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medication">
            <path value="Parameters.parameter.part" />
            <sliceName value="medication" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="medication" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="Medication" />
                <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performerInstitution">
            <path value="Parameters.parameter" />
            <sliceName value="performerInstitution" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Parameters.parameter:performerInstitution.name">
            <path value="Parameters.parameter.name" />
            <patternString value="performerInstitution" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performerInstitution.value[x]">
            <path value="Parameters.parameter.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performerInstitution.resource">
            <path value="Parameters.parameter.resource" />
            <min value="1" />
            <type>
                <code value="Organization" />
                <profile value="https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory" />
            </type>
        </element>
        <element id="Parameters.parameter:performerInstitution.part">
            <path value="Parameters.parameter.part" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-op-provide-dispensation-input-parameters",
    "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-provide-dispensation-input-parameters",
    "version": "1.1.1",
    "name": "EPAOpProvideDispensationInputParameters",
    "title": "EPA Operation Provide Dispensation Input-Parameters",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "gematik GmbH",
    "description": "EPA Operation Provide Dispensation Input-Parameters",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Parameters",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Parameters.parameter",
                "path": "Parameters.parameter",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "name"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 2
            },
            {
                "id": "Parameters.parameter:dispensation",
                "path": "Parameters.parameter",
                "sliceName": "dispensation",
                "min": 1,
                "max": "*"
            },
            {
                "id": "Parameters.parameter:dispensation.name",
                "path": "Parameters.parameter.name",
                "patternString": "dispensation",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.value[x]",
                "path": "Parameters.parameter.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.resource",
                "path": "Parameters.parameter.resource",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part",
                "path": "Parameters.parameter.part",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "name"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 2,
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense",
                "path": "Parameters.parameter.part",
                "sliceName": "medicationDispense",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "medicationDispense",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "MedicationDispense",
                        "profile":  [
                            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-nonrescription-medication-dispense"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication",
                "path": "Parameters.parameter.part",
                "sliceName": "medication",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "medication",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "Medication",
                        "profile":  [
                            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performerInstitution",
                "path": "Parameters.parameter",
                "sliceName": "performerInstitution",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Parameters.parameter:performerInstitution.name",
                "path": "Parameters.parameter.name",
                "patternString": "performerInstitution",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performerInstitution.value[x]",
                "path": "Parameters.parameter.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performerInstitution.resource",
                "path": "Parameters.parameter.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "Organization",
                        "profile":  [
                            "https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performerInstitution.part",
                "path": "Parameters.parameter.part",
                "max": "0"
            }
        ]
    }
}

Output-Parameterprofil

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I0..0Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1EPAMedicationDispense
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1EPAMedication
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1EPAOperationOutcome
partΣ0..0see (parameter)
Parameters
DefinitionThis resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.
Cardinality0...*
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Mappings
  • rim: Entity. Role, or Act
  • v2: n/a
  • rim: n/a
Parameters.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.

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

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

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

A human language.

CommonLanguages (preferred)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter
DefinitionA parameter passed to or received from the operation.
Cardinality1...*
TypeBackboneElement
SummaryTrue
SlicingUnordered, Closed, by name(Pattern)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Mappings
  • rim: n/a
Parameters.parameter.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
Parameters.parameter.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
Parameters.parameter.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...1
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter.resource
DefinitionIf the parameter is a whole resource.
Cardinality0...1
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

Mappings
  • rim: Entity. Role, or Act
Parameters.parameter.part
DefinitionA named part of a multi-part parameter.
Cardinality0...*
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation
DefinitionA parameter passed to or received from the operation.
Cardinality1...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Mappings
  • rim: n/a
Parameters.parameter:dispensation.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
Parameters.parameter:dispensation.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
Parameters.parameter:dispensation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

dispensation

Mappings
  • rim: n/a
Parameters.parameter:dispensation.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.resource
DefinitionIf the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

Mappings
  • rim: Entity. Role, or Act
Parameters.parameter:dispensation.part
DefinitionA named part of a multi-part parameter.
Cardinality1...*
Typesee (parameter)
Must SupportTrue
SummaryTrue
Comments

Only one level of nested parameters is allowed.

SlicingUnordered, Closed, by name(Pattern)
Parameters.parameter:dispensation.part:medicationDispense
DefinitionA named part of a multi-part parameter.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:medicationDispense.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
Parameters.parameter:dispensation.part:medicationDispense.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
Parameters.parameter:dispensation.part:medicationDispense.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.part:medicationDispense.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

medicationDispense

Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medicationDispense.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medicationDispense.resource
DefinitionIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
Cardinality1...1
TypeEPAMedicationDispense
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

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()
  • mdd-1: whenHandedOver cannot be before whenPrepared
    whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Supply[moodCode=EVN]
Parameters.parameter:dispensation.part:medicationDispense.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:medication
DefinitionA named part of a multi-part parameter.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:medication.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
Parameters.parameter:dispensation.part:medication.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
Parameters.parameter:dispensation.part:medication.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.part:medication.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

medication

Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medication.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:medication.resource
DefinitionThis resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
Cardinality1...1
TypeEPAMedication
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

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()
  • epa-med-1: Medication code, name, or ingredients must be specified
    code.exists() or ingredient.exists()
  • epa-med-2: Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference
    extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()
  • epa-med-3: Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference
    extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()
Mappings
  • rim: Entity. Role, or Act
  • script10.6: NewRx/MedicationPrescribed -or- RxFill/MedicationDispensed -or- RxHistoryResponse/MedicationDispensed -or- RxHistoryResponse/MedicationPrescribed
  • rim: ManufacturedProduct[classCode=ADMM]
Parameters.parameter:dispensation.part:medication.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:operationOutcome
DefinitionA named part of a multi-part parameter.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:dispensation.part:operationOutcome.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
Parameters.parameter:dispensation.part:operationOutcome.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
Parameters.parameter:dispensation.part:operationOutcome.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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
SummaryTrue
Aliasextensions, user content, modifiers
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.

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
Parameters.parameter:dispensation.part:operationOutcome.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
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())
Pattern

operationOutcome

Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:operationOutcome.value[x]
DefinitionIf the parameter is a data type.
Cardinality0...0
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Parameters.parameter:dispensation.part:operationOutcome.resource
DefinitionA collection of error, warning, or information messages that result from a system action.
Cardinality1...1
TypeEPAOperationOutcome
SummaryTrue
Comments

Can result from the failure of a REST call or be part of the response message returned from a request message.

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
Parameters.parameter:dispensation.part:operationOutcome.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Comments

Only one level of nested parameters is allowed.

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-op-dispensation-output-parameters" />
    <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-dispensation-output-parameters" />
    <version value="1.1.1" />
    <name value="EPAOpDispensationOutputParameters" />
    <title value="EPA Operation Dispensation Output-Parameters" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="EPA Operation Dispensation Output-Parameters" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Parameters" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Parameters" />
    <derivation value="constraint" />
    <differential>
        <element id="Parameters.parameter">
            <path value="Parameters.parameter" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="name" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="1" />
        </element>
        <element id="Parameters.parameter:dispensation">
            <path value="Parameters.parameter" />
            <sliceName value="dispensation" />
            <min value="1" />
            <max value="*" />
        </element>
        <element id="Parameters.parameter:dispensation.name">
            <path value="Parameters.parameter.name" />
            <patternString value="dispensation" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.value[x]">
            <path value="Parameters.parameter.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.resource">
            <path value="Parameters.parameter.resource" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part">
            <path value="Parameters.parameter.part" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="name" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense">
            <path value="Parameters.parameter.part" />
            <sliceName value="medicationDispense" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="medicationDispense" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="MedicationDispense" />
                <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medicationDispense.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medication">
            <path value="Parameters.parameter.part" />
            <sliceName value="medication" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="medication" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="Medication" />
                <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:medication.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:operationOutcome">
            <path value="Parameters.parameter.part" />
            <sliceName value="operationOutcome" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:operationOutcome.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="operationOutcome" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:dispensation.part:operationOutcome.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:dispensation.part:operationOutcome.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="OperationOutcome" />
                <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome" />
            </type>
        </element>
        <element id="Parameters.parameter:dispensation.part:operationOutcome.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-op-dispensation-output-parameters",
    "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-dispensation-output-parameters",
    "version": "1.1.1",
    "name": "EPAOpDispensationOutputParameters",
    "title": "EPA Operation Dispensation Output-Parameters",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "gematik GmbH",
    "description": "EPA Operation Dispensation Output-Parameters",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Parameters",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Parameters.parameter",
                "path": "Parameters.parameter",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "name"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 1
            },
            {
                "id": "Parameters.parameter:dispensation",
                "path": "Parameters.parameter",
                "sliceName": "dispensation",
                "min": 1,
                "max": "*"
            },
            {
                "id": "Parameters.parameter:dispensation.name",
                "path": "Parameters.parameter.name",
                "patternString": "dispensation",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.value[x]",
                "path": "Parameters.parameter.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.resource",
                "path": "Parameters.parameter.resource",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part",
                "path": "Parameters.parameter.part",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "name"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense",
                "path": "Parameters.parameter.part",
                "sliceName": "medicationDispense",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "medicationDispense",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "MedicationDispense",
                        "profile":  [
                            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medicationDispense.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication",
                "path": "Parameters.parameter.part",
                "sliceName": "medication",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "medication",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "Medication",
                        "profile":  [
                            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:medication.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:operationOutcome",
                "path": "Parameters.parameter.part",
                "sliceName": "operationOutcome",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:operationOutcome.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "operationOutcome",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:dispensation.part:operationOutcome.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:dispensation.part:operationOutcome.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "OperationOutcome",
                        "profile":  [
                            "https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:dispensation.part:operationOutcome.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            }
        ]
    }
}