Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Medication_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Medication Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Medication_R4

This cross-version profile allows R5 Medication content to be represented via FHIR R4 Medication resources.

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(4.0.1) 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
Constraints: ext-1
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR R4(0.1.0) | MedicationKnowledge) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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 Medication.implicitRules, Medication.extension, Medication.extension:definition, Medication.modifierExtension, Medication.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Medication.extension, Medication.extension:definition, Medication.modifierExtension 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(4.0.1) Definition of a Medication
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR R4(0.1.0) | MedicationKnowledge) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
... status
​.... Slices for modifierExtension 0..* Slice: Unordered, Open by value:url
​..... modifierExtension:status 0..1 code R5: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... amount
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:totalVolume 0..1 Quantity R5: When the specified product code does not infer a package size, this is the specific amount of drug in the product additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... strength
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:strength 0..1 CodeableConcept, Quantity R5: strength additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength
Binding: R5MedicationIngredientstrengthForR4 (0.1.0) (preferred): A coded concpet defining the strength of an ingredient.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication(4.0.1) 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
Constraints: ext-1
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR R4(0.1.0) | MedicationKnowledge) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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.
... amount Σ 0..1 Ratio Amount of drug in package
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:totalVolume 0..1 Quantity R5: When the specified product code does not infer a package size, this is the specific amount of drug in the product additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
Constraints: ext-1
.... numerator Σ 0..1 Quantity Numerator value
.... denominator Σ 0..1 Quantity Denominator value
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:strength 0..1 CodeableConcept, Quantity R5: strength additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength
Binding: R5MedicationIngredientstrengthForR4 (0.1.0) (preferred): A coded concpet defining the strength of an ingredient.
Constraints: ext-1
..... numerator Σ 0..1 Quantity Numerator value
..... denominator Σ 0..1 Quantity Denominator value
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 tx.fhir.org
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.

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 Medication.meta, Medication.implicitRules, Medication.language, Medication.text, Medication.extension, Medication.extension:definition, Medication.modifierExtension, Medication.identifier, Medication.code, Medication.status, Medication.status.extension, Medication.manufacturer, Medication.form, Medication.amount, Medication.amount.extension, Medication.amount.extension:totalVolume, Medication.amount.numerator, Medication.amount.denominator, Medication.ingredient, Medication.ingredient.extension, Medication.ingredient.modifierExtension, Medication.ingredient.item[x], Medication.ingredient.isActive, Medication.ingredient.strength, Medication.ingredient.strength.extension, Medication.ingredient.strength.extension:strength, Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator, Medication.batch, Medication.batch.extension, Medication.batch.modifierExtension, Medication.batch.lotNumber, Medication.batch.expirationDate All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Medication.extension, Medication.extension:definition, Medication.modifierExtension, Medication.status.extension, Medication.amount.extension, Medication.amount.extension:totalVolume, Medication.ingredient.extension, Medication.ingredient.modifierExtension, Medication.ingredient.strength.extension, Medication.ingredient.strength.extension:strength, Medication.batch.extension, Medication.batch.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication(4.0.1) 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
Constraints: ext-1
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR R4(0.1.0) | MedicationKnowledge) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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 Medication.implicitRules, Medication.extension, Medication.extension:definition, Medication.modifierExtension, Medication.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Medication.extension, Medication.extension:definition, Medication.modifierExtension 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(4.0.1) Definition of a Medication
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR R4(0.1.0) | MedicationKnowledge) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
... status
​.... Slices for modifierExtension 0..* Slice: Unordered, Open by value:url
​..... modifierExtension:status 0..1 code R5: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... amount
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:totalVolume 0..1 Quantity R5: When the specified product code does not infer a package size, this is the specific amount of drug in the product additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... strength
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:strength 0..1 CodeableConcept, Quantity R5: strength additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength
Binding: R5MedicationIngredientstrengthForR4 (0.1.0) (preferred): A coded concpet defining the strength of an ingredient.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication(4.0.1) 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
Constraints: ext-1
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR R4(0.1.0) | MedicationKnowledge) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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.
... amount Σ 0..1 Ratio Amount of drug in package
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:totalVolume 0..1 Quantity R5: When the specified product code does not infer a package size, this is the specific amount of drug in the product additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
Constraints: ext-1
.... numerator Σ 0..1 Quantity Numerator value
.... denominator Σ 0..1 Quantity Denominator value
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:strength 0..1 CodeableConcept, Quantity R5: strength additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength
Binding: R5MedicationIngredientstrengthForR4 (0.1.0) (preferred): A coded concpet defining the strength of an ingredient.
Constraints: ext-1
..... numerator Σ 0..1 Quantity Numerator value
..... denominator Σ 0..1 Quantity Denominator value
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 tx.fhir.org
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.

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 Medication.meta, Medication.implicitRules, Medication.language, Medication.text, Medication.extension, Medication.extension:definition, Medication.modifierExtension, Medication.identifier, Medication.code, Medication.status, Medication.status.extension, Medication.manufacturer, Medication.form, Medication.amount, Medication.amount.extension, Medication.amount.extension:totalVolume, Medication.amount.numerator, Medication.amount.denominator, Medication.ingredient, Medication.ingredient.extension, Medication.ingredient.modifierExtension, Medication.ingredient.item[x], Medication.ingredient.isActive, Medication.ingredient.strength, Medication.ingredient.strength.extension, Medication.ingredient.strength.extension:strength, Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator, Medication.batch, Medication.batch.extension, Medication.batch.modifierExtension, Medication.batch.lotNumber, Medication.batch.expirationDate All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Medication.extension, Medication.extension:definition, Medication.modifierExtension, Medication.status.extension, Medication.amount.extension, Medication.amount.extension:totalVolume, Medication.ingredient.extension, Medication.ingredient.modifierExtension, Medication.ingredient.strength.extension, Medication.ingredient.strength.extension:strength, Medication.batch.extension, Medication.batch.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron