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

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

Resource Profile: Profile_R5_Medication_R3

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_R3

This cross-version profile allows R5 Medication content to be represented via FHIR STU3 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 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:identifier 0..* Identifier R5: Business identifier for this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.identifier
.... 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 (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... extension:batch 0..1 (Complex) R5: Details about packaged medications (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.batch
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR STU3(0.1.0) | Basic) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-1 error Medication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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:identifier 0..* Identifier R5: Business identifier for this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.identifier
.... 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 (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... extension:batch 0..1 (Complex) R5: Details about packaged medications (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.batch
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR STU3(0.1.0) | Basic) 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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-status]] R5: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
... manufacturer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:marketingAuthorizationHolder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Organization that has authorization to market medication additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... amount
..... 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: R5MedicationIngredientstrengthForR3 (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 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:identifier 0..* Identifier R5: Business identifier for this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.identifier
.... 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 (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... extension:batch 0..1 (Complex) R5: Details about packaged medications (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.batch
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR STU3(0.1.0) | Basic) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMED CT Medication Codes (example): A coded concept that defines the type of a medication
... status Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatus (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
.... value 0..1 code Primitive value for code
... isBrand Σ 0..1 boolean True if a brand
... isOverTheCounter Σ 0..1 boolean True if medication does not require a prescription
... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:marketingAuthorizationHolder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Organization that has authorization to market medication additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMED CT Form Codes (example): A coded concept defining the form of a medication
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... item[x] 1..1 The product contained
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... amount 0..1 Ratio Quantity of ingredient present
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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: R5MedicationIngredientstrengthForR3 (0.1.0) (preferred): A coded concpet defining the strength of an ingredient.
..... numerator Σ 0..1 Quantity Numerator value
..... denominator Σ 0..1 Quantity Denominator value
... package 0..1 BackboneElement Details about packaged medications
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... container 0..1 CodeableConcept E.g. box, vial, blister-pack
Binding: MedicationContainer (example): A coded concept defining the kind of container a medication package is packaged in
.... content 0..* BackboneElement What is in the package
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... item[x] 1..1 The item in the package
...... itemCodeableConcept CodeableConcept
...... itemReference Reference(Medication)
..... amount 0..1 SimpleQuantity Quantity present in the package
.... batch 0..* BackboneElement Identifies a single production run
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... lotNumber 0..1 string Identifier assigned to batch
..... expirationDate 0..1 dateTime When batch will expire
... image 0..* Attachment Picture of the medication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
Medication.code Base example SNOMED CT Medication Codes 📍3.0.2 FHIR Std.
Medication.status Base required MedicationStatus 📍3.0.2 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍3.0.2 FHIR Std.
Medication.package.container Base example MedicationContainer 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Medication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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

Extensions

This structure refers to these extensions:

Maturity: 0

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:identifier 0..* Identifier R5: Business identifier for this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.identifier
.... 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 (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... extension:batch 0..1 (Complex) R5: Details about packaged medications (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.batch
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR STU3(0.1.0) | Basic) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-1 error Medication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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:identifier 0..* Identifier R5: Business identifier for this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.identifier
.... 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 (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... extension:batch 0..1 (Complex) R5: Details about packaged medications (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.batch
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR STU3(0.1.0) | Basic) 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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-status]] R5: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
... manufacturer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:marketingAuthorizationHolder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Organization that has authorization to market medication additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... amount
..... 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: R5MedicationIngredientstrengthForR3 (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 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:identifier 0..* Identifier R5: Business identifier for this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.identifier
.... 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 (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.totalVolume
.... extension:batch 0..1 (Complex) R5: Details about packaged medications (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.batch
.... extension:definition 0..1 Reference(Cross-version Profile for R5.MedicationKnowledge for use in FHIR STU3(0.1.0) | Basic) R5: Knowledge about this medication (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.definition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMED CT Medication Codes (example): A coded concept that defines the type of a medication
... status Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatus (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
.... value 0..1 code Primitive value for code
... isBrand Σ 0..1 boolean True if a brand
... isOverTheCounter Σ 0..1 boolean True if medication does not require a prescription
... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:marketingAuthorizationHolder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Organization that has authorization to market medication additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMED CT Form Codes (example): A coded concept defining the form of a medication
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... item[x] 1..1 The product contained
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... amount 0..1 Ratio Quantity of ingredient present
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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: R5MedicationIngredientstrengthForR3 (0.1.0) (preferred): A coded concpet defining the strength of an ingredient.
..... numerator Σ 0..1 Quantity Numerator value
..... denominator Σ 0..1 Quantity Denominator value
... package 0..1 BackboneElement Details about packaged medications
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... container 0..1 CodeableConcept E.g. box, vial, blister-pack
Binding: MedicationContainer (example): A coded concept defining the kind of container a medication package is packaged in
.... content 0..* BackboneElement What is in the package
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... item[x] 1..1 The item in the package
...... itemCodeableConcept CodeableConcept
...... itemReference Reference(Medication)
..... amount 0..1 SimpleQuantity Quantity present in the package
.... batch 0..* BackboneElement Identifies a single production run
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... lotNumber 0..1 string Identifier assigned to batch
..... expirationDate 0..1 dateTime When batch will expire
... image 0..* Attachment Picture of the medication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
Medication.code Base example SNOMED CT Medication Codes 📍3.0.2 FHIR Std.
Medication.status Base required MedicationStatus 📍3.0.2 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍3.0.2 FHIR Std.
Medication.package.container Base example MedicationContainer 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Medication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron