BfArM Digitale Anwendungen - Local Development build (v3.1.0-TEST) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: HealthAppPrescriptionUnit
| Official URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit | Version: 3.1.0-TEST | |||
| Active as of 2026-05-30 | Computable Name: HealthAppPrescriptionUnit | |||
Definition of a prescription unit of a module of a digital health application (DiGA) or a usage unit of a module of a digital nursing application (DiPA).
Usages:
- This Profile is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ChargeItemDefinition |
SC | 0..* | ChargeItemDefinition | Prescription or usage unit of a digital application Constraints: cid-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
   extension:anwendungsdauer |
S | 0..1 | Duration | Duration of use URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer |
| extension:ergaenzendeUnterstuetzungsleistungen |
S | 0..1 | (Complex) | Additional support services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen |
| extension:indikation |
S | 0..1 | (Complex) | Indications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation |
| extension:kontraindikation |
S | 0..1 | (Complex) | Contraindications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation |
 extension:vertragsaerztlicheLeistungen |
S | 0..1 | (Complex) | Additional services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Directory URL |
 Slices for identifier |
SΣ | 0..* | Identifier | Identifiers Slice: Unordered, Open by value:system |
 identifier:digaVeId |
SΣ | 0..1 | Identifier | DiGA prescription unit ID (DiGA-VE-ID) |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DigaVeId |
 value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:dipaAeId |
SΣ | 0..1 | Identifier | DiPA usage unit ID (DiPA-AE-ID) |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DipaAeId |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| title |
SΣ | 0..1 | string | Name |
| status |
?!SΣ | 1..1 | code | Status Binding: HealthAppPrescriptionUnitStatus (required) |
| description |
SΣ | 0..1 | markdown | Notes on the pricing model |
| Slices for useContext |
SΣ | 0..* | UsageContext | Patient and target groups Slice: Unordered, Open by value:code.code |
| useContext:age |
SΣ | 0..* | UsageContext | Age groups |
  code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
 system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age |
 display |
SΣ | 1..1 | string | Representation defined by the system |
 value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
| coding |
SΣ | 1..1 | CodingHealthAppAge | Code defined by a terminology system |
| text |
SΣ | 0..1 | string | Comment |
| useContext:focus |
SΣ | 0..* | UsageContext | Impairments |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:severity |
S | 0..* | CodingHealthAppSeverity | Severity level URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity |
| coding |
SΣ | 1..1 | CodingHealthAppFocus | Code defined by a terminology system |
| useContext:gender |
SΣ | 0..* | UsageContext | Genders |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
| coding |
SΣ | 1..1 | CodingHealthAppGender | Code defined by a terminology system |
| effectivePeriod |
SΣ | 0..1 | Period | Validity period |
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| code |
SΣ | 0..1 | CodeableConcept | Coding Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:validUntil |
S | 0..1 | dateTime | Valid until URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil |
 coding |
SΣ | 1..1 | CodingPZN | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Canonische CodeSystem URL für PZN Fixed Value: http://fhir.de/CodeSystem/ifa/pzn |
| code |
SΣ | 1..1 | code | Der PZN-Code |
 instance |
S | 1..1 | Reference(Medication | Substance | Device) | HealthAppModule |
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:deviceDefinition |
S | 1..1 | Reference(HealthAppModule) | Reference URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink |
| propertyGroup |
S | 0..1 | BackboneElement | Group of properties which are applicable under the same conditions |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nonRefundable |
S | 0..1 | (Complex) | Non-refundable costs URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| priceComponent |
S | 0..* | BackboneElement | Price information |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
S | 1..1 | code | Price component type Binding: HealthAppPrescriptionUnitPriceComponentType (required) |
| code |
S | 0..1 | CodeableConcept | Price component code |
| coding |
SΣ | 0..1 | CodingHealthAppPriceCode | Code defined by a terminology system |
| amount |
S | 0..1 | Money | Amount |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
| currency |
SΣ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.identifier:digaVeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:dipaAeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.status | Base | required | HealthAppPrescriptionUnitStatus | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.useContext:age.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:age.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.code | Base | example | ChargeItemCode | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | HealthAppPrescriptionUnitPriceComponentType | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.propertyGroup.priceComponent.amount.currency | Base | required | CurrencyCode | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cid-0 | warning | ChargeItemDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | ChargeItemDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ChargeItemDefinition | 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-4 | error | ChargeItemDefinition | 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-5 | error | ChargeItemDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ChargeItemDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ChargeItemDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ChargeItemDefinition |
S | 0..* | ChargeItemDefinition | Prescription or usage unit of a digital application |
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:anwendungsdauer |
S | 0..1 | Duration | Duration of use URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer |
| extension:ergaenzendeUnterstuetzungsleistungen |
S | 0..1 | (Complex) | Additional support services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen |
| extension:indikation |
S | 0..1 | (Complex) | Indications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation |
| extension:kontraindikation |
S | 0..1 | (Complex) | Contraindications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation |
| extension:vertragsaerztlicheLeistungen |
S | 0..1 | (Complex) | Additional services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen |
 url |
S | 1..1 | uri | Directory URL |
| Slices for identifier |
S | 0..* | Identifier | Identifiers Slice: Unordered, Open by value:system |
| identifier:digaVeId |
S | 0..1 | Identifier | DiGA prescription unit ID (DiGA-VE-ID) |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DigaVeId |
| value |
S | 1..1 | string | The value that is unique |
| identifier:dipaAeId |
S | 0..1 | Identifier | DiPA usage unit ID (DiPA-AE-ID) |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DipaAeId |
| value |
S | 1..1 | string | The value that is unique |
| title |
S | 0..1 | string | Name |
| status |
S | 1..1 | code | Status Binding: HealthAppPrescriptionUnitStatus (required) |
| description |
S | 0..1 | markdown | Notes on the pricing model |
| Slices for useContext |
S | 0..* | UsageContext | Patient and target groups Slice: Unordered, Open by value:code.code |
| useContext:age |
S | 0..* | UsageContext | Age groups |
| code |
S | 1..1 | Coding | Type of context being specified |
| system |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age |
| display |
S | 1..1 | string | Representation defined by the system |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context |
| coding |
S | 1..1 | CodingHealthAppAge | Code defined by a terminology system |
| text |
S | 0..1 | string | Comment |
| useContext:focus |
S | 0..* | UsageContext | Impairments |
| code |
S | 1..1 | Coding | Type of context being specified |
| system |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus |
| display |
S | 1..1 | string | Representation defined by the system |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context |
| Slices for extension |
Content/Rules for all slices | |||
| extension:severity |
S | 0..* | CodingHealthAppSeverity | Severity level URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity |
| coding |
S | 1..1 | CodingHealthAppFocus | Code defined by a terminology system |
| useContext:gender |
S | 0..* | UsageContext | Genders |
| code |
S | 1..1 | Coding | Type of context being specified |
| system |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender |
| display |
S | 1..1 | string | Representation defined by the system |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context |
| coding |
S | 1..1 | CodingHealthAppGender | Code defined by a terminology system |
| effectivePeriod |
S | 0..1 | Period | Validity period |
| start |
S | 0..1 | dateTime | Starting time with inclusive boundary |
| end |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| code |
S | 0..1 | CodeableConcept | Coding |
| Slices for extension |
Content/Rules for all slices | |||
| extension:validUntil |
S | 0..1 | dateTime | Valid until URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil |
| coding |
S | 1..1 | CodingPZN | Code defined by a terminology system |
| system |
S | 1..1 | uri | Canonische CodeSystem URL für PZN |
| code |
S | 1..1 | code | Der PZN-Code |
| instance |
S | 1..1 | Reference(Medication | Substance | Device) | HealthAppModule |
| extension |
S | 1..* | Extension | Extension |
| Slices for extension |
Content/Rules for all slices | |||
| extension:deviceDefinition |
S | 1..1 | Reference(HealthAppModule) | Reference URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink |
| propertyGroup |
S | 0..1 | BackboneElement | Group of properties which are applicable under the same conditions |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nonRefundable |
S | 0..1 | (Complex) | Non-refundable costs URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable |
| priceComponent |
S | 0..* | BackboneElement | Price information |
| type |
S | 1..1 | code | Price component type Binding: HealthAppPrescriptionUnitPriceComponentType (required) |
| code |
S | 0..1 | CodeableConcept | Price component code |
| coding |
S | 0..1 | CodingHealthAppPriceCode | Code defined by a terminology system |
| amount |
S | 0..1 | Money | Amount |
| value |
S | 0..1 | decimal | Numerical value (with implicit precision) |
| currency |
S | 0..1 | code | ISO 4217 Currency Code |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.status | Base | required | HealthAppPrescriptionUnitStatus | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | HealthAppPrescriptionUnitPriceComponentType | 📦3.1.0-TEST | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ChargeItemDefinition |
SC | 0..* | ChargeItemDefinition | Prescription or usage unit of a digital application Constraints: cid-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| extension:anwendungsdauer |
S | 0..1 | Duration | Duration of use URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer | ||||
| extension:ergaenzendeUnterstuetzungsleistungen |
S | 0..1 | (Complex) | Additional support services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen | ||||
| extension:indikation |
S | 0..1 | (Complex) | Indications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation | ||||
| extension:kontraindikation |
S | 0..1 | (Complex) | Contraindications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation | ||||
| extension:vertragsaerztlicheLeistungen |
S | 0..1 | (Complex) | Additional services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Directory URL | ||||
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers Slice: Unordered, Open by value:system | ||||
| identifier:digaVeId |
SΣ | 0..1 | Identifier | DiGA prescription unit ID (DiGA-VE-ID) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DigaVeId | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:dipaAeId |
SΣ | 0..1 | Identifier | DiPA usage unit ID (DiPA-AE-ID) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DipaAeId | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the charge item definition | ||||
| title |
SΣ | 0..1 | string | Name | ||||
| derivedFromUri |
Σ | 0..* | uri | Underlying externally-defined charge item definition | ||||
| partOf |
Σ | 0..* | canonical(ChargeItemDefinition) | A larger definition of which this particular definition is a component or step | ||||
| replaces |
Σ | 0..* | canonical(ChargeItemDefinition) | Completed or terminated request(s) whose function is taken by this new request | ||||
| status |
?!SΣ | 1..1 | code | Status Binding: HealthAppPrescriptionUnitStatus (required) | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
SΣ | 0..1 | markdown | Notes on the pricing model | ||||
| Slices for useContext |
SΣ | 0..* | UsageContext | Patient and target groups Slice: Unordered, Open by value:code.code | ||||
| useContext:age |
SΣ | 0..* | UsageContext | Age groups | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age | ||||
| display |
SΣ | 1..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..1 | CodingHealthAppAge | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Comment | ||||
| useContext:focus |
SΣ | 0..* | UsageContext | Impairments | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | ||||
| display |
SΣ | 1..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:severity |
S | 0..* | CodingHealthAppSeverity | Severity level URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity | ||||
| coding |
SΣ | 1..1 | CodingHealthAppFocus | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| useContext:gender |
SΣ | 0..* | UsageContext | Genders | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender | ||||
| display |
SΣ | 1..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..1 | CodingHealthAppGender | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for charge item definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the charge item definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the charge item definition was last reviewed | |||||
| effectivePeriod |
SΣ | 0..1 | Period | Validity period | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| code |
SΣ | 0..1 | CodeableConcept | Coding Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:validUntil |
S | 0..1 | dateTime | Valid until URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil | ||||
| coding |
SΣ | 1..1 | CodingPZN | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Canonische CodeSystem URL für PZN Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Der PZN-Code | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| instance |
S | 1..1 | Reference(Medication | Substance | Device) | HealthAppModule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| extension:deviceDefinition |
S | 1..1 | Reference(HealthAppModule) | Reference URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink | ||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| applicability |
0..* | BackboneElement | Whether or not the billing code is applicable | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | string | Natural language description of the condition | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | Boolean-valued expression | |||||
| propertyGroup |
S | 0..1 | BackboneElement | Group of properties which are applicable under the same conditions | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:nonRefundable |
S | 0..1 | (Complex) | Non-refundable costs URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| applicability |
0..* | See applicability (ChargeItemDefinition) | Conditions under which the priceComponent is applicable | |||||
| priceComponent |
S | 0..* | BackboneElement | Price information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
S | 1..1 | code | Price component type Binding: HealthAppPrescriptionUnitPriceComponentType (required) | ||||
| code |
S | 0..1 | CodeableConcept | Price component code | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 0..1 | CodingHealthAppPriceCode | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| factor |
0..1 | decimal | Factor used for calculating this component | |||||
| amount |
S | 0..1 | Money | Amount | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| currency |
SΣ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:digaVeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:digaVeId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:dipaAeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:dipaAeId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.status | Base | required | HealthAppPrescriptionUnitStatus | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.useContext:age.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:age.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.code | Base | example | ChargeItemCode | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.instance.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | HealthAppPrescriptionUnitPriceComponentType | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.propertyGroup.priceComponent.amount.currency | Base | required | CurrencyCode | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cid-0 | warning | ChargeItemDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | ChargeItemDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ChargeItemDefinition | 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-4 | error | ChargeItemDefinition | 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-5 | error | ChargeItemDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ChargeItemDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ChargeItemDefinition
Summary
Mandatory: 3 elements(17 nested mandatory elements)
Must-Support: 61 elements
Fixed: 8 elements
Structures
This structure refers to these other structures:
- Coding for HealthAppAge (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppAge)
- Coding for HealthAppFocus (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppFocus)
- Coding for HealthAppGender (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppGender)
- Coding-Profil für PZN (http://fhir.de/StructureDefinition/CodingPZN)
- Coding for HealthAppPriceCode (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppPriceCode)
Extensions
This structure refers to these extensions:
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of ChargeItemDefinition.identifier
- The element 1 is sliced based on the value of ChargeItemDefinition.useContext
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ChargeItemDefinition |
SC | 0..* | ChargeItemDefinition | Prescription or usage unit of a digital application Constraints: cid-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:anwendungsdauer |
S | 0..1 | Duration | Duration of use URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer |
| extension:ergaenzendeUnterstuetzungsleistungen |
S | 0..1 | (Complex) | Additional support services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen |
| extension:indikation |
S | 0..1 | (Complex) | Indications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation |
| extension:kontraindikation |
S | 0..1 | (Complex) | Contraindications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation |
| extension:vertragsaerztlicheLeistungen |
S | 0..1 | (Complex) | Additional services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Directory URL |
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers Slice: Unordered, Open by value:system |
| identifier:digaVeId |
SΣ | 0..1 | Identifier | DiGA prescription unit ID (DiGA-VE-ID) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DigaVeId |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:dipaAeId |
SΣ | 0..1 | Identifier | DiPA usage unit ID (DiPA-AE-ID) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DipaAeId |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| title |
SΣ | 0..1 | string | Name |
| status |
?!SΣ | 1..1 | code | Status Binding: HealthAppPrescriptionUnitStatus (required) |
| description |
SΣ | 0..1 | markdown | Notes on the pricing model |
| Slices for useContext |
SΣ | 0..* | UsageContext | Patient and target groups Slice: Unordered, Open by value:code.code |
| useContext:age |
SΣ | 0..* | UsageContext | Age groups |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
| coding |
SΣ | 1..1 | CodingHealthAppAge | Code defined by a terminology system |
| text |
SΣ | 0..1 | string | Comment |
| useContext:focus |
SΣ | 0..* | UsageContext | Impairments |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:severity |
S | 0..* | CodingHealthAppSeverity | Severity level URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity |
| coding |
SΣ | 1..1 | CodingHealthAppFocus | Code defined by a terminology system |
| useContext:gender |
SΣ | 0..* | UsageContext | Genders |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
| coding |
SΣ | 1..1 | CodingHealthAppGender | Code defined by a terminology system |
| effectivePeriod |
SΣ | 0..1 | Period | Validity period |
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| code |
SΣ | 0..1 | CodeableConcept | Coding Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:validUntil |
S | 0..1 | dateTime | Valid until URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil |
| coding |
SΣ | 1..1 | CodingPZN | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Canonische CodeSystem URL für PZN Fixed Value: http://fhir.de/CodeSystem/ifa/pzn |
| code |
SΣ | 1..1 | code | Der PZN-Code |
| instance |
S | 1..1 | Reference(Medication | Substance | Device) | HealthAppModule |
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:deviceDefinition |
S | 1..1 | Reference(HealthAppModule) | Reference URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink |
| propertyGroup |
S | 0..1 | BackboneElement | Group of properties which are applicable under the same conditions |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nonRefundable |
S | 0..1 | (Complex) | Non-refundable costs URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| priceComponent |
S | 0..* | BackboneElement | Price information |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
S | 1..1 | code | Price component type Binding: HealthAppPrescriptionUnitPriceComponentType (required) |
| code |
S | 0..1 | CodeableConcept | Price component code |
| coding |
SΣ | 0..1 | CodingHealthAppPriceCode | Code defined by a terminology system |
| amount |
S | 0..1 | Money | Amount |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
| currency |
SΣ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.identifier:digaVeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:dipaAeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.status | Base | required | HealthAppPrescriptionUnitStatus | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.useContext:age.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:age.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.code | Base | example | ChargeItemCode | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | HealthAppPrescriptionUnitPriceComponentType | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.propertyGroup.priceComponent.amount.currency | Base | required | CurrencyCode | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cid-0 | warning | ChargeItemDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | ChargeItemDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ChargeItemDefinition | 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-4 | error | ChargeItemDefinition | 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-5 | error | ChargeItemDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ChargeItemDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ChargeItemDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ChargeItemDefinition |
S | 0..* | ChargeItemDefinition | Prescription or usage unit of a digital application |
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:anwendungsdauer |
S | 0..1 | Duration | Duration of use URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer |
| extension:ergaenzendeUnterstuetzungsleistungen |
S | 0..1 | (Complex) | Additional support services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen |
| extension:indikation |
S | 0..1 | (Complex) | Indications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation |
| extension:kontraindikation |
S | 0..1 | (Complex) | Contraindications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation |
| extension:vertragsaerztlicheLeistungen |
S | 0..1 | (Complex) | Additional services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen |
| url |
S | 1..1 | uri | Directory URL |
| Slices for identifier |
S | 0..* | Identifier | Identifiers Slice: Unordered, Open by value:system |
| identifier:digaVeId |
S | 0..1 | Identifier | DiGA prescription unit ID (DiGA-VE-ID) |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DigaVeId |
| value |
S | 1..1 | string | The value that is unique |
| identifier:dipaAeId |
S | 0..1 | Identifier | DiPA usage unit ID (DiPA-AE-ID) |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DipaAeId |
| value |
S | 1..1 | string | The value that is unique |
| title |
S | 0..1 | string | Name |
| status |
S | 1..1 | code | Status Binding: HealthAppPrescriptionUnitStatus (required) |
| description |
S | 0..1 | markdown | Notes on the pricing model |
| Slices for useContext |
S | 0..* | UsageContext | Patient and target groups Slice: Unordered, Open by value:code.code |
| useContext:age |
S | 0..* | UsageContext | Age groups |
| code |
S | 1..1 | Coding | Type of context being specified |
| system |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age |
| display |
S | 1..1 | string | Representation defined by the system |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context |
| coding |
S | 1..1 | CodingHealthAppAge | Code defined by a terminology system |
| text |
S | 0..1 | string | Comment |
| useContext:focus |
S | 0..* | UsageContext | Impairments |
| code |
S | 1..1 | Coding | Type of context being specified |
| system |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus |
| display |
S | 1..1 | string | Representation defined by the system |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context |
| Slices for extension |
Content/Rules for all slices | |||
| extension:severity |
S | 0..* | CodingHealthAppSeverity | Severity level URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity |
| coding |
S | 1..1 | CodingHealthAppFocus | Code defined by a terminology system |
| useContext:gender |
S | 0..* | UsageContext | Genders |
| code |
S | 1..1 | Coding | Type of context being specified |
| system |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender |
| display |
S | 1..1 | string | Representation defined by the system |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context |
| coding |
S | 1..1 | CodingHealthAppGender | Code defined by a terminology system |
| effectivePeriod |
S | 0..1 | Period | Validity period |
| start |
S | 0..1 | dateTime | Starting time with inclusive boundary |
| end |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| code |
S | 0..1 | CodeableConcept | Coding |
| Slices for extension |
Content/Rules for all slices | |||
| extension:validUntil |
S | 0..1 | dateTime | Valid until URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil |
| coding |
S | 1..1 | CodingPZN | Code defined by a terminology system |
| system |
S | 1..1 | uri | Canonische CodeSystem URL für PZN |
| code |
S | 1..1 | code | Der PZN-Code |
| instance |
S | 1..1 | Reference(Medication | Substance | Device) | HealthAppModule |
| extension |
S | 1..* | Extension | Extension |
| Slices for extension |
Content/Rules for all slices | |||
| extension:deviceDefinition |
S | 1..1 | Reference(HealthAppModule) | Reference URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink |
| propertyGroup |
S | 0..1 | BackboneElement | Group of properties which are applicable under the same conditions |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nonRefundable |
S | 0..1 | (Complex) | Non-refundable costs URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable |
| priceComponent |
S | 0..* | BackboneElement | Price information |
| type |
S | 1..1 | code | Price component type Binding: HealthAppPrescriptionUnitPriceComponentType (required) |
| code |
S | 0..1 | CodeableConcept | Price component code |
| coding |
S | 0..1 | CodingHealthAppPriceCode | Code defined by a terminology system |
| amount |
S | 0..1 | Money | Amount |
| value |
S | 0..1 | decimal | Numerical value (with implicit precision) |
| currency |
S | 0..1 | code | ISO 4217 Currency Code |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.status | Base | required | HealthAppPrescriptionUnitStatus | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | HealthAppPrescriptionUnitPriceComponentType | 📦3.1.0-TEST | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ChargeItemDefinition |
SC | 0..* | ChargeItemDefinition | Prescription or usage unit of a digital application Constraints: cid-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| extension:anwendungsdauer |
S | 0..1 | Duration | Duration of use URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer | ||||
| extension:ergaenzendeUnterstuetzungsleistungen |
S | 0..1 | (Complex) | Additional support services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen | ||||
| extension:indikation |
S | 0..1 | (Complex) | Indications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation | ||||
| extension:kontraindikation |
S | 0..1 | (Complex) | Contraindications URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation | ||||
| extension:vertragsaerztlicheLeistungen |
S | 0..1 | (Complex) | Additional services URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Directory URL | ||||
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers Slice: Unordered, Open by value:system | ||||
| identifier:digaVeId |
SΣ | 0..1 | Identifier | DiGA prescription unit ID (DiGA-VE-ID) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DigaVeId | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:dipaAeId |
SΣ | 0..1 | Identifier | DiPA usage unit ID (DiPA-AE-ID) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/DipaAeId | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the charge item definition | ||||
| title |
SΣ | 0..1 | string | Name | ||||
| derivedFromUri |
Σ | 0..* | uri | Underlying externally-defined charge item definition | ||||
| partOf |
Σ | 0..* | canonical(ChargeItemDefinition) | A larger definition of which this particular definition is a component or step | ||||
| replaces |
Σ | 0..* | canonical(ChargeItemDefinition) | Completed or terminated request(s) whose function is taken by this new request | ||||
| status |
?!SΣ | 1..1 | code | Status Binding: HealthAppPrescriptionUnitStatus (required) | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
SΣ | 0..1 | markdown | Notes on the pricing model | ||||
| Slices for useContext |
SΣ | 0..* | UsageContext | Patient and target groups Slice: Unordered, Open by value:code.code | ||||
| useContext:age |
SΣ | 0..* | UsageContext | Age groups | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age | ||||
| display |
SΣ | 1..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..1 | CodingHealthAppAge | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Comment | ||||
| useContext:focus |
SΣ | 0..* | UsageContext | Impairments | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | ||||
| display |
SΣ | 1..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:severity |
S | 0..* | CodingHealthAppSeverity | Severity level URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity | ||||
| coding |
SΣ | 1..1 | CodingHealthAppFocus | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| useContext:gender |
SΣ | 0..* | UsageContext | Genders | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender | ||||
| display |
SΣ | 1..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..1 | CodingHealthAppGender | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for charge item definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the charge item definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the charge item definition was last reviewed | |||||
| effectivePeriod |
SΣ | 0..1 | Period | Validity period | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| code |
SΣ | 0..1 | CodeableConcept | Coding Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:validUntil |
S | 0..1 | dateTime | Valid until URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil | ||||
| coding |
SΣ | 1..1 | CodingPZN | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Canonische CodeSystem URL für PZN Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Der PZN-Code | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| instance |
S | 1..1 | Reference(Medication | Substance | Device) | HealthAppModule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| extension:deviceDefinition |
S | 1..1 | Reference(HealthAppModule) | Reference URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink | ||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| applicability |
0..* | BackboneElement | Whether or not the billing code is applicable | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | string | Natural language description of the condition | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | Boolean-valued expression | |||||
| propertyGroup |
S | 0..1 | BackboneElement | Group of properties which are applicable under the same conditions | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:nonRefundable |
S | 0..1 | (Complex) | Non-refundable costs URL: https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| applicability |
0..* | See applicability (ChargeItemDefinition) | Conditions under which the priceComponent is applicable | |||||
| priceComponent |
S | 0..* | BackboneElement | Price information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
S | 1..1 | code | Price component type Binding: HealthAppPrescriptionUnitPriceComponentType (required) | ||||
| code |
S | 0..1 | CodeableConcept | Price component code | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 0..1 | CodingHealthAppPriceCode | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| factor |
0..1 | decimal | Factor used for calculating this component | |||||
| amount |
S | 0..1 | Money | Amount | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| currency |
SΣ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:digaVeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:digaVeId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:dipaAeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.identifier:dipaAeId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.status | Base | required | HealthAppPrescriptionUnitStatus | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.useContext:age.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:age.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:focus.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.useContext:gender.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.code | Base | example | ChargeItemCode | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.instance.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | HealthAppPrescriptionUnitPriceComponentType | 📦3.1.0-TEST | This IG |
| ChargeItemDefinition.propertyGroup.priceComponent.amount.currency | Base | required | CurrencyCode | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cid-0 | warning | ChargeItemDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | ChargeItemDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ChargeItemDefinition | 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-4 | error | ChargeItemDefinition | 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-5 | error | ChargeItemDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ChargeItemDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ChargeItemDefinition
Summary
Mandatory: 3 elements(17 nested mandatory elements)
Must-Support: 61 elements
Fixed: 8 elements
Structures
This structure refers to these other structures:
- Coding for HealthAppAge (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppAge)
- Coding for HealthAppFocus (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppFocus)
- Coding for HealthAppGender (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppGender)
- Coding-Profil für PZN (http://fhir.de/StructureDefinition/CodingPZN)
- Coding for HealthAppPriceCode (https://fhir.bfarm.de/StructureDefinition/CodingHealthAppPriceCode)
Extensions
This structure refers to these extensions:
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitCodeValidUntil
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink
- https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of ChargeItemDefinition.identifier
- The element 1 is sliced based on the value of ChargeItemDefinition.useContext
Other representations of profile: CSV, Excel, Schematron