{
"description": "This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile.",
"_filename": "StructureDefinition-medication-uv-ips.json",
"package_name": "hl7.fhir.uv.ips",
"date": "2018-02-20T22:03:08.307+01:00",
"derivation": "constraint",
"meta": {
"lastUpdated": "2018-03-07T19:02:56.499+01:00"
},
"publisher": "HL7 International",
"fhirVersion": "3.5.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "This profile constrains the representation of a medication, in the context of the international patient summary as specified by the IPS project of HL7 International.",
"name": "Medication-uv-ips",
"mapping": [ {
"uri": "http://ncpdp.org/SCRIPT10_6",
"name": "Mapping to NCPDP SCRIPT 10.6",
"identity": "script10.6"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Medication",
"experimental": "true",
"resourceType": "StructureDefinition",
"title": "Medication",
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "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",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource",
"severity": "error",
"expression": "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()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a guman readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.div.exists()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
} ],
"path": "Medication",
"min": 0,
"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.",
"isModifier": false,
"short": "Definition of a Medication",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed",
"identity": "script10.6"
}, {
"map": "ManufacturedProduct[classCode=ADMM]",
"identity": "rim"
} ],
"max": "*",
"id": "Medication",
"comment": "IPS Medication",
"base": {
"max": "*",
"min": 0,
"path": "Medication"
},
"isSummary": false
}, {
"path": "Medication.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Medication.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Medication.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Medication.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Medication.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.implicitRules",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"path": "Medication.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "Medication.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"path": "Medication.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Medication.text",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Medication.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Medication.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"path": "Medication.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"path": "Medication.modifierExtension",
"min": 0,
"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code",
"min": 0,
"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.",
"isModifier": false,
"short": "Codes that identify this medication, sliced to support IDMP",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationFormalRepresentation"
} ],
"description": "A coded concept that defines the type of a medication."
},
"max": "1",
"id": "Medication.code",
"condition": [ "ele-1" ],
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Medication.code"
}
}, {
"path": "Medication.code.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A representation of the vaccine in a code system. The representation can be granular or may also be a class or category.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "openAtEnd",
"description": "This slicing on the coding element of code is open, with discriminator based on the value set binding. It carries one slice for each of the IDMP identifiers, or any equivalent representation of these concepts (e.g. medical product); plus one slice for the ATC classification. \r\nOther representations of the medication (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jursisdiction code systems, or any classification) use extra slices, since the slicing is open. \r\n A special slice is defined to carry the absent or unknown property.\r\nThe value sets used by the IDMP slices are provisional and include few concepts for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.",
"discriminator": [ {
"path": "binding.valueSet",
"type": "value"
} ]
},
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"max": "*",
"id": "Medication.code.coding",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "IDMP PhPID Level 1 (Implies substances) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as s and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.",
"isModifier": false,
"short": "Pharmaceutical Product Identifier, Level 1",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"sliceName": "pharmaceuticalProduct-L1",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl1-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl1"
} ]
},
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L1",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "Name of the Pharmaceutical Product (Substances). Example: Amoxicillin and Clavulanate Potassium",
"isModifier": false,
"short": "Name of the Pharmaceutical Product [Substance(s)]",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:pharmaceuticalProduct-L1.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "IDMP PhPID Level 2 (Implies substances and strength) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as substances and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.",
"isModifier": false,
"short": "Pharmaceutical Product Identifier, Level 2",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"sliceName": "pharmaceuticalProduct-L2",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl2-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl2"
} ]
},
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L2",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "Name of the Pharmaceutical Product [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg.",
"isModifier": false,
"short": "Name of the Pharmaceutical Product [Substance(s) + Strength + reference strength]",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:pharmaceuticalProduct-L2.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "IDMP PhPID Level 3 (Implies substances and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as substances and administrable dose form, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.",
"isModifier": false,
"short": "Pharmaceutical Product Identifier, Level 3",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"sliceName": "pharmaceuticalProduct-L3",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl3-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl3"
} ]
},
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L3",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "Name of the Pharmaceutical Product [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet.",
"isModifier": false,
"short": "Name of the Pharmaceutical Product [Substance(s) + administrable dose form]",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:pharmaceuticalProduct-L3.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "IDMP PhPID Level 4 (Implies substances, strength, and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as substances and administrable dose form, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.",
"isModifier": false,
"short": "Pharmaceutical Product Identifier, Level 4",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"sliceName": "pharmaceuticalProduct-L4",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl4-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl4"
} ]
},
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L4",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "Name of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet.",
"isModifier": false,
"short": "Name of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:pharmaceuticalProduct-L4.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier.\r\n\r\nIDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorisation numbers allocated by a regulator.\r\n\r\nMPID implies one (set of) PhPID.\r\nThe MPID shall use a common segment pattern related to a Medicinal Product, which\r\nwhen each segment is valued shall define a specific MPID concept. The pattern is:\r\n a) Country code segment (ISO 3166-1 alpha-2 code elements);\r\n b) Marketing Authorization Holder (Organization Identifier) code segment;\r\n c) Medicinal Product code segment (Unique Medicinal Product Identifier).\r\n Any change of the values related to these three code segments shall result in the\r\nassignment of a new MPID.\r",
"isModifier": false,
"short": "Medicinal Product Identifier",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"mustSupport": true,
"sliceName": "medicinalProduct",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/mpid-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MPID"
} ]
},
"max": "*",
"id": "Medication.code.coding:medicinalProduct",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:medicinalProduct.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "Name of the Medicinal Product, in some cases it corresponds to the brand name.",
"isModifier": false,
"short": "Name of the Medicinal Product",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:medicinalProduct.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:medicinalProduct.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:medicinalProduct.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:medicinalProduct.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "IDMP Packaged Medicinal Product Identifier or any equivalent Packaged Medicinal Product Identifier.\r\n\r\nUniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package;\r\n\r\nThe PCID shall use a common segment pattern related to a package of a Medicinal\r\nProduct, which when each segment is valued, shall define a specific PCID concept. The\r\npattern is:\r\n a) MPID for the Medicinal Product\r\n b) package description code segment, which refers to a unique identifier for each\r\npackage.",
"isModifier": false,
"short": "Packaged Medicinal Product Identifier",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"mustSupport": true,
"sliceName": "packagedProduct",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/pcid-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PCID"
} ]
},
"max": "*",
"id": "Medication.code.coding:packagedProduct",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:packagedProduct.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "Name of the Packaged Medicinal Product.",
"isModifier": false,
"short": "Name of the Packaged Medicinal Product",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:packagedProduct.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:packagedProduct.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:packagedProduct.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:packagedProduct.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "WHO ATC classification",
"isModifier": false,
"short": "WHO ATC classification",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"sliceName": "atcClass",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "WHO ATC"
} ]
},
"max": "1",
"id": "Medication.code.coding:atcClass",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
}
}, {
"path": "Medication.code.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:atcClass.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.code.coding:atcClass.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.code.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"fixedUri": "http://www.whocc.no/atc",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.code.coding:atcClass.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.code.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.code.coding:atcClass.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.code.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.code.coding:atcClass.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"isModifier": false,
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.coding:atcClass.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.code.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:atcClass.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.code.coding:atcClass.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.code.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.code.coding:atcClass.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.code.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.code.coding:atcClass.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.code.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.code.coding:atcClass.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Medication.code.text",
"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.",
"min": 0,
"definition": "This element is supposed to be valorized with the complete Medicinal Product Name as approved by the Medicines Regulatory Agency in a jurisdiction.\r\nThe name may be applicable in one or more country/language combinations.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.code.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Medication.status",
"min": 0,
"definition": "A code to indicate if the medication is in active use.",
"isModifier": true,
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatus"
} ],
"description": "A coded concept defining if the medication is in active use."
},
"max": "0",
"id": "Medication.status",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.status"
},
"isModifierReason": "This element changes the interpretation of all descriptive attributes.",
"isSummary": true
}, {
"path": "Medication.manufacturer",
"min": 0,
"definition": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.",
"isModifier": false,
"short": "Manufacturer of the item",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name",
"identity": "v2"
}, {
"map": ".player.scopingRole[typeCode=MANU].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "0",
"id": "Medication.manufacturer",
"base": {
"max": "1",
"min": 0,
"path": "Medication.manufacturer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.form",
"min": 0,
"definition": "Describes the form of the item. Powder; tablets; capsule.\r\n\r\nAdministrable Pharmaceutical Dose Form. \r\nThis code represents the form of the medication (e.g. tablet, capsule, liquid)\r\n\r\nSince the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration.\r\n\r\nIt is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT.",
"isModifier": false,
"short": "powder | tablets | capsule +",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationForm"
} ]
},
"max": "1",
"id": "Medication.form",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.form"
}
}, {
"path": "Medication.form.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.form.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.form.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.form.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.form.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"max": "*",
"id": "Medication.form.coding",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Medication.form.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.form.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.form.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.form.coding.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.form.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform",
"description": "EDQM Standard Terms"
},
"max": "1",
"id": "Medication.form.coding.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.form.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.form.coding.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.form.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.form.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.form.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"isModifier": false,
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.form.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.form.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.form.coding.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.form.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.form.coding.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.form.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.form.coding.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.form.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.form.coding.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.form.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.form.coding.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Medication.form.text",
"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.",
"min": 0,
"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.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.form.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Medication.amount",
"min": 0,
"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.).",
"isModifier": false,
"short": "Amount of drug in package",
"mapping": [ {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "Medication.amount",
"base": {
"max": "1",
"min": 0,
"path": "Medication.amount"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient",
"min": 0,
"definition": "Identifies a particular constituent of interest in the product.",
"isModifier": false,
"short": "Active or inactive ingredient",
"mapping": [ {
"map": ".scopesRole[typeCode=INGR]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "Medication.ingredient",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Medication.ingredient"
},
"isSummary": false
}, {
"path": "Medication.ingredient.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.ingredient.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.ingredient.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.ingredient.modifierExtension",
"min": 0,
"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.ingredient.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient.itemCodeableConcept",
"requirements": "The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).",
"min": 1,
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"isModifier": false,
"short": "Concept - reference to a terminology or just text",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"sliceName": "itemCodeableConcept",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips",
"description": "SNOMED CT drug substances"
},
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept",
"condition": [ "ele-1" ],
"comment": "The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances. \r\nThe Global Ingredient Archival System (GInAS) will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard.\r\nThose identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances.\r\nThis choice will be revised based on the availability and the maturity of GInAS.",
"base": {
"max": "1",
"min": 1,
"path": "Medication.ingredient.item[x]"
}
}, {
"path": "Medication.ingredient.itemCodeableConcept.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.ingredient.itemCodeableConcept.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"mustSupport": true,
"max": "*",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips"
},
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.system",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.version",
"min": 0,
"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.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"isModifier": false,
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.display.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.display.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Medication.ingredient.itemCodeableConcept.coding.display.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Language Translation (Localization)",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation",
"max": "*",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.display.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Medication.ingredient.itemCodeableConcept.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemCodeableConcept.text",
"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.",
"min": 0,
"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.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Medication.ingredient.isActive",
"requirements": "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).",
"min": 0,
"definition": "Indication of whether this ingredient affects the therapeutic action of the drug.",
"isModifier": false,
"short": "Active ingredient indicator",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Medication.ingredient.isActive",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.isActive"
},
"isSummary": false
}, {
"path": "Medication.ingredient.amount",
"min": 0,
"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.",
"isModifier": false,
"short": "Quantity of ingredient present",
"mapping": [ {
"map": "//element(*,DrugCodedType)/Strength",
"identity": "script10.6"
}, {
"map": "RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units",
"identity": "v2"
}, {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Ratio",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/ratio-uv-ips" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Medication.ingredient.amount",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.amount"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.batch",
"min": 0,
"definition": "Information that only applies to packages (not products).",
"isModifier": false,
"short": "Details about packaged medications",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": ".player[classCode=CONT]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Medication.batch",
"base": {
"max": "1",
"min": 0,
"path": "Medication.batch"
},
"isSummary": false
}, {
"path": "Medication.batch.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.batch.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Medication.batch.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.batch.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Medication.batch.modifierExtension",
"min": 0,
"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.batch.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Medication.batch.lotNumber",
"min": 0,
"definition": "The assigned lot number of a batch of the specified product.",
"isModifier": false,
"short": "Identifier assigned to batch",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.batch.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "Medication.batch.lotNumber"
},
"isSummary": false
}, {
"path": "Medication.batch.expirationDate",
"min": 0,
"definition": "When this specific batch of product will expire.",
"isModifier": false,
"short": "When batch will expire",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date",
"identity": "v2"
}, {
"map": "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Medication.batch.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "Medication.batch.expirationDate"
},
"isSummary": false
}, {
"path": "Medication.batch.serialNumber",
"min": 0,
"definition": "An identifier assigned to a drug at the point of manufacturing and repackaging (at the package or pallet level), sufficient to facilitate the identification, validation, authentication, and tracking and tracking of drugs.",
"isModifier": false,
"short": "Identifier assigned to a drug at the time of manufacture",
"mapping": [ {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.batch.serialNumber",
"base": {
"max": "1",
"min": 0,
"path": "Medication.batch.serialNumber"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "f42258f5-e897-429f-a8dc-84e6210d1eb8",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/ips/StructureDefinition/medication-uv-ips",
"version": "0.2.0",
"differential": {
"element": [ {
"id": "Medication",
"path": "Medication",
"comment": "IPS Medication"
}, {
"id": "Medication.code",
"max": "1",
"path": "Medication.code",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"short": "Codes that identify this medication, sliced to support IDMP",
"mustSupport": true
}, {
"id": "Medication.code.coding",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"slicing": {
"rules": "openAtEnd",
"description": "This slicing on the coding element of code is open, with discriminator based on the value set binding. It carries one slice for each of the IDMP identifiers, or any equivalent representation of these concepts (e.g. medical product); plus one slice for the ATC classification. \r\nOther representations of the medication (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jursisdiction code systems, or any classification) use extra slices, since the slicing is open. \r\n A special slice is defined to carry the absent or unknown property.\r\nThe value sets used by the IDMP slices are provisional and include few concepts for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.",
"discriminator": [ {
"path": "binding.valueSet",
"type": "value"
} ]
},
"definition": "A representation of the vaccine in a code system. The representation can be granular or may also be a class or category."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L1",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "Pharmaceutical Product Identifier, Level 1",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl1-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl1"
} ]
},
"sliceName": "pharmaceuticalProduct-L1",
"definition": "IDMP PhPID Level 1 (Implies substances) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as s and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L1.system",
"path": "Medication.code.coding.system"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L1.code",
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L1.display",
"path": "Medication.code.coding.display",
"short": "Name of the Pharmaceutical Product [Substance(s)]",
"definition": "Name of the Pharmaceutical Product (Substances). Example: Amoxicillin and Clavulanate Potassium"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L2",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "Pharmaceutical Product Identifier, Level 2",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl2-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl2"
} ]
},
"sliceName": "pharmaceuticalProduct-L2",
"definition": "IDMP PhPID Level 2 (Implies substances and strength) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as substances and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L2.system",
"path": "Medication.code.coding.system"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L2.code",
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L2.display",
"path": "Medication.code.coding.display",
"short": "Name of the Pharmaceutical Product [Substance(s) + Strength + reference strength]",
"definition": "Name of the Pharmaceutical Product [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L3",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "Pharmaceutical Product Identifier, Level 3",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl3-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl3"
} ]
},
"sliceName": "pharmaceuticalProduct-L3",
"definition": "IDMP PhPID Level 3 (Implies substances and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as substances and administrable dose form, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L3.system",
"path": "Medication.code.coding.system"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L3.code",
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L3.display",
"path": "Medication.code.coding.display",
"short": "Name of the Pharmaceutical Product [Substance(s) + administrable dose form]",
"definition": "Name of the Pharmaceutical Product [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L4",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "Pharmaceutical Product Identifier, Level 4",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl4-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhPIDLvl4"
} ]
},
"sliceName": "pharmaceuticalProduct-L4",
"definition": "IDMP PhPID Level 4 (Implies substances, strength, and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as substances and administrable dose form, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product."
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L4.system",
"path": "Medication.code.coding.system"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L4.code",
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.coding:pharmaceuticalProduct-L4.display",
"path": "Medication.code.coding.display",
"short": "Name of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]",
"definition": "Name of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet.",
"mustSupport": true
}, {
"id": "Medication.code.coding:medicinalProduct",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "Medicinal Product Identifier",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/mpid-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MPID"
} ]
},
"sliceName": "medicinalProduct",
"definition": "IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier.\r\n\r\nIDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorisation numbers allocated by a regulator.\r\n\r\nMPID implies one (set of) PhPID.\r\nThe MPID shall use a common segment pattern related to a Medicinal Product, which\r\nwhen each segment is valued shall define a specific MPID concept. The pattern is:\r\n a) Country code segment (ISO 3166-1 alpha-2 code elements);\r\n b) Marketing Authorization Holder (Organization Identifier) code segment;\r\n c) Medicinal Product code segment (Unique Medicinal Product Identifier).\r\n Any change of the values related to these three code segments shall result in the\r\nassignment of a new MPID.\r",
"mustSupport": true
}, {
"id": "Medication.code.coding:medicinalProduct.system",
"path": "Medication.code.coding.system"
}, {
"id": "Medication.code.coding:medicinalProduct.code",
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.coding:medicinalProduct.display",
"path": "Medication.code.coding.display",
"short": "Name of the Medicinal Product",
"definition": "Name of the Medicinal Product, in some cases it corresponds to the brand name."
}, {
"id": "Medication.code.coding:packagedProduct",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "Packaged Medicinal Product Identifier",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/pcid-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PCID"
} ]
},
"sliceName": "packagedProduct",
"definition": "IDMP Packaged Medicinal Product Identifier or any equivalent Packaged Medicinal Product Identifier.\r\n\r\nUniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package;\r\n\r\nThe PCID shall use a common segment pattern related to a package of a Medicinal\r\nProduct, which when each segment is valued, shall define a specific PCID concept. The\r\npattern is:\r\n a) MPID for the Medicinal Product\r\n b) package description code segment, which refers to a unique identifier for each\r\npackage.",
"mustSupport": true
}, {
"id": "Medication.code.coding:packagedProduct.system",
"path": "Medication.code.coding.system"
}, {
"id": "Medication.code.coding:packagedProduct.code",
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.coding:packagedProduct.display",
"path": "Medication.code.coding.display",
"short": "Name of the Packaged Medicinal Product",
"definition": "Name of the Packaged Medicinal Product.",
"mustSupport": true
}, {
"id": "Medication.code.coding:atcClass",
"max": "1",
"path": "Medication.code.coding",
"type": [ {
"code": "Coding",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips" ]
} ],
"short": "WHO ATC classification",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "WHO ATC"
} ]
},
"sliceName": "atcClass",
"definition": "WHO ATC classification"
}, {
"id": "Medication.code.coding:atcClass.system",
"min": 1,
"path": "Medication.code.coding.system",
"fixedUri": "http://www.whocc.no/atc"
}, {
"id": "Medication.code.coding:atcClass.code",
"min": 1,
"path": "Medication.code.coding.code"
}, {
"id": "Medication.code.text",
"path": "Medication.code.text",
"definition": "This element is supposed to be valorized with the complete Medicinal Product Name as approved by the Medicines Regulatory Agency in a jurisdiction.\r\nThe name may be applicable in one or more country/language combinations.",
"mustSupport": true
}, {
"id": "Medication.status",
"max": "0",
"path": "Medication.status"
}, {
"id": "Medication.manufacturer",
"max": "0",
"path": "Medication.manufacturer"
}, {
"id": "Medication.form",
"path": "Medication.form",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationForm"
} ]
},
"definition": "Describes the form of the item. Powder; tablets; capsule.\r\n\r\nAdministrable Pharmaceutical Dose Form. \r\nThis code represents the form of the medication (e.g. tablet, capsule, liquid)\r\n\r\nSince the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration.\r\n\r\nIt is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT.",
"mustSupport": true
}, {
"id": "Medication.form.coding.system",
"path": "Medication.form.coding.system",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform",
"description": "EDQM Standard Terms"
}
}, {
"id": "Medication.ingredient",
"path": "Medication.ingredient",
"mustSupport": true
}, {
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept",
"path": "Medication.ingredient.itemCodeableConcept",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips",
"description": "SNOMED CT drug substances"
},
"comment": "The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances. \r\nThe Global Ingredient Archival System (GInAS) will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard.\r\nThose identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances.\r\nThis choice will be revised based on the availability and the maturity of GInAS.",
"sliceName": "itemCodeableConcept"
}, {
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding",
"path": "Medication.ingredient.itemCodeableConcept.coding",
"mustSupport": true
}, {
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.system",
"path": "Medication.ingredient.itemCodeableConcept.coding.system",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips"
}
}, {
"id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.text",
"path": "Medication.ingredient.itemCodeableConcept.text",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"mustSupport": true
}, {
"id": "Medication.ingredient.isActive",
"max": "0",
"path": "Medication.ingredient.isActive"
}, {
"id": "Medication.ingredient.amount",
"path": "Medication.ingredient.amount",
"type": [ {
"code": "Ratio",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/ratio-uv-ips" ]
} ],
"mustSupport": true
} ]
},
"contact": [ {
"name": "Chritof Gessner"
}, {
"name": "François Macary"
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication"
}