Operation Definition: Cancel Prescription eRP
Name | Definition |
---|---|
$cancel-prescription-erp | https://gematik.de/fhir/epa-medication/OperationDefinition/cancel-prescription-erp-OP |
Anforderungen
Invocations
URL: [base]/$cancel-prescription-erp
Parameters (In)
Name | Cardinality | Type | Documentation |
rxPrescription | 1..* | ||
rxPrescription.prescriptionId | 1..1 | Identifier | |
rxPrescription.authoredOn | 1..1 | date |
Return Values (Out)
Name | Cardinality | Type | Documentation |
rxPrescription | 1..* | ||
rxPrescription.prescriptionId | 1..1 | Identifier | |
rxPrescription.authoredOn | 1..1 | date | |
rxPrescription.operationOutcome | 1..1 | OperationOutcome |
OperationDefinition |
id : cancel-prescription-erp-OP |
url : https://gematik.de/fhir/epa-medication/OperationDefinition/cancel-prescription-erp-OP |
title : Cancel Prescription eRP |
description : The $cancel-prescription-erp operation is used by the E-Rezept-Fachdienst to cancel an already issued electronic prescription. This function is applied when a prescription is no longer needed for various reasons, such as changes in medication or errors in the initial issuance. After cancellation by the E-Rezept-Fachdienst, this information is transmitted to the ePA Medication Service, where the prescription is calculations. It can then no longer be used for dispensing medication. This process ensures accuracy and safety in the management of medications. |
version : 1.1.1 |
status : active |
publisher : gematik GmbH |
date : 2024-08-14 |
name : Cancel Prescription eRP |
kind : operation |
code : cancel-prescription-erp |
system : True |
type : False |
instance : False |
inputProfile : https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-cancel-prescription-erp-input-parameters |
outputProfile : https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-rx-prescription-erp-output-parameters |
parameter |
name : rxPrescription |
use : in |
min : 1 |
max : * |
part |
name : prescriptionId |
type : Identifier |
use : in |
min : 1 |
max : 1 |
part |
name : authoredOn |
type : date |
use : in |
min : 1 |
max : 1 |
parameter |
name : rxPrescription |
use : out |
min : 1 |
max : * |
part |
name : prescriptionId |
type : Identifier |
use : out |
min : 1 |
max : 1 |
part |
name : authoredOn |
type : date |
use : out |
min : 1 |
max : 1 |
part |
name : operationOutcome |
type : OperationOutcome |
use : out |
min : 1 |
max : 1 |
<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="cancel-prescription-erp-OP" /> <url value="https://gematik.de/fhir/epa-medication/OperationDefinition/cancel-prescription-erp-OP" /> <version value="1.1.1" /> <name value="Cancel Prescription eRP" /> <title value="Cancel Prescription eRP" /> <status value="active" /> <kind value="operation" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="The $cancel-prescription-erp operation is used by the E-Rezept-Fachdienst to cancel an already issued electronic prescription. This function is applied when a prescription is no longer needed for various reasons, such as changes in medication or errors in the initial issuance. After cancellation by the E-Rezept-Fachdienst, this information is transmitted to the ePA Medication Service, where the prescription is calculations. It can then no longer be used for dispensing medication. This process ensures accuracy and safety in the management of medications." /> <code value="cancel-prescription-erp" /> <system value="true" /> <type value="false" /> <instance value="false" /> <inputProfile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-cancel-prescription-erp-input-parameters" /> <outputProfile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-rx-prescription-erp-output-parameters" /> <parameter> <name value="rxPrescription" /> <use value="in" /> <min value="1" /> <max value="*" /> <part> <name value="prescriptionId" /> <use value="in" /> <min value="1" /> <max value="1" /> <type value="Identifier" /> </part> <part> <name value="authoredOn" /> <use value="in" /> <min value="1" /> <max value="1" /> <type value="date" /> </part> </parameter> <parameter> <name value="rxPrescription" /> <use value="out" /> <min value="1" /> <max value="*" /> <part> <name value="prescriptionId" /> <use value="out" /> <min value="1" /> <max value="1" /> <type value="Identifier" /> </part> <part> <name value="authoredOn" /> <use value="out" /> <min value="1" /> <max value="1" /> <type value="date" /> </part> <part> <name value="operationOutcome" /> <use value="out" /> <min value="1" /> <max value="1" /> <type value="OperationOutcome" /> </part> </parameter> </OperationDefinition>
{ "resourceType": "OperationDefinition", "id": "cancel-prescription-erp-OP", "url": "https://gematik.de/fhir/epa-medication/OperationDefinition/cancel-prescription-erp-OP", "title": "Cancel Prescription eRP", "description": "The $cancel-prescription-erp operation is used by the E-Rezept-Fachdienst to cancel an already issued electronic prescription. This function is applied when a prescription is no longer needed for various reasons, such as changes in medication or errors in the initial issuance. After cancellation by the E-Rezept-Fachdienst, this information is transmitted to the ePA Medication Service, where the prescription is calculations. It can then no longer be used for dispensing medication. This process ensures accuracy and safety in the management of medications.", "version": "1.1.1", "status": "active", "publisher": "gematik GmbH", "date": "2024-08-14", "name": "Cancel Prescription eRP", "kind": "operation", "code": "cancel-prescription-erp", "system": true, "type": false, "instance": false, "inputProfile": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-cancel-prescription-erp-input-parameters", "outputProfile": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-rx-prescription-erp-output-parameters", "parameter": [ { "name": "rxPrescription", "use": "in", "min": 1, "max": "*", "part": [ { "name": "prescriptionId", "type": "Identifier", "use": "in", "min": 1, "max": "1" }, { "name": "authoredOn", "type": "date", "use": "in", "min": 1, "max": "1" } ] }, { "name": "rxPrescription", "use": "out", "min": 1, "max": "*", "part": [ { "name": "prescriptionId", "type": "Identifier", "use": "out", "min": 1, "max": "1" }, { "name": "authoredOn", "type": "date", "use": "out", "min": 1, "max": "1" }, { "name": "operationOutcome", "type": "OperationOutcome", "use": "out", "min": 1, "max": "1" } ] } ] }
Input-Parameterprofil
EPAOpCancelPrescriptionERPInputParameters (Parameters) | Parameters | ||
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
parameter | Σ I | 1..* | BackboneElement |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | string |
value[x] | Σ I | 0..1 | |
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueContributor | Contributor | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueReference | Reference() | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
rxPrescription | Σ I | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 0..0 | |
resource | Σ I | 0..0 | Resource |
part | S Σ | 2..2 | see (parameter) |
prescriptionId | Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 1..1 | |
valueIdentifier | EPAeRPPrescriptionId | ||
resource | Σ I | 0..0 | Resource |
part | Σ | 0..0 | see (parameter) |
authoredOn | Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 1..1 | |
valueDate | date | ||
resource | Σ I | 0..0 | Resource |
part | Σ | 0..0 | see (parameter) |
Parameters | |
Definition | This 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. |
Cardinality | 0...* |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
Mappings |
|
Parameters.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 |
|
Mappings |
|
Parameters.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Mappings |
|
Parameters.parameter | |
Definition | A parameter passed to or received from the operation. |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Slicing | Unordered, Closed, by name(Pattern) |
Invariants |
|
Mappings |
|
Parameters.parameter.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Parameters.parameter.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 0...1 |
Type | base64Binary |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...1 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...* |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription | |
Definition | A parameter passed to or received from the operation. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | rxPrescription |
Mappings |
|
Parameters.parameter:rxPrescription.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 0...0 |
Type | base64Binary |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...0 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter:rxPrescription.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 2...2 |
Type | see (parameter) |
Must Support | True |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Slicing | Unordered, Closed, by name(Pattern) |
Parameters.parameter:rxPrescription.part:prescriptionId | |
Definition | A named part of a multi-part parameter. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:prescriptionId.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | prescriptionId |
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.value[x] | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | EPAeRPPrescriptionId |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...0 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter:rxPrescription.part:prescriptionId.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...0 |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:authoredOn | |
Definition | A named part of a multi-part parameter. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:authoredOn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | authoredOn |
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 1...1 |
Type | date |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...0 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter:rxPrescription.part:authoredOn.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...0 |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-op-cancel-prescription-erp-input-parameters" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-cancel-prescription-erp-input-parameters" /> <version value="1.1.1" /> <name value="EPAOpCancelPrescriptionERPInputParameters" /> <title value="EPA Operation CancelPrescription ERP Input-Parameters" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="EPA Operation CancelPrescription ERP 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="1" /> </element> <element id="Parameters.parameter:rxPrescription"> <path value="Parameters.parameter" /> <sliceName value="rxPrescription" /> <min value="1" /> <max value="1" /> </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> </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> </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> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-op-cancel-prescription-erp-input-parameters", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-cancel-prescription-erp-input-parameters", "version": "1.1.1", "name": "EPAOpCancelPrescriptionERPInputParameters", "title": "EPA Operation CancelPrescription ERP Input-Parameters", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "EPA Operation CancelPrescription ERP 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": 1 }, { "id": "Parameters.parameter:rxPrescription", "path": "Parameters.parameter", "sliceName": "rxPrescription", "min": 1, "max": "1" }, { "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" ] } ] }, { "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" } ] }, { "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" } ] } }
Output-Parameterprofil
EPAOpRxPrescriptionERPOutputParameters (Parameters) | Parameters | ||
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
parameter | Σ I | 1..* | BackboneElement |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | string |
value[x] | Σ I | 0..1 | |
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueContributor | Contributor | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueReference | Reference() | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
rxPrescription | Σ I | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 0..0 | |
resource | Σ I | 0..0 | Resource |
part | S Σ | 3..3 | see (parameter) |
prescriptionId | Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 1..1 | |
valueIdentifier | EPAeRPPrescriptionId | ||
resource | Σ I | 0..0 | Resource |
part | Σ | 0..0 | see (parameter) |
authoredOn | Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 1..1 | |
valueDate | date | ||
resource | Σ I | 0..0 | Resource |
part | Σ | 0..0 | see (parameter) |
operationOutcome | Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | stringPattern |
value[x] | Σ I | 0..0 | |
resource | Σ I | 1..1 | EPAOperationOutcome |
part | Σ | 0..0 | see (parameter) |
Parameters | |
Definition | This 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. |
Cardinality | 0...* |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
Mappings |
|
Parameters.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 |
|
Mappings |
|
Parameters.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Mappings |
|
Parameters.parameter | |
Definition | A parameter passed to or received from the operation. |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Slicing | Unordered, Closed, by name(Pattern) |
Invariants |
|
Mappings |
|
Parameters.parameter.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Parameters.parameter.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 0...1 |
Type | base64Binary |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...1 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...* |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription | |
Definition | A parameter passed to or received from the operation. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | rxPrescription |
Mappings |
|
Parameters.parameter:rxPrescription.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 0...0 |
Type | base64Binary |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...0 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter:rxPrescription.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 3...3 |
Type | see (parameter) |
Must Support | True |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Slicing | Unordered, Closed, by name(Pattern) |
Parameters.parameter:rxPrescription.part:prescriptionId | |
Definition | A named part of a multi-part parameter. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:prescriptionId.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | prescriptionId |
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.value[x] | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | EPAeRPPrescriptionId |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:prescriptionId.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...0 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter:rxPrescription.part:prescriptionId.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...0 |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:authoredOn | |
Definition | A named part of a multi-part parameter. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:authoredOn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | authoredOn |
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 1...1 |
Type | date |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:authoredOn.resource | |
Definition | If the parameter is a whole resource. |
Cardinality | 0...0 |
Type | Resource |
Summary | True |
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 |
|
Parameters.parameter:rxPrescription.part:authoredOn.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...0 |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:operationOutcome | |
Definition | A named part of a multi-part parameter. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
Parameters.parameter:rxPrescription.part:operationOutcome.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Parameters.parameter:rxPrescription.part:operationOutcome.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:operationOutcome.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:operationOutcome.name | |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | operationOutcome |
Mappings |
|
Parameters.parameter:rxPrescription.part:operationOutcome.value[x] | |
Definition | If the parameter is a data type. |
Cardinality | 0...0 |
Type | base64Binary |
Summary | True |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:operationOutcome.resource | |
Definition | A collection of error, warning, or information messages that result from a system action. |
Cardinality | 1...1 |
Type | EPAOperationOutcome |
Summary | True |
Comments | Can result from the failure of a REST call or be part of the response message returned from a request message. |
Invariants |
|
Mappings |
|
Parameters.parameter:rxPrescription.part:operationOutcome.part | |
Definition | A named part of a multi-part parameter. |
Cardinality | 0...0 |
Type | see (parameter) |
Summary | True |
Comments | Only one level of nested parameters is allowed. |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-op-rx-prescription-erp-output-parameters" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-rx-prescription-erp-output-parameters" /> <version value="1.1.1" /> <name value="EPAOpRxPrescriptionERPOutputParameters" /> <title value="EPA Operation RxPrescription ERP Output-Parameters" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="EPA Operation RxPrescription ERP Output-Parameters" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Parameters" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Parameters" /> <derivation value="constraint" /> <differential> <element id="Parameters.parameter"> <path value="Parameters.parameter" /> <slicing> <discriminator> <type value="pattern" /> <path value="name" /> </discriminator> <rules value="closed" /> </slicing> <min value="1" /> </element> <element id="Parameters.parameter:rxPrescription"> <path value="Parameters.parameter" /> <sliceName value="rxPrescription" /> <min value="1" /> <max value="1" /> </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="3" /> <max value="3" /> <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> </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> </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:rxPrescription.part:operationOutcome"> <path value="Parameters.parameter.part" /> <sliceName value="operationOutcome" /> <min value="1" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> </element> <element id="Parameters.parameter:rxPrescription.part:operationOutcome.name"> <path value="Parameters.parameter.part.name" /> <patternString value="operationOutcome" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:rxPrescription.part:operationOutcome.value[x]"> <path value="Parameters.parameter.part.value[x]" /> <max value="0" /> </element> <element id="Parameters.parameter:rxPrescription.part:operationOutcome.resource"> <path value="Parameters.parameter.part.resource" /> <min value="1" /> <type> <code value="OperationOutcome" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome" /> </type> </element> <element id="Parameters.parameter:rxPrescription.part:operationOutcome.part"> <path value="Parameters.parameter.part.part" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-op-rx-prescription-erp-output-parameters", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-rx-prescription-erp-output-parameters", "version": "1.1.1", "name": "EPAOpRxPrescriptionERPOutputParameters", "title": "EPA Operation RxPrescription ERP Output-Parameters", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "EPA Operation RxPrescription ERP Output-Parameters", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Parameters", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters", "derivation": "constraint", "differential": { "element": [ { "id": "Parameters.parameter", "path": "Parameters.parameter", "slicing": { "discriminator": [ { "type": "pattern", "path": "name" } ], "rules": "closed" }, "min": 1 }, { "id": "Parameters.parameter:rxPrescription", "path": "Parameters.parameter", "sliceName": "rxPrescription", "min": 1, "max": "1" }, { "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": 3, "max": "3", "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" ] } ] }, { "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" } ] }, { "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:rxPrescription.part:operationOutcome", "path": "Parameters.parameter.part", "sliceName": "operationOutcome", "min": 1, "max": "1", "type": [ { "code": "BackboneElement" } ] }, { "id": "Parameters.parameter:rxPrescription.part:operationOutcome.name", "path": "Parameters.parameter.part.name", "patternString": "operationOutcome", "mustSupport": true }, { "id": "Parameters.parameter:rxPrescription.part:operationOutcome.value[x]", "path": "Parameters.parameter.part.value[x]", "max": "0" }, { "id": "Parameters.parameter:rxPrescription.part:operationOutcome.resource", "path": "Parameters.parameter.part.resource", "min": 1, "type": [ { "code": "OperationOutcome", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome" ] } ] }, { "id": "Parameters.parameter:rxPrescription.part:operationOutcome.part", "path": "Parameters.parameter.part.part", "max": "0" } ] } }