Medication
Description
A medication is a drug used to diagnose, cure, treat, or prevent disease. Medication is not loaded as a separate category in Patient Finder. It is used by two other categories: medication administration and medication request.
Since Patient Finder only has a place for one ingredient, we pick the first one sent.
The code will be used to describe the medication. If the code is of system http://www.whocc.no/atc
we will display it in the ATC code field.
Instances
An example of a Medication resource can be found here: Medication Example 1
An example of a MedicationAdministration resource can be found here: Medication Administration Example 1
An example of a MedicationRequest resource can be found here: Medication Request Example 1
Profile
PatientFinderMedication (Medication) | I | Medication | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
code | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
status | Σ ?! | 0..1 | codeBinding |
manufacturer | Σ | 0..1 | Reference(Organization) |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
amount | Σ | 0..1 | Ratio |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | 1..1 | ||
(All Slices) | |||
itemReference | Reference(Substance | Medication) | ||
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
isActive | 0..1 | boolean | |
strength | S | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ | 0..1 | Quantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | Σ I | 0..1 | uri |
code | Σ | 0..1 | code |
denominator | Σ | 0..1 | Quantity |
batch | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="pf-medication" /> <url value="https://fhir.iqvia.com/patientfinder/StructureDefinition/pf-medication" /> <name value="PatientFinderMedication" /> <title value="Medication" /> <status value="draft" /> <description value="Medication is not loaded as a separate category in Patient Finder. It is loaded as a part of medication administration or medication request." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <name value="FHIR to Patient Finder Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" /> <derivation value="constraint" /> <differential> <element id="Medication.code"> <path value="Medication.code" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding.code"> <path value="Medication.code.coding.code" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication administration description" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication request description" /> </mapping> </element> <element id="Medication.form"> <path value="Medication.form" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding.code"> <path value="Medication.form.coding.code" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication administration pharmaceutical form" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication request pharmaceutical form" /> </mapping> </element> <element id="Medication.ingredient"> <path value="Medication.ingredient" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding.code"> <path value="Medication.ingredient.item[x].coding.code" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication administration ingredient" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication request ingredient" /> </mapping> </element> <element id="Medication.ingredient.strength"> <path value="Medication.ingredient.strength" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator"> <path value="Medication.ingredient.strength.numerator" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.value"> <path value="Medication.ingredient.strength.numerator.value" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication administration strength value" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication request strength value" /> </mapping> </element> <element id="Medication.ingredient.strength.numerator.unit"> <path value="Medication.ingredient.strength.numerator.unit" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication administration strength unit" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="medication request strength unit" /> </mapping> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "pf-medication", "url": "https://fhir.iqvia.com/patientfinder/StructureDefinition/pf-medication", "name": "PatientFinderMedication", "title": "Medication", "status": "draft", "description": "Medication is not loaded as a separate category in Patient Finder. It is loaded as a part of medication administration or medication request.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "fhir-patient-finder-mapping", "name": "FHIR to Patient Finder Mapping" } ], "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication.code", "path": "Medication.code", "mustSupport": true }, { "id": "Medication.code.coding.code", "path": "Medication.code.coding.code", "mustSupport": true }, { "id": "Medication.code.coding.display", "path": "Medication.code.coding.display", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "medication administration description" }, { "identity": "fhir-patient-finder-mapping", "map": "medication request description" } ] }, { "id": "Medication.form", "path": "Medication.form", "mustSupport": true }, { "id": "Medication.form.coding.code", "path": "Medication.form.coding.code", "mustSupport": true }, { "id": "Medication.form.coding.display", "path": "Medication.form.coding.display", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "medication administration pharmaceutical form" }, { "identity": "fhir-patient-finder-mapping", "map": "medication request pharmaceutical form" } ] }, { "id": "Medication.ingredient", "path": "Medication.ingredient", "mustSupport": true }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding.code", "path": "Medication.ingredient.item[x].coding.code", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "medication administration ingredient" }, { "identity": "fhir-patient-finder-mapping", "map": "medication request ingredient" } ] }, { "id": "Medication.ingredient.strength", "path": "Medication.ingredient.strength", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator", "path": "Medication.ingredient.strength.numerator", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.value", "path": "Medication.ingredient.strength.numerator.value", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "medication administration strength value" }, { "identity": "fhir-patient-finder-mapping", "map": "medication request strength value" } ] }, { "id": "Medication.ingredient.strength.numerator.unit", "path": "Medication.ingredient.strength.numerator.unit", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "medication administration strength unit" }, { "identity": "fhir-patient-finder-mapping", "map": "medication request strength unit" } ] } ] } }
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Medication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Medication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Medication.code.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Medication.code.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Medication.code.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Medication.code.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Medication.code.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Medication.form.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Medication.form.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Medication.form.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Medication.form.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Medication.form.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Summary | True |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Medication.ingredient.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...1 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Invariants |
|
Mappings |
|
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Medication.batch.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Attribute list
Attribute | Description | Example |
---|---|---|
identifier.value | The ID of the Medication | 'medication-example-1' |
code.coding.code | The code that identifies the medication | SNOMED CT: '430127000' |
code.coding.display | The description of the identifies the medication | 'Oral Form Oxycodone (product)' |
form.coding.display | Describes the form of the item. | Powder', 'tablets', 'capsule' |
ingredient.itemCodeableConcept.coding.code | The code for the active substance in the medicine | SNOMED CT: '#55452001' |
ingredient.itemCodeableConcept.coding.display | The description of the active substance in the medicine | 'Oxycodone (substance)' |
ingredient.strength.numerator.value | The quantity of the ingredient present | '5' |
ingredient.strength.numerator.unit | The unit of the quantity of the ingredient present | 'mg' |