UnicomIG
0.1.0 - ci-build
UnicomIG, published by UNICOM. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/unicom-ig/ and changes regularly. See the Directory of published versions
Official URL: http://unicom-project.eu/fhir/StructureDefinition/MedicationAsMedicinalProduct | Version: 0.1.0 | |||
Draft as of 2024-10-11 | Computable Name: MedicationAsMedicinalProduct |
Medication for clinical use cases (Medication resource), may be branded or generic
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..* | string | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-name | |
classification | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-classification | |
administrableDoseForm | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/administrable-doseform Binding: EDQM Pharmaceutical Dose Form (preferred) | |
Slices for identifier | 0..* | Identifier | Identifier for the medicinal product, its generic representation, or packaged product: MPID, PCID, national ID, or other Slice: Unordered, Open by pattern:system | |
identifier:mpid | 0..1 | Identifier | MPID | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ema.europa.eu/fhir/mpId | |
identifier:pcid | 0..1 | Identifier | PCID | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ema.europa.eu/fhir/pcId | |
code | 0..1 | CodeableConcept | A terminology-based code for the product | |
marketingAuthorizationHolder | 0..1 | Reference(Organization) | Marketing Authorisation Holder | |
doseForm | 1..1 | CodeableConcept | Dose form. On this level, it would typically be the same as authorised dose form | |
totalVolume | 0..0 | |||
ingredient | 1..* | BackboneElement | Medication item description (i.e. manufactured item) | |
item | 1..1 | CodeableReference(Medication as manufactured item) {c} | Manufactured Item description | |
Slices for strength[x] | 0..1 | Ratio, CodeableConcept, Quantity | Quantity of ingredient present Slice: Unordered, Open by type:$this | |
strength[x]:strengthQuantity | 0..1 | Quantity | Number of manufactured items | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..* | string | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-name | |
classification | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-classification | |
administrableDoseForm | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/administrable-doseform Binding: EDQM Pharmaceutical Dose Form (preferred) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | Identifier for the medicinal product, its generic representation, or packaged product: MPID, PCID, national ID, or other Slice: Unordered, Open by pattern:system |
identifier:mpid | Σ | 0..1 | Identifier | MPID |
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: http://ema.europa.eu/fhir/mpId |
identifier:pcid | Σ | 0..1 | Identifier | PCID |
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: http://ema.europa.eu/fhir/pcId |
code | Σ | 0..1 | CodeableConcept | A terminology-based code for the product Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. |
marketingAuthorizationHolder | Σ | 0..1 | Reference(Organization) | Marketing Authorisation Holder |
doseForm | 1..1 | CodeableConcept | Dose form. On this level, it would typically be the same as authorised dose form Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |
ingredient | 1..* | BackboneElement | Medication item description (i.e. manufactured item) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item | 1..1 | CodeableReference(Medication as manufactured item) {c} | Manufactured Item description Binding: SNOMEDCTMedicationCodes (example) | |
Slices for strength[x] | 0..1 | Quantity of ingredient present Slice: Unordered, Open by type:$this Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | ||
strengthRatio | Ratio | |||
strengthCodeableConcept | CodeableConcept | |||
strengthQuantity | Quantity | |||
strength[x]:strengthQuantity | 0..1 | Quantity | Number of manufactured items Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.identifier:mpid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier:pcid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.status | required | MedicationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard | |
Medication.doseForm | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.ingredient.strength[x] | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard | |
Medication.ingredient.strength[x]:strengthQuantity | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
name | 0..* | string | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-name | |||||
classification | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-classification | |||||
administrableDoseForm | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/administrable-doseform Binding: EDQM Pharmaceutical Dose Form (preferred) | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | Identifier for the medicinal product, its generic representation, or packaged product: MPID, PCID, national ID, or other Slice: Unordered, Open by pattern:system | ||||
identifier:mpid | Σ | 0..1 | Identifier | MPID | ||||
id | 0..1 | id | 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: IdentifierTypeCodes (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: http://ema.europa.eu/fhir/mpId | ||||
value | ΣC | 0..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:pcid | Σ | 0..1 | Identifier | PCID | ||||
id | 0..1 | id | 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: IdentifierTypeCodes (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: http://ema.europa.eu/fhir/pcId | ||||
value | ΣC | 0..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 | Σ | 0..1 | CodeableConcept | A terminology-based code for the product Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. | ||||
marketingAuthorizationHolder | Σ | 0..1 | Reference(Organization) | Marketing Authorisation Holder | ||||
doseForm | 1..1 | CodeableConcept | Dose form. On this level, it would typically be the same as authorised dose form Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
ingredient | 1..* | BackboneElement | Medication item description (i.e. manufactured item) | |||||
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 | 1..1 | CodeableReference(Medication as manufactured item) {c} | Manufactured Item description Binding: SNOMEDCTMedicationCodes (example) | |||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||
Slices for strength[x] | 0..1 | Quantity of ingredient present Slice: Unordered, Open by type:$this Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | ||||||
strengthRatio | Ratio | |||||||
strengthCodeableConcept | CodeableConcept | |||||||
strengthQuantity | Quantity | |||||||
strength[x]:strengthQuantity | 0..1 | Quantity | Number of manufactured items Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | |||||
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 | |||||
definition | 0..1 | Reference(MedicationKnowledge) | Knowledge about this medication | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Medication.identifier:mpid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier:mpid.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Medication.identifier:pcid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier:pcid.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.status | required | MedicationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard | |
Medication.doseForm | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.ingredient.strength[x] | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard | |
Medication.ingredient.strength[x]:strengthQuantity | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 2 elements(2 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..* | string | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-name | |
classification | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-classification | |
administrableDoseForm | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/administrable-doseform Binding: EDQM Pharmaceutical Dose Form (preferred) | |
Slices for identifier | 0..* | Identifier | Identifier for the medicinal product, its generic representation, or packaged product: MPID, PCID, national ID, or other Slice: Unordered, Open by pattern:system | |
identifier:mpid | 0..1 | Identifier | MPID | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ema.europa.eu/fhir/mpId | |
identifier:pcid | 0..1 | Identifier | PCID | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ema.europa.eu/fhir/pcId | |
code | 0..1 | CodeableConcept | A terminology-based code for the product | |
marketingAuthorizationHolder | 0..1 | Reference(Organization) | Marketing Authorisation Holder | |
doseForm | 1..1 | CodeableConcept | Dose form. On this level, it would typically be the same as authorised dose form | |
totalVolume | 0..0 | |||
ingredient | 1..* | BackboneElement | Medication item description (i.e. manufactured item) | |
item | 1..1 | CodeableReference(Medication as manufactured item) {c} | Manufactured Item description | |
Slices for strength[x] | 0..1 | Ratio, CodeableConcept, Quantity | Quantity of ingredient present Slice: Unordered, Open by type:$this | |
strength[x]:strengthQuantity | 0..1 | Quantity | Number of manufactured items | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..* | string | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-name | |
classification | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-classification | |
administrableDoseForm | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/administrable-doseform Binding: EDQM Pharmaceutical Dose Form (preferred) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | Identifier for the medicinal product, its generic representation, or packaged product: MPID, PCID, national ID, or other Slice: Unordered, Open by pattern:system |
identifier:mpid | Σ | 0..1 | Identifier | MPID |
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: http://ema.europa.eu/fhir/mpId |
identifier:pcid | Σ | 0..1 | Identifier | PCID |
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: http://ema.europa.eu/fhir/pcId |
code | Σ | 0..1 | CodeableConcept | A terminology-based code for the product Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. |
marketingAuthorizationHolder | Σ | 0..1 | Reference(Organization) | Marketing Authorisation Holder |
doseForm | 1..1 | CodeableConcept | Dose form. On this level, it would typically be the same as authorised dose form Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |
ingredient | 1..* | BackboneElement | Medication item description (i.e. manufactured item) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item | 1..1 | CodeableReference(Medication as manufactured item) {c} | Manufactured Item description Binding: SNOMEDCTMedicationCodes (example) | |
Slices for strength[x] | 0..1 | Quantity of ingredient present Slice: Unordered, Open by type:$this Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | ||
strengthRatio | Ratio | |||
strengthCodeableConcept | CodeableConcept | |||
strengthQuantity | Quantity | |||
strength[x]:strengthQuantity | 0..1 | Quantity | Number of manufactured items Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.identifier:mpid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier:pcid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.status | required | MedicationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard | |
Medication.doseForm | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.ingredient.strength[x] | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard | |
Medication.ingredient.strength[x]:strengthQuantity | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
name | 0..* | string | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-name | |||||
classification | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/medicinal-product-classification | |||||
administrableDoseForm | 0..* | CodeableConcept | Extension URL: http://unicom-project.eu/fhir/StructureDefinition/administrable-doseform Binding: EDQM Pharmaceutical Dose Form (preferred) | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | Identifier for the medicinal product, its generic representation, or packaged product: MPID, PCID, national ID, or other Slice: Unordered, Open by pattern:system | ||||
identifier:mpid | Σ | 0..1 | Identifier | MPID | ||||
id | 0..1 | id | 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: IdentifierTypeCodes (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: http://ema.europa.eu/fhir/mpId | ||||
value | ΣC | 0..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:pcid | Σ | 0..1 | Identifier | PCID | ||||
id | 0..1 | id | 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: IdentifierTypeCodes (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: http://ema.europa.eu/fhir/pcId | ||||
value | ΣC | 0..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 | Σ | 0..1 | CodeableConcept | A terminology-based code for the product Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. | ||||
marketingAuthorizationHolder | Σ | 0..1 | Reference(Organization) | Marketing Authorisation Holder | ||||
doseForm | 1..1 | CodeableConcept | Dose form. On this level, it would typically be the same as authorised dose form Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
ingredient | 1..* | BackboneElement | Medication item description (i.e. manufactured item) | |||||
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 | 1..1 | CodeableReference(Medication as manufactured item) {c} | Manufactured Item description Binding: SNOMEDCTMedicationCodes (example) | |||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||
Slices for strength[x] | 0..1 | Quantity of ingredient present Slice: Unordered, Open by type:$this Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | ||||||
strengthRatio | Ratio | |||||||
strengthCodeableConcept | CodeableConcept | |||||||
strengthQuantity | Quantity | |||||||
strength[x]:strengthQuantity | 0..1 | Quantity | Number of manufactured items Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | |||||
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 | |||||
definition | 0..1 | Reference(MedicationKnowledge) | Knowledge about this medication | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Medication.identifier:mpid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier:mpid.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Medication.identifier:pcid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier:pcid.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.status | required | MedicationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard | |
Medication.doseForm | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.ingredient.strength[x] | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard | |
Medication.ingredient.strength[x]:strengthQuantity | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 2 elements(2 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron