BfArM Digitale Anwendungen
3.1.0-TEST - draft

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: HealthAppCatalogEntry

Official URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry Version: 3.1.0-TEST
Active as of 2026-05-30 Computable Name: HealthAppCatalogEntry

Definition of an entry in the DiGA or DiPA catalog representing a digital health application (DiGA) or 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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CatalogEntry S 0..* CatalogEntry Catalog entry for a digital application
... 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:history S 0..* (Complex) Change history
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory
.... extension:trialPeriod S 0..1 (Complex) Trial period
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:url SΣ 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... orderable SΣ 1..1 boolean Orderable
... referencedItem SΣ 1..1 Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary) HealthApp
.... Slices for extension S 1..1 Extension Extension
Slice: Unordered, Open by value:url
..... extension:deviceDefinition S 1..1 Reference(HealthApp) HealthApp
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink
... Slices for additionalIdentifier S 0..* Identifier Catalog Entry IDs in the other catalog
Slice: Unordered, Open by value:system
.... additionalIdentifier:url S 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... status S 1..1 code Listing Status
Binding: HealthAppCatalogEntryStatus (required)
... validityPeriod S 0..1 Period Validity Period
.... start SΣC 0..1 dateTime First Day of Validity
.... end SΣC 0..1 dateTime Last Day of Validity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CatalogEntry.identifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.additionalIdentifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.status Base required HealthAppCatalogEntryStatus 📦3.1.0-TEST This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error CatalogEntry If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CatalogEntry 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 CatalogEntry 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 CatalogEntry If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CatalogEntry 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 CatalogEntry

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CatalogEntry S 0..* CatalogEntry Catalog entry for a digital application
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:history S 0..* (Complex) Change history
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory
.... extension:trialPeriod S 0..1 (Complex) Trial period
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod
... Slices for identifier S 0..* Identifier Catalog Entry IDs
Slice: Unordered, Open by value:system
.... identifier:url S 0..1 Identifier URL to Catalog Entry
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value S 1..1 string The value that is unique
... orderable S 1..1 boolean Orderable
.... extension S 1..1 Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:deviceDefinition S 1..1 Reference(HealthApp) HealthApp
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink
... Slices for additionalIdentifier S 0..* Identifier Catalog Entry IDs in the other catalog
Slice: Unordered, Open by value:system
.... additionalIdentifier:url S 0..1 Identifier URL to Catalog Entry
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value S 1..1 string The value that is unique
... status S 1..1 code Listing Status
Binding: HealthAppCatalogEntryStatus (required)
... validityPeriod S 0..1 Period Validity Period
.... start S 0..1 dateTime First Day of Validity
.... end S 0..1 dateTime Last Day of Validity

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CatalogEntry.status Base required HealthAppCatalogEntryStatus 📦3.1.0-TEST This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CatalogEntry S 0..* CatalogEntry Catalog entry for a digital application
... 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
... 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:history S 0..* (Complex) Change history
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory
.... extension:trialPeriod S 0..1 (Complex) Trial period
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Catalog Entry IDs
Slice: Unordered, Open by value:system
.... identifier:url SΣ 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... 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)
... type 0..1 CodeableConcept The type of item - medication, device, service, protocol or other
... orderable SΣ 1..1 boolean Orderable
... referencedItem SΣ 1..1 Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary) HealthApp
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension S 1..1 Extension Extension
Slice: Unordered, Open by value:url
..... extension:deviceDefinition S 1..1 Reference(HealthApp) HealthApp
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink
.... 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
... Slices for additionalIdentifier S 0..* Identifier Catalog Entry IDs in the other catalog
Slice: Unordered, Open by value:system
.... additionalIdentifier:url S 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... 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)
... classification 0..* CodeableConcept Classification (category or class) of the item entry
... status S 1..1 code Listing Status
Binding: HealthAppCatalogEntryStatus (required)
... validityPeriod 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 First Day of Validity
.... end SΣC 0..1 dateTime Last Day of Validity
... validTo 0..1 dateTime The date until which this catalog entry is expected to be active
... lastUpdated 0..1 dateTime When was this catalog last updated
... additionalCharacteristic 0..* CodeableConcept Additional characteristics of the catalog entry
... additionalClassification 0..* CodeableConcept Additional classification of the catalog entry
... relatedEntry 0..* BackboneElement An item that this catalog entry is related to
.... 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
.... relationtype 1..1 code triggers | is-replaced-by
Binding: CatalogEntryRelationType (required): The type of relations between entries.
.... item 1..1 Reference(CatalogEntry) The reference to the related item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CatalogEntry.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CatalogEntry.identifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.identifier:url.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CatalogEntry.referencedItem.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
CatalogEntry.additionalIdentifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.additionalIdentifier:url.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CatalogEntry.status Base required HealthAppCatalogEntryStatus 📦3.1.0-TEST This IG
CatalogEntry.relatedEntry.​relationtype Base required CatalogEntryRelationType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CatalogEntry If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CatalogEntry 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 CatalogEntry 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 CatalogEntry If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CatalogEntry 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 CatalogEntry

Summary

Mandatory: 3 elements(4 nested mandatory elements)
Must-Support: 19 elements
Fixed: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CatalogEntry.identifier
  • The element 1 is sliced based on the value of CatalogEntry.additionalIdentifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CatalogEntry S 0..* CatalogEntry Catalog entry for a digital application
... 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:history S 0..* (Complex) Change history
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory
.... extension:trialPeriod S 0..1 (Complex) Trial period
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:url SΣ 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... orderable SΣ 1..1 boolean Orderable
... referencedItem SΣ 1..1 Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary) HealthApp
.... Slices for extension S 1..1 Extension Extension
Slice: Unordered, Open by value:url
..... extension:deviceDefinition S 1..1 Reference(HealthApp) HealthApp
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink
... Slices for additionalIdentifier S 0..* Identifier Catalog Entry IDs in the other catalog
Slice: Unordered, Open by value:system
.... additionalIdentifier:url S 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... status S 1..1 code Listing Status
Binding: HealthAppCatalogEntryStatus (required)
... validityPeriod S 0..1 Period Validity Period
.... start SΣC 0..1 dateTime First Day of Validity
.... end SΣC 0..1 dateTime Last Day of Validity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CatalogEntry.identifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.additionalIdentifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.status Base required HealthAppCatalogEntryStatus 📦3.1.0-TEST This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error CatalogEntry If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CatalogEntry 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 CatalogEntry 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 CatalogEntry If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CatalogEntry 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 CatalogEntry

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CatalogEntry S 0..* CatalogEntry Catalog entry for a digital application
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:history S 0..* (Complex) Change history
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory
.... extension:trialPeriod S 0..1 (Complex) Trial period
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod
... Slices for identifier S 0..* Identifier Catalog Entry IDs
Slice: Unordered, Open by value:system
.... identifier:url S 0..1 Identifier URL to Catalog Entry
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value S 1..1 string The value that is unique
... orderable S 1..1 boolean Orderable
.... extension S 1..1 Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:deviceDefinition S 1..1 Reference(HealthApp) HealthApp
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink
... Slices for additionalIdentifier S 0..* Identifier Catalog Entry IDs in the other catalog
Slice: Unordered, Open by value:system
.... additionalIdentifier:url S 0..1 Identifier URL to Catalog Entry
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value S 1..1 string The value that is unique
... status S 1..1 code Listing Status
Binding: HealthAppCatalogEntryStatus (required)
... validityPeriod S 0..1 Period Validity Period
.... start S 0..1 dateTime First Day of Validity
.... end S 0..1 dateTime Last Day of Validity

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CatalogEntry.status Base required HealthAppCatalogEntryStatus 📦3.1.0-TEST This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CatalogEntry S 0..* CatalogEntry Catalog entry for a digital application
... 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
... 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:history S 0..* (Complex) Change history
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory
.... extension:trialPeriod S 0..1 (Complex) Trial period
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Catalog Entry IDs
Slice: Unordered, Open by value:system
.... identifier:url SΣ 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... 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)
... type 0..1 CodeableConcept The type of item - medication, device, service, protocol or other
... orderable SΣ 1..1 boolean Orderable
... referencedItem SΣ 1..1 Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary) HealthApp
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension S 1..1 Extension Extension
Slice: Unordered, Open by value:url
..... extension:deviceDefinition S 1..1 Reference(HealthApp) HealthApp
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink
.... 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
... Slices for additionalIdentifier S 0..* Identifier Catalog Entry IDs in the other catalog
Slice: Unordered, Open by value:system
.... additionalIdentifier:url S 0..1 Identifier URL to Catalog Entry
..... 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: urn:ietf:rfc:3986
..... 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)
... classification 0..* CodeableConcept Classification (category or class) of the item entry
... status S 1..1 code Listing Status
Binding: HealthAppCatalogEntryStatus (required)
... validityPeriod 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 First Day of Validity
.... end SΣC 0..1 dateTime Last Day of Validity
... validTo 0..1 dateTime The date until which this catalog entry is expected to be active
... lastUpdated 0..1 dateTime When was this catalog last updated
... additionalCharacteristic 0..* CodeableConcept Additional characteristics of the catalog entry
... additionalClassification 0..* CodeableConcept Additional classification of the catalog entry
... relatedEntry 0..* BackboneElement An item that this catalog entry is related to
.... 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
.... relationtype 1..1 code triggers | is-replaced-by
Binding: CatalogEntryRelationType (required): The type of relations between entries.
.... item 1..1 Reference(CatalogEntry) The reference to the related item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CatalogEntry.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CatalogEntry.identifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.identifier:url.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CatalogEntry.referencedItem.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
CatalogEntry.additionalIdentifier:url.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CatalogEntry.additionalIdentifier:url.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CatalogEntry.status Base required HealthAppCatalogEntryStatus 📦3.1.0-TEST This IG
CatalogEntry.relatedEntry.​relationtype Base required CatalogEntryRelationType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CatalogEntry If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CatalogEntry 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 CatalogEntry 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 CatalogEntry If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CatalogEntry 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 CatalogEntry

Summary

Mandatory: 3 elements(4 nested mandatory elements)
Must-Support: 19 elements
Fixed: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CatalogEntry.identifier
  • The element 1 is sliced based on the value of CatalogEntry.additionalIdentifier

 

Other representations of profile: CSV, Excel, Schematron