0.1.0 - ci-build

collabreefhirdocumentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Collabree Medication Profile

Official URL: https://fhir.collabree.com/fhir/StructureDefinition/collabree-medication Version: 0.1.0
Draft as of 2025-11-04 Computable Name: CollabreeMedication

Unified profile for all medications available in the Collabree system, supporting both Swiss and Arab medication catalogs with country-specific attributes and terminology

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
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:expirationInMonths 0..1 integer Medication Expiration in Months
URL: https://fhir.collabree.com/Extensions/medication-expiration-in-months
.... extension:imageUrl 0..1 uri Medication Image URL
URL: https://fhir.collabree.com/Extensions/medication-image-url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:country Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/country-code
..... value Σ 1..1 string The value that is unique
Binding: Collabree Allowed Country Value Set (required)
Example General: 123456
.... identifier:dataProviderId Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/data-provider-id
..... value Σ 1..1 string The value that is unique
Binding: Data Provider ID Value Set (required)
Example General: 123456
.... identifier:gtin Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/Extensions/gtin
..... value Σ 1..1 string The value that is unique
Example General: 123456
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... Slices for extension Content/Rules for all slices
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 763158003
..... display Σ 1..1 string Representation defined by the system
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.identifier:country.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:country.​value Base required Collabree Allowed Country Value Set 📦0.1.0 This IG
Medication.identifier:dataProviderId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:dataProviderId.​value Base required Data Provider ID Value Set 📦0.1.0 This IG
Medication.identifier:gtin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:expirationInMonths 0..1 integer Medication Expiration in Months
URL: https://fhir.collabree.com/Extensions/medication-expiration-in-months
.... extension:imageUrl 0..1 uri Medication Image URL
URL: https://fhir.collabree.com/Extensions/medication-image-url
... Slices for identifier 3..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:country 1..1 Identifier Business identifier for this medication
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.collabree.com/fhir/Extension/country-code
..... value 1..1 string The value that is unique
Binding: Collabree Allowed Country Value Set (required)
.... identifier:dataProviderId 1..1 Identifier Business identifier for this medication
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.collabree.com/fhir/Extension/data-provider-id
..... value 1..1 string The value that is unique
Binding: Data Provider ID Value Set (required)
.... identifier:gtin 1..1 Identifier Business identifier for this medication
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.collabree.com/Extensions/gtin
..... value 1..1 string The value that is unique
... code 1..1 CodeableConcept Codes that identify this medication
.... coding 1..1 Coding Code defined by a terminology system
..... Slices for extension Content/Rules for all slices
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 763158003
..... display 1..1 string Representation defined by the system
.... coding 1..1 Coding Code defined by a terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... amount
.... numerator 1..1 Quantity Numerator value
..... Slices for extension Content/Rules for all slices
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value 1..1 decimal Numerical value (with implicit precision)
..... unit 1..1 string Unit representation
.... denominator 1..1 Quantity Denominator value
..... value 1..1 decimal Numerical value (with implicit precision)
..... unit 1..1 string Unit representation
Required Pattern: package
..... system 1..1 uri System that defines coded unit form
Required Pattern: http://snomed.info/sct
..... code 1..1 code Coded form of the unit
Binding: http://snomed.info/sct (required)
... ingredient
.... item[x] 1..1 CodeableConcept The actual ingredient or content
..... coding 1..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
...... display 1..1 string Representation defined by the system
.... strength
..... numerator 1..1 Quantity Numerator value
...... value 1..1 decimal Numerical value (with implicit precision)
...... unit 1..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
..... denominator 1..1 Quantity Denominator value
...... value 1..1 decimal Numerical value (with implicit precision)
...... unit 1..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.identifier:country.​value Base required Collabree Allowed Country Value Set 📦0.1.0 This IG
Medication.identifier:dataProviderId.​value Base required Data Provider ID Value Set 📦0.1.0 This IG
Medication.amount.denominator.​code Base required http://snomed.info/sct Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:expirationInMonths 0..1 integer Medication Expiration in Months
URL: https://fhir.collabree.com/Extensions/medication-expiration-in-months
.... extension:imageUrl 0..1 uri Medication Image URL
URL: https://fhir.collabree.com/Extensions/medication-image-url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 3..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:country Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/country-code
..... value Σ 1..1 string The value that is unique
Binding: Collabree Allowed Country Value Set (required)
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:dataProviderId Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/data-provider-id
..... value Σ 1..1 string The value that is unique
Binding: Data Provider ID Value Set (required)
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:gtin Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/Extensions/gtin
..... 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)
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... 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..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 763158003
..... display Σ 1..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
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
.... 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..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 Σ 0..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 Σ 1..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
... amount Σ 0..1 Ratio Amount of drug in package
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... numerator Σ 1..1 Quantity Numerator value
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value Σ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit representation
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
.... denominator Σ 1..1 Quantity Denominator value
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit representation
Required Pattern: package
..... system ΣC 1..1 uri System that defines coded unit form
Required Pattern: http://snomed.info/sct
..... code Σ 1..1 code Coded form of the unit
Binding: http://snomed.info/sct (required)
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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
.... item[x] 1..1 CodeableConcept The actual ingredient or content
..... 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..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 Σ 1..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
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... numerator Σ 1..1 Quantity Numerator value
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit Σ 1..1 string Unit representation
...... system ΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 1..1 code Coded form of the unit
..... denominator Σ 1..1 Quantity Denominator value
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit Σ 1..1 string Unit representation
...... system ΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 1..1 code Coded form of the unit
... batch 0..1 BackboneElement Details about packaged medications
.... 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
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.identifier:country.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:country.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Medication.identifier:country.​value Base required Collabree Allowed Country Value Set 📦0.1.0 This IG
Medication.identifier:dataProviderId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:dataProviderId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Medication.identifier:dataProviderId.​value Base required Data Provider ID Value Set 📦0.1.0 This IG
Medication.identifier:gtin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:gtin.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.amount.numerator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator.​code Base required http://snomed.info/sct Not State Unknown
Medication.ingredient.​strength.numerator.comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

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

Summary

Mandatory: 14 elements(25 nested mandatory 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 Medication.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:expirationInMonths 0..1 integer Medication Expiration in Months
URL: https://fhir.collabree.com/Extensions/medication-expiration-in-months
.... extension:imageUrl 0..1 uri Medication Image URL
URL: https://fhir.collabree.com/Extensions/medication-image-url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:country Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/country-code
..... value Σ 1..1 string The value that is unique
Binding: Collabree Allowed Country Value Set (required)
Example General: 123456
.... identifier:dataProviderId Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/data-provider-id
..... value Σ 1..1 string The value that is unique
Binding: Data Provider ID Value Set (required)
Example General: 123456
.... identifier:gtin Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/Extensions/gtin
..... value Σ 1..1 string The value that is unique
Example General: 123456
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... Slices for extension Content/Rules for all slices
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 763158003
..... display Σ 1..1 string Representation defined by the system
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.identifier:country.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:country.​value Base required Collabree Allowed Country Value Set 📦0.1.0 This IG
Medication.identifier:dataProviderId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:dataProviderId.​value Base required Data Provider ID Value Set 📦0.1.0 This IG
Medication.identifier:gtin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:expirationInMonths 0..1 integer Medication Expiration in Months
URL: https://fhir.collabree.com/Extensions/medication-expiration-in-months
.... extension:imageUrl 0..1 uri Medication Image URL
URL: https://fhir.collabree.com/Extensions/medication-image-url
... Slices for identifier 3..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:country 1..1 Identifier Business identifier for this medication
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.collabree.com/fhir/Extension/country-code
..... value 1..1 string The value that is unique
Binding: Collabree Allowed Country Value Set (required)
.... identifier:dataProviderId 1..1 Identifier Business identifier for this medication
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.collabree.com/fhir/Extension/data-provider-id
..... value 1..1 string The value that is unique
Binding: Data Provider ID Value Set (required)
.... identifier:gtin 1..1 Identifier Business identifier for this medication
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.collabree.com/Extensions/gtin
..... value 1..1 string The value that is unique
... code 1..1 CodeableConcept Codes that identify this medication
.... coding 1..1 Coding Code defined by a terminology system
..... Slices for extension Content/Rules for all slices
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 763158003
..... display 1..1 string Representation defined by the system
.... coding 1..1 Coding Code defined by a terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... amount
.... numerator 1..1 Quantity Numerator value
..... Slices for extension Content/Rules for all slices
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value 1..1 decimal Numerical value (with implicit precision)
..... unit 1..1 string Unit representation
.... denominator 1..1 Quantity Denominator value
..... value 1..1 decimal Numerical value (with implicit precision)
..... unit 1..1 string Unit representation
Required Pattern: package
..... system 1..1 uri System that defines coded unit form
Required Pattern: http://snomed.info/sct
..... code 1..1 code Coded form of the unit
Binding: http://snomed.info/sct (required)
... ingredient
.... item[x] 1..1 CodeableConcept The actual ingredient or content
..... coding 1..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
...... display 1..1 string Representation defined by the system
.... strength
..... numerator 1..1 Quantity Numerator value
...... value 1..1 decimal Numerical value (with implicit precision)
...... unit 1..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
..... denominator 1..1 Quantity Denominator value
...... value 1..1 decimal Numerical value (with implicit precision)
...... unit 1..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.identifier:country.​value Base required Collabree Allowed Country Value Set 📦0.1.0 This IG
Medication.identifier:dataProviderId.​value Base required Data Provider ID Value Set 📦0.1.0 This IG
Medication.amount.denominator.​code Base required http://snomed.info/sct Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:expirationInMonths 0..1 integer Medication Expiration in Months
URL: https://fhir.collabree.com/Extensions/medication-expiration-in-months
.... extension:imageUrl 0..1 uri Medication Image URL
URL: https://fhir.collabree.com/Extensions/medication-image-url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 3..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:country Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/country-code
..... value Σ 1..1 string The value that is unique
Binding: Collabree Allowed Country Value Set (required)
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:dataProviderId Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/fhir/Extension/data-provider-id
..... value Σ 1..1 string The value that is unique
Binding: Data Provider ID Value Set (required)
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:gtin Σ 1..1 Identifier Business identifier for this medication
..... 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
Required Pattern: https://fhir.collabree.com/Extensions/gtin
..... 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)
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... 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..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 763158003
..... display Σ 1..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
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
.... 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..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 Σ 0..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 Σ 1..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
... amount Σ 0..1 Ratio Amount of drug in package
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... numerator Σ 1..1 Quantity Numerator value
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value Σ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit representation
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
.... denominator Σ 1..1 Quantity Denominator value
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit representation
Required Pattern: package
..... system ΣC 1..1 uri System that defines coded unit form
Required Pattern: http://snomed.info/sct
..... code Σ 1..1 code Coded form of the unit
Binding: http://snomed.info/sct (required)
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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
.... item[x] 1..1 CodeableConcept The actual ingredient or content
..... 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..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 Σ 1..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
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... numerator Σ 1..1 Quantity Numerator value
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit Σ 1..1 string Unit representation
...... system ΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 1..1 code Coded form of the unit
..... denominator Σ 1..1 Quantity Denominator value
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit Σ 1..1 string Unit representation
...... system ΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 1..1 code Coded form of the unit
... batch 0..1 BackboneElement Details about packaged medications
.... 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
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.identifier:country.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:country.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Medication.identifier:country.​value Base required Collabree Allowed Country Value Set 📦0.1.0 This IG
Medication.identifier:dataProviderId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:dataProviderId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Medication.identifier:dataProviderId.​value Base required Data Provider ID Value Set 📦0.1.0 This IG
Medication.identifier:gtin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Medication.identifier:gtin.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.amount.numerator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator.​code Base required http://snomed.info/sct Not State Unknown
Medication.ingredient.​strength.numerator.comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

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

Summary

Mandatory: 14 elements(25 nested mandatory 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 Medication.identifier

 

Other representations of profile: CSV, Excel, Schematron