Operation Definition: Link Prescription Process

Name Definition
MedicationStatement/[id]/$link-prescription-process Link Prescription Process

Anforderungen

Invocations

URL: [base]/MedicationStatement/[id]/$link-prescription-process

Parameters (In)

NameCardinalityTypeDocumentation
rxPrescription1..1
rxPrescription.prescriptionId1..1Identifier

prescriptionId ist der Identifier, der vom E-Rezept bei der Erstellung eines Rezepts vergeben wurde.

rxPrescription.authoredOn1..1date

authoredOn ist das Verschreibungsdatum, das in der MedicationRequest-Instanz im Element authoredOn festgelegt wurde. Hier muss genau derselbe Wert wie in der Verschreibung angegeben werden.

performer1..1

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

performer.organization1..1Organization
performer.practitioner0..1Practitioner
performer.practitionerRole0..1PractitionerRole

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1OperationOutcome

OperationDefinition
<OperationDefinition xmlns="http://hl7.org/fhir">
    <id value="link-prescription-process-OP" />
    <url value="https://gematik.de/fhir/epa-medication/OperationDefinition/link-prescription-process-OP" />
    <version value="1.1.1" />
    <name value="Link Prescription Process" />
    <title value="Link Prescription Process" />
    <status value="active" />
    <kind value="operation" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="The $link-prescription-process operation enables the assignment of prescriptions to a planned medication." />
    <code value="link-prescription-process" />
    <resource value="MedicationStatement" />
    <system value="false" />
    <type value="false" />
    <instance value="true" />
    <inputProfile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-link-prescription-process-input-parameters" />
    <outputProfile value="https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome" />
    <parameter>
        <name value="rxPrescription" />
        <use value="in" />
        <min value="1" />
        <max value="1" />
        <part>
            <name value="prescriptionId" />
            <use value="in" />
            <min value="1" />
            <max value="1" />
            <documentation value="prescriptionId ist der Identifier, der vom E-Rezept bei der Erstellung eines Rezepts vergeben wurde." />
            <type value="Identifier" />
        </part>
        <part>
            <name value="authoredOn" />
            <use value="in" />
            <min value="1" />
            <max value="1" />
            <documentation value="authoredOn ist das Verschreibungsdatum, das in der MedicationRequest-Instanz im Element authoredOn festgelegt wurde. Hier muss genau derselbe Wert wie in der Verschreibung angegeben werden." />
            <type value="date" />
        </part>
    </parameter>
    <parameter>
        <name value="performer" />
        <use value="in" />
        <min value="1" />
        <max value="1" />
        <documentation value="T&#228;tige Person und/oder Leistungserbringerinstitution/Organisation/Rolle, 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." />
        <part>
            <name value="organization" />
            <use value="in" />
            <min value="1" />
            <max value="1" />
            <type value="Organization" />
        </part>
        <part>
            <name value="practitioner" />
            <use value="in" />
            <min value="0" />
            <max value="1" />
            <type value="Practitioner" />
        </part>
        <part>
            <name value="practitionerRole" />
            <use value="in" />
            <min value="0" />
            <max value="1" />
            <type value="PractitionerRole" />
        </part>
    </parameter>
    <parameter>
        <name value="return" />
        <use value="out" />
        <min value="1" />
        <max value="1" />
        <type value="OperationOutcome" />
    </parameter>
</OperationDefinition>
{
    "resourceType": "OperationDefinition",
    "id": "link-prescription-process-OP",
    "url": "https://gematik.de/fhir/epa-medication/OperationDefinition/link-prescription-process-OP",
    "title": "Link Prescription Process",
    "description": "The $link-prescription-process operation enables the assignment of prescriptions to a planned medication.",
    "version": "1.1.1",
    "status": "active",
    "publisher": "gematik GmbH",
    "date": "2024-08-14",
    "name": "Link Prescription Process",
    "kind": "operation",
    "code": "link-prescription-process",
    "resource":  [
        "MedicationStatement"
    ],
    "system": false,
    "type": false,
    "instance": true,
    "inputProfile": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-link-prescription-process-input-parameters",
    "outputProfile": "https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome",
    "parameter":  [
        {
            "name": "rxPrescription",
            "use": "in",
            "min": 1,
            "max": "1",
            "part":  [
                {
                    "name": "prescriptionId",
                    "type": "Identifier",
                    "use": "in",
                    "min": 1,
                    "max": "1",
                    "documentation": "prescriptionId ist der Identifier, der vom E-Rezept bei der Erstellung eines Rezepts vergeben wurde."
                },
                {
                    "name": "authoredOn",
                    "type": "date",
                    "use": "in",
                    "min": 1,
                    "max": "1",
                    "documentation": "authoredOn ist das Verschreibungsdatum, das in der MedicationRequest-Instanz im Element authoredOn festgelegt wurde. Hier muss genau derselbe Wert wie in der Verschreibung angegeben werden."
                }
            ]
        },
        {
            "name": "performer",
            "use": "in",
            "min": 1,
            "max": "1",
            "documentation": "Tätige Person und/oder Leistungserbringerinstitution/Organisation/Rolle, die die Schreiboperation generell ausübt. Die Angabe der Leistungserbringerinstitution ist mandatorisch, denn hier erfolgt die Übereinstimmungsprüfung hinsichtlich der aktuell zugreifenden LEI.",
            "part":  [
                {
                    "name": "organization",
                    "type": "Organization",
                    "use": "in",
                    "min": 1,
                    "max": "1"
                },
                {
                    "name": "practitioner",
                    "type": "Practitioner",
                    "use": "in",
                    "min": 0,
                    "max": "1"
                },
                {
                    "name": "practitionerRole",
                    "type": "PractitionerRole",
                    "use": "in",
                    "min": 0,
                    "max": "1"
                }
            ]
        },
        {
            "name": "return",
            "type": "OperationOutcome",
            "use": "out",
            "min": 1,
            "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
valueIdentifierEPAeRPPrescriptionId
resourceΣ I0..0Resource
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
valueDatedate
resourceΣ I0..0Resource
partΣ0..0see (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..1OrganizationDirectory
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1PractitionerDirectory
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringPattern
resourceΣ I1..1EPAPractitionerRoleSource
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...2
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:rxPrescription
DefinitionA parameter passed to or received from the operation.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
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:rxPrescription.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:rxPrescription.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:rxPrescription.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:rxPrescription.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

rxPrescription

Mappings
  • rim: n/a
Parameters.parameter:rxPrescription.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:rxPrescription.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:rxPrescription.part
DefinitionA named part of a multi-part parameter.
Cardinality2...2
Typesee (parameter)
Must SupportTrue
SummaryTrue
Comments

Only one level of nested parameters is allowed.

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

Only one level of nested parameters is allowed.

Parameters.parameter:rxPrescription.part:prescriptionId.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:rxPrescription.part:prescriptionId.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:rxPrescription.part:prescriptionId.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:rxPrescription.part:prescriptionId.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

prescriptionId

Mappings
  • rim: n/a
Parameters.parameter:rxPrescription.part:prescriptionId.value[x]
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality1...1
TypeEPAeRPPrescriptionId
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
Parameters.parameter:rxPrescription.part:prescriptionId.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:rxPrescription.part:prescriptionId.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:rxPrescription.part:authoredOn
DefinitionA named part of a multi-part parameter.
Cardinality1...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:rxPrescription.part:authoredOn.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:rxPrescription.part:authoredOn.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:rxPrescription.part:authoredOn.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:rxPrescription.part:authoredOn.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

authoredOn

Mappings
  • rim: n/a
Parameters.parameter:rxPrescription.part:authoredOn.value[x]
DefinitionIf the parameter is a data type.
Cardinality1...1
Typedate
Must SupportTrue
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:rxPrescription.part:authoredOn.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:rxPrescription.part:authoredOn.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:performer
DefinitionA parameter passed to or received from the operation.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
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:performer.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:performer.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:performer.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:performer.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

performer

Mappings
  • rim: n/a
Parameters.parameter:performer.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:performer.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:performer.part
DefinitionA named part of a multi-part parameter.
Cardinality1...3
Typesee (parameter)
Must SupportTrue
SummaryTrue
Comments

Only one level of nested parameters is allowed.

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

Only one level of nested parameters is allowed.

Parameters.parameter:performer.part:organization.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:performer.part:organization.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:performer.part:organization.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:performer.part:organization.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

organization

Mappings
  • rim: n/a
Parameters.parameter:performer.part:organization.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:performer.part:organization.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:performer.part:organization.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:performer.part:practitioner
DefinitionA named part of a multi-part parameter.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:performer.part:practitioner.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:performer.part:practitioner.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:performer.part:practitioner.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:performer.part:practitioner.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

practitioner

Mappings
  • rim: n/a
Parameters.parameter:performer.part:practitioner.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:performer.part:practitioner.resource
DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
Cardinality1...1
TypePractitionerDirectory
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()
Mappings
  • rim: Entity. Role, or Act
  • v2: PRD (as one example)
  • rim: Role
  • servd: Provider
Parameters.parameter:performer.part:practitioner.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:performer.part:practitionerRole
DefinitionA named part of a multi-part parameter.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Comments

Only one level of nested parameters is allowed.

Parameters.parameter:performer.part:practitionerRole.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:performer.part:practitionerRole.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:performer.part:practitionerRole.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:performer.part:practitionerRole.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

practitionerRole

Mappings
  • rim: n/a
Parameters.parameter:performer.part:practitionerRole.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:performer.part:practitionerRole.resource
DefinitionDieses Profil bildet eine behandelnde Person/Einrichtung ab.
Cardinality1...1
TypeEPAPractitionerRoleSource
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()
Mappings
  • rim: Entity. Role, or Act
  • v2: PRD (as one example)
  • rim: Role
  • servd: ServiceSiteProvider
Parameters.parameter:performer.part:practitionerRole.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-link-prescription-process-input-parameters" />
    <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-link-prescription-process-input-parameters" />
    <version value="1.1.1" />
    <name value="EPAOpLinkPrescriptionProcessInputParameters" />
    <title value="EPA Operation LinkPrescriptionProcess Input-Parameters" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="EPA Operation LinkPrescriptionProcess 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" />
            <max value="2" />
        </element>
        <element id="Parameters.parameter:rxPrescription">
            <path value="Parameters.parameter" />
            <sliceName value="rxPrescription" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.name">
            <path value="Parameters.parameter.name" />
            <patternString value="rxPrescription" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.value[x]">
            <path value="Parameters.parameter.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:rxPrescription.resource">
            <path value="Parameters.parameter.resource" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part">
            <path value="Parameters.parameter.part" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="name" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="2" />
            <max value="2" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:prescriptionId">
            <path value="Parameters.parameter.part" />
            <sliceName value="prescriptionId" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:rxPrescription.part:prescriptionId.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="prescriptionId" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:prescriptionId.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-erp-prescription-id" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:prescriptionId.resource">
            <path value="Parameters.parameter.part.resource" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:prescriptionId.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:authoredOn">
            <path value="Parameters.parameter.part" />
            <sliceName value="authoredOn" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:rxPrescription.part:authoredOn.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="authoredOn" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:authoredOn.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <min value="1" />
            <type>
                <code value="date" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:authoredOn.resource">
            <path value="Parameters.parameter.part.resource" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:rxPrescription.part:authoredOn.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer">
            <path value="Parameters.parameter" />
            <sliceName value="performer" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performer.name">
            <path value="Parameters.parameter.name" />
            <patternString value="performer" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performer.value[x]">
            <path value="Parameters.parameter.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.resource">
            <path value="Parameters.parameter.resource" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.part">
            <path value="Parameters.parameter.part" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="name" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="1" />
            <max value="3" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performer.part:organization">
            <path value="Parameters.parameter.part" />
            <sliceName value="organization" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:performer.part:organization.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="organization" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performer.part:organization.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.part:organization.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="Organization" />
                <profile value="https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory" />
            </type>
        </element>
        <element id="Parameters.parameter:performer.part:organization.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.part:practitioner">
            <path value="Parameters.parameter.part" />
            <sliceName value="practitioner" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:performer.part:practitioner.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="practitioner" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performer.part:practitioner.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.part:practitioner.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="Practitioner" />
                <profile value="https://gematik.de/fhir/directory/StructureDefinition/PractitionerDirectory" />
            </type>
        </element>
        <element id="Parameters.parameter:performer.part:practitioner.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.part:practitionerRole">
            <path value="Parameters.parameter.part" />
            <sliceName value="practitionerRole" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
        </element>
        <element id="Parameters.parameter:performer.part:practitionerRole.name">
            <path value="Parameters.parameter.part.name" />
            <patternString value="practitionerRole" />
            <mustSupport value="true" />
        </element>
        <element id="Parameters.parameter:performer.part:practitionerRole.value[x]">
            <path value="Parameters.parameter.part.value[x]" />
            <max value="0" />
        </element>
        <element id="Parameters.parameter:performer.part:practitionerRole.resource">
            <path value="Parameters.parameter.part.resource" />
            <min value="1" />
            <type>
                <code value="PractitionerRole" />
                <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-practitioner-role-source" />
            </type>
        </element>
        <element id="Parameters.parameter:performer.part:practitionerRole.part">
            <path value="Parameters.parameter.part.part" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-op-link-prescription-process-input-parameters",
    "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-link-prescription-process-input-parameters",
    "version": "1.1.1",
    "name": "EPAOpLinkPrescriptionProcessInputParameters",
    "title": "EPA Operation LinkPrescriptionProcess Input-Parameters",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "gematik GmbH",
    "description": "EPA Operation LinkPrescriptionProcess 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,
                "max": "2"
            },
            {
                "id": "Parameters.parameter:rxPrescription",
                "path": "Parameters.parameter",
                "sliceName": "rxPrescription",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.name",
                "path": "Parameters.parameter.name",
                "patternString": "rxPrescription",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.value[x]",
                "path": "Parameters.parameter.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:rxPrescription.resource",
                "path": "Parameters.parameter.resource",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:rxPrescription.part",
                "path": "Parameters.parameter.part",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "name"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 2,
                "max": "2",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:prescriptionId",
                "path": "Parameters.parameter.part",
                "sliceName": "prescriptionId",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:prescriptionId.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "prescriptionId",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:prescriptionId.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-erp-prescription-id"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:prescriptionId.resource",
                "path": "Parameters.parameter.part.resource",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:prescriptionId.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:authoredOn",
                "path": "Parameters.parameter.part",
                "sliceName": "authoredOn",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:authoredOn.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "authoredOn",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:authoredOn.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "date"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:authoredOn.resource",
                "path": "Parameters.parameter.part.resource",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:rxPrescription.part:authoredOn.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer",
                "path": "Parameters.parameter",
                "sliceName": "performer",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performer.name",
                "path": "Parameters.parameter.name",
                "patternString": "performer",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performer.value[x]",
                "path": "Parameters.parameter.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.resource",
                "path": "Parameters.parameter.resource",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.part",
                "path": "Parameters.parameter.part",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "name"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 1,
                "max": "3",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performer.part:organization",
                "path": "Parameters.parameter.part",
                "sliceName": "organization",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performer.part:organization.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "organization",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performer.part:organization.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.part:organization.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "Organization",
                        "profile":  [
                            "https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performer.part:organization.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.part:practitioner",
                "path": "Parameters.parameter.part",
                "sliceName": "practitioner",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performer.part:practitioner.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "practitioner",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performer.part:practitioner.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.part:practitioner.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "Practitioner",
                        "profile":  [
                            "https://gematik.de/fhir/directory/StructureDefinition/PractitionerDirectory"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performer.part:practitioner.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.part:practitionerRole",
                "path": "Parameters.parameter.part",
                "sliceName": "practitionerRole",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performer.part:practitionerRole.name",
                "path": "Parameters.parameter.part.name",
                "patternString": "practitionerRole",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:performer.part:practitionerRole.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "max": "0"
            },
            {
                "id": "Parameters.parameter:performer.part:practitionerRole.resource",
                "path": "Parameters.parameter.part.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "PractitionerRole",
                        "profile":  [
                            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-practitioner-role-source"
                        ]
                    }
                ]
            },
            {
                "id": "Parameters.parameter:performer.part:practitionerRole.part",
                "path": "Parameters.parameter.part.part",
                "max": "0"
            }
        ]
    }
}

Output-Parameterprofil

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
severityS Σ1..1codeBinding
codeS Σ1..1codeBinding
detailsS Σ1..1CodeableConceptBinding
diagnosticsΣ0..1string
locationΣ0..*string
expressionΣ0..*string
OperationOutcome
DefinitionA collection of error, warning, or information messages that result from a system action.
Cardinality0...*
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)
OperationOutcome.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.

OperationOutcome.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
OperationOutcome.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
OperationOutcome.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
OperationOutcome.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
OperationOutcome.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

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

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
OperationOutcome.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
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
OperationOutcome.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

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

Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
OperationOutcome.issue
DefinitionAn error, warning, or information message that results from a system action.
Cardinality1...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ERR
  • rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
OperationOutcome.issue.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
OperationOutcome.issue.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
OperationOutcome.issue.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
OperationOutcome.issue.severity
DefinitionIndicates whether the issue indicates a variation from successful processing.
Cardinality1...1
Typecode
Binding

How the issue affects the success of the action.

IssueSeverity (required)
Must SupportTrue
SummaryTrue
Requirements

Indicates how relevant the issue is to the overall success of the action.

Comments

This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ERR-4
  • rim: ./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode="OBS" and moodCode="EVN" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type="CD"]
OperationOutcome.issue.code
DefinitionDescribes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
Cardinality1...1
Typecode
Binding

A code that describes the type of issue.

IssueType (required)
Must SupportTrue
SummaryTrue
Requirements

Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ERR-3
  • rim: ./code
OperationOutcome.issue.details
DefinitionAdditional details about the error. This may be a text description of the error or a system code that identifies the error.
Cardinality1...1
TypeCodeableConcept
Binding

A code that provides details as the exact issue.

EPAOperationOutcomeVS (required)
Must SupportTrue
SummaryTrue
Comments

A human readable description of the error issue SHOULD be placed in details.text.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: ERR-5
  • rim: ./code
OperationOutcome.issue.diagnostics
DefinitionAdditional diagnostic information about the issue.
Cardinality0...1
Typestring
SummaryTrue
Comments

This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ERR-8
  • rim: ./text[parent::AcknowledgmentDetail]
OperationOutcome.issue.location
DefinitionThis element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.
Cardinality0...*
Typestring
SummaryTrue
Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Comments

The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ERR-2
  • rim: ./location[parent::AcknowledgmentDetail]
OperationOutcome.issue.expression
DefinitionA [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.
Cardinality0...*
Typestring
SummaryTrue
Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Comments

The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ERR-2
  • rim: ./location[parent::AcknowledgmentDetail]
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-operation-outcome" />
    <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome" />
    <version value="1.1.0" />
    <name value="EPAOperationOutcome" />
    <title value="EPA OperationOutcome" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="Defines the operation outcome for the ePA system." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="OperationOutcome" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" />
    <derivation value="constraint" />
    <differential>
        <element id="OperationOutcome.issue.severity">
            <path value="OperationOutcome.issue.severity" />
            <mustSupport value="true" />
        </element>
        <element id="OperationOutcome.issue.code">
            <path value="OperationOutcome.issue.code" />
            <mustSupport value="true" />
        </element>
        <element id="OperationOutcome.issue.details">
            <path value="OperationOutcome.issue.details" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-vs" />
            </binding>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-operation-outcome",
    "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome",
    "version": "1.1.0",
    "name": "EPAOperationOutcome",
    "title": "EPA OperationOutcome",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "gematik GmbH",
    "description": "Defines the operation outcome for the ePA system.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "OperationOutcome",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "OperationOutcome.issue.severity",
                "path": "OperationOutcome.issue.severity",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.code",
                "path": "OperationOutcome.issue.code",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.details",
                "path": "OperationOutcome.issue.details",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-vs"
                }
            }
        ]
    }
}