German Practice Management FHIR Profiles (R4)
Version 0.99.1 - release

Resource Profile: Praxis Billing Rule Set Library

Official URL: https://fhir.cognovis.de/praxis/StructureDefinition/praxis-billing-rule-set-library Version: 0.99.1
Active as of 2026-08-22 Computable Name: PraxisBillingRuleSetLibrary
Other Identifiers: OID:2.16.840.1.113883.3.7985.42.224

Copyright/Legal: Copyright 2026+ cognovis GmbH. Cognovis-authored material is licensed under Apache-2.0; third-party material retains its own terms as documented in THIRD_PARTY_NOTICES.md.

Versioned, partitioned envelope for declarative relational and aggregate billing rules.

The Library contains one schema-identified JSON payload. It does not carry CQL or FHIRPath execution logic. Rule semantics are defined by the billing-rule vocabularies and the referenced payload schema; a private evaluator consumes the resolved artifact. One instance represents one source, catalog scope, effective period, and optional contract, tenant, or specialty partition.

Usages:

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
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
.... extension:payloadSchema S 1..1 uri Billing Rule Payload Schema
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 2..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:ruleSetId SΣ 1..1 Identifier Additional identifier for the library
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:sourceBatchId SΣ 1..1 Identifier Additional identifier for the library
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id
..... value Σ 1..1 string The value that is unique
Example General: 123456
... version SΣ 1..1 string Business version of the library
... name SΣC 1..1 string Name for this library (computer friendly)
... title SΣ 1..1 string Name for this library (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: Billing Rule Set Status (required)
... experimental SΣ 1..1 boolean For testing purposes, not real usage
Required Pattern: false
... type SΣ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Fixed Value: As shown (Asset Collection)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: asset-collection
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... Slices for useContext SΣ 3..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:billingRegime SΣ 1..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billing-regime
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Abrechnungsart (extensible)
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:catalogScope SΣ 1..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: catalog-scope
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:source SΣ 1..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: source
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:contract SΣ 0..* UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contract
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:tenant SΣ 0..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tenant
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 Reference(Organization) Value that defines the context
.... useContext:specialty SΣ 0..* UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: specialty
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
... effectivePeriod SΣ 1..1 Period When the library is expected to be used
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... content SΣ 1..1 Attachment Contents of the library, either embedded or referenced
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/json
.... data S 1..1 base64Binary Data inline, base64ed
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.identifier:ruleSetId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:sourceBatchId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.status Base required Billing Rule Set Status 📦0.99.1 This IG
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​value[x] Base extensible Abrechnungsart 📦0.99.1 This IG
Library.useContext:catalogScope.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:catalogScope.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:source.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:source.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:contract.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:contract.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:tenant.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.content.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-source-manifest-digest error Library.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 Library 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 Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library 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()
lib-0 warning Library 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}')

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 0..* Library Represents a library of quality improvement components
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest S 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
.... extension:payloadSchema S 1..1 uri Billing Rule Payload Schema
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema
... url S 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... Slices for identifier S 2..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:ruleSetId S 1..1 Identifier Additional identifier for the library
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id
..... value 1..1 string The value that is unique
.... identifier:sourceBatchId S 1..1 Identifier Additional identifier for the library
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id
..... value 1..1 string The value that is unique
... name S 1..1 string Name for this library (computer friendly)
... title S 1..1 string Name for this library (human friendly)
... status S 1..1 code draft | active | retired | unknown
Binding: Billing Rule Set Status (required)
... experimental S 1..1 boolean For testing purposes, not real usage
Required Pattern: false
... type S 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Fixed Value: As shown (Asset Collection)
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: asset-collection
... Slices for useContext S 3..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:billingRegime S 1..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billing-regime
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: Abrechnungsart (extensible)
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:catalogScope S 1..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: catalog-scope
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:source S 1..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: source
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:contract S 0..* UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contract
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:tenant S 0..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tenant
..... value[x] 1..1 Reference(Organization) Value that defines the context
.... useContext:specialty S 0..* UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: specialty
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
... effectivePeriod S 1..1 Period When the library is expected to be used
.... start S 1..1 dateTime Starting time with inclusive boundary
.... end S 1..1 dateTime End time with inclusive boundary, if not ongoing
... parameter 0..0 Parameters defined by the library
... dataRequirement 0..0 What data is referenced by this library
... content S 1..1 Attachment Contents of the library, either embedded or referenced
.... contentType S 1..1 code Mime type of the content, with charset etc.
Fixed Value: application/json
.... language 0..0 Human language of the content (BCP-47)
.... data S 1..1 base64Binary Data inline, base64ed
.... url 0..0 Uri where the data can be found
.... title S 0..1 string Label to display in place of the data
.... creation S 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Library.status Base required Billing Rule Set Status 📦0.99.1 This IG
Library.useContext:billingRegime.​value[x] Base extensible Abrechnungsart 📦0.99.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
.... extension:payloadSchema S 1..1 uri Billing Rule Payload Schema
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... Slices for identifier SΣ 2..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:ruleSetId SΣ 1..1 Identifier Additional identifier for the library
..... 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 Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id
..... value Σ 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:sourceBatchId SΣ 1..1 Identifier Additional identifier for the library
..... 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 Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id
..... value Σ 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 SΣ 1..1 string Business version of the library
... name SΣC 1..1 string Name for this library (computer friendly)
... title SΣ 1..1 string Name for this library (human friendly)
... subtitle 0..1 string Subordinate title of the library
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: Billing Rule Set Status (required)
... experimental SΣ 1..1 boolean For testing purposes, not real usage
Required Pattern: false
... type SΣ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Fixed Value: As shown (Asset Collection)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: asset-collection
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... 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 Σ 0..1 markdown Natural language description of the library
... Slices for useContext SΣ 3..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:billingRegime SΣ 1..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billing-regime
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Abrechnungsart (extensible)
...... 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:catalogScope SΣ 1..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: catalog-scope
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:source SΣ 1..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: source
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:contract SΣ 0..* UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contract
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:tenant SΣ 0..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tenant
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 Reference(Organization) Value that defines the context
.... useContext:specialty SΣ 0..* UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: specialty
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this library is defined
... usage 0..1 string Describes the clinical usage of the library
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed
... effectivePeriod SΣ 1..1 Period When the library is expected to be used
.... 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 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... content SΣ 1..1 Attachment Contents of the library, either embedded or referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/json
.... data S 1..1 base64Binary Data inline, base64ed
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.identifier:ruleSetId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:ruleSetId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:sourceBatchId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:sourceBatchId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.status Base required Billing Rule Set Status 📦0.99.1 This IG
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​value[x] Base extensible Abrechnungsart 📦0.99.1 This IG
Library.useContext:catalogScope.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:catalogScope.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:source.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:source.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:contract.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:contract.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:tenant.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.content.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-source-manifest-digest error Library.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 Library 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 Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library 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()
lib-0 warning Library 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}')

This structure is derived from Library

Summary

Mandatory: 31 elements(6 nested mandatory elements)
Must-Support: 27 elements
Fixed: 4 elements
Prohibited: 4 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 Library.identifier
  • The element 1 is sliced based on the value of Library.useContext

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
.... extension:payloadSchema S 1..1 uri Billing Rule Payload Schema
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 2..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:ruleSetId SΣ 1..1 Identifier Additional identifier for the library
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:sourceBatchId SΣ 1..1 Identifier Additional identifier for the library
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id
..... value Σ 1..1 string The value that is unique
Example General: 123456
... version SΣ 1..1 string Business version of the library
... name SΣC 1..1 string Name for this library (computer friendly)
... title SΣ 1..1 string Name for this library (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: Billing Rule Set Status (required)
... experimental SΣ 1..1 boolean For testing purposes, not real usage
Required Pattern: false
... type SΣ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Fixed Value: As shown (Asset Collection)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: asset-collection
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... Slices for useContext SΣ 3..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:billingRegime SΣ 1..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billing-regime
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Abrechnungsart (extensible)
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:catalogScope SΣ 1..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: catalog-scope
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:source SΣ 1..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: source
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:contract SΣ 0..* UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contract
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
.... useContext:tenant SΣ 0..1 UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tenant
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 Reference(Organization) Value that defines the context
.... useContext:specialty SΣ 0..* UsageContext The context that the content is intended to support
..... code Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: specialty
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code Σ 1..1 code Symbol in syntax defined by the system
... effectivePeriod SΣ 1..1 Period When the library is expected to be used
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... content SΣ 1..1 Attachment Contents of the library, either embedded or referenced
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/json
.... data S 1..1 base64Binary Data inline, base64ed
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.identifier:ruleSetId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:sourceBatchId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.status Base required Billing Rule Set Status 📦0.99.1 This IG
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​value[x] Base extensible Abrechnungsart 📦0.99.1 This IG
Library.useContext:catalogScope.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:catalogScope.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:source.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:source.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:contract.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:contract.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:tenant.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.content.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-source-manifest-digest error Library.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 Library 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 Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library 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()
lib-0 warning Library 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}')

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 0..* Library Represents a library of quality improvement components
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest S 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
.... extension:payloadSchema S 1..1 uri Billing Rule Payload Schema
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema
... url S 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... Slices for identifier S 2..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:ruleSetId S 1..1 Identifier Additional identifier for the library
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id
..... value 1..1 string The value that is unique
.... identifier:sourceBatchId S 1..1 Identifier Additional identifier for the library
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id
..... value 1..1 string The value that is unique
... name S 1..1 string Name for this library (computer friendly)
... title S 1..1 string Name for this library (human friendly)
... status S 1..1 code draft | active | retired | unknown
Binding: Billing Rule Set Status (required)
... experimental S 1..1 boolean For testing purposes, not real usage
Required Pattern: false
... type S 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Fixed Value: As shown (Asset Collection)
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: asset-collection
... Slices for useContext S 3..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:billingRegime S 1..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billing-regime
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: Abrechnungsart (extensible)
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:catalogScope S 1..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: catalog-scope
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:source S 1..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: source
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:contract S 0..* UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contract
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
.... useContext:tenant S 0..1 UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tenant
..... value[x] 1..1 Reference(Organization) Value that defines the context
.... useContext:specialty S 0..* UsageContext The context that the content is intended to support
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: specialty
..... value[x] 1..1 CodeableConcept Value that defines the context
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
... effectivePeriod S 1..1 Period When the library is expected to be used
.... start S 1..1 dateTime Starting time with inclusive boundary
.... end S 1..1 dateTime End time with inclusive boundary, if not ongoing
... parameter 0..0 Parameters defined by the library
... dataRequirement 0..0 What data is referenced by this library
... content S 1..1 Attachment Contents of the library, either embedded or referenced
.... contentType S 1..1 code Mime type of the content, with charset etc.
Fixed Value: application/json
.... language 0..0 Human language of the content (BCP-47)
.... data S 1..1 base64Binary Data inline, base64ed
.... url 0..0 Uri where the data can be found
.... title S 0..1 string Label to display in place of the data
.... creation S 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Library.status Base required Billing Rule Set Status 📦0.99.1 This IG
Library.useContext:billingRegime.​value[x] Base extensible Abrechnungsart 📦0.99.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
.... extension:payloadSchema S 1..1 uri Billing Rule Payload Schema
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... Slices for identifier SΣ 2..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:ruleSetId SΣ 1..1 Identifier Additional identifier for the library
..... 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 Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id
..... value Σ 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:sourceBatchId SΣ 1..1 Identifier Additional identifier for the library
..... 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 Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id
..... value Σ 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 SΣ 1..1 string Business version of the library
... name SΣC 1..1 string Name for this library (computer friendly)
... title SΣ 1..1 string Name for this library (human friendly)
... subtitle 0..1 string Subordinate title of the library
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: Billing Rule Set Status (required)
... experimental SΣ 1..1 boolean For testing purposes, not real usage
Required Pattern: false
... type SΣ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Fixed Value: As shown (Asset Collection)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: asset-collection
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... 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 Σ 0..1 markdown Natural language description of the library
... Slices for useContext SΣ 3..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:billingRegime SΣ 1..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billing-regime
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Abrechnungsart (extensible)
...... 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:catalogScope SΣ 1..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: catalog-scope
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:source SΣ 1..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: source
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:contract SΣ 0..* UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contract
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
.... useContext:tenant SΣ 0..1 UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tenant
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 Reference(Organization) Value that defines the context
.... useContext:specialty SΣ 0..* UsageContext The context that the content is intended to support
..... 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 Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: specialty
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 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 Σ 1..* Coding 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
....... 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
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this library is defined
... usage 0..1 string Describes the clinical usage of the library
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed
... effectivePeriod SΣ 1..1 Period When the library is expected to be used
.... 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 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... content SΣ 1..1 Attachment Contents of the library, either embedded or referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/json
.... data S 1..1 base64Binary Data inline, base64ed
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.identifier:ruleSetId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:ruleSetId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:sourceBatchId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:sourceBatchId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.status Base required Billing Rule Set Status 📦0.99.1 This IG
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:billingRegime.​value[x] Base extensible Abrechnungsart 📦0.99.1 This IG
Library.useContext:catalogScope.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:catalogScope.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:source.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:source.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:contract.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:contract.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:tenant.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specialty.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.content.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-source-manifest-digest error Library.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 Library 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 Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library 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()
lib-0 warning Library 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}')

This structure is derived from Library

Summary

Mandatory: 31 elements(6 nested mandatory elements)
Must-Support: 27 elements
Fixed: 4 elements
Prohibited: 4 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 Library.identifier
  • The element 1 is sliced based on the value of Library.useContext

 

Other representations of profile: CSV, Excel, Schematron