{
"description": "This profile represents the constraints applied to the MedicationStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A record of a medication statement is represented in the patient summary as an instance of a MedicationStatement resource constrained by this profile.",
"_filename": "StructureDefinition-medicationstatement-uv-ips.json",
"package_name": "hl7.fhir.uv.ips",
"date": "2018-02-14T22:57:06.512+01:00",
"derivation": "constraint",
"meta": {
"lastUpdated": "2018-02-21T00:47:03.873+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 statement related to the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.",
"name": "MedicationStatement-uv-ips",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"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": "MedicationStatement",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Medication Statement",
"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": "MedicationStatement",
"min": 0,
"definition": "A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \r\rThe primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.",
"isModifier": false,
"short": "Record of medication being taken by a patient",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "SubstanceAdministration",
"identity": "rim"
} ],
"max": "*",
"id": "MedicationStatement",
"comment": "When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered:\rMedicationStatement.status + MedicationStatement.wasNotTaken\rStatus=Active + NotTaken=T = Not currently taking\rStatus=Completed + NotTaken=T = Not taken in the past\rStatus=Intended + NotTaken=T = No intention of taking\rStatus=Active + NotTaken=F = Taking, but not as prescribed\rStatus=Active + NotTaken=F = Taking\rStatus=Intended +NotTaken= F = Will be taking (not started)\rStatus=Completed + NotTaken=F = Taken in past\rStatus=In Error + NotTaken=N/A = In Error.",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement"
},
"isSummary": false
}, {
"path": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.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": "MedicationStatement.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "MedicationStatement.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.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": "MedicationStatement.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ]
} ],
"mustSupport": true,
"sliceName": "dateAbsentReason",
"max": "*",
"id": "MedicationStatement.extension:dateAbsentReason",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "MedicationStatement.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": "MedicationStatement.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
}, {
"path": "MedicationStatement.identifier",
"min": 0,
"definition": "External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"isModifier": false,
"short": "External identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "MedicationStatement.identifier",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.basedOn",
"requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min": 0,
"definition": "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"isModifier": false,
"short": "Fulfils plan, proposal or order",
"mapping": [ {
"map": "Event.basedOn",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ]
} ],
"max": "*",
"id": "MedicationStatement.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.basedOn"
},
"isSummary": true
}, {
"path": "MedicationStatement.basedOn.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": "MedicationStatement.basedOn.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.basedOn.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": "MedicationStatement.basedOn.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": "MedicationStatement.basedOn.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.basedOn.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.basedOn.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.basedOn.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.basedOn.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.basedOn.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.basedOn.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.basedOn.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.partOf",
"requirements": "This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used.",
"min": 0,
"definition": "A larger event of which this particular event is a component or step.",
"isModifier": false,
"short": "Part of referenced event",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "http://hl7.org/fhir/StructureDefinition/MedicationStatement", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation" ]
} ],
"max": "*",
"id": "MedicationStatement.partOf",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.partOf"
},
"isSummary": true
}, {
"path": "MedicationStatement.partOf.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": "MedicationStatement.partOf.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.partOf.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": "MedicationStatement.partOf.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": "MedicationStatement.partOf.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.partOf.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.partOf.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.partOf.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.partOf.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.partOf.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.partOf.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.partOf.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.status",
"min": 1,
"definition": "A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.",
"isModifier": true,
"short": "active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-statement-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatementStatus"
} ],
"description": "A coded concept indicating the current status of a MedicationStatement."
},
"max": "1",
"id": "MedicationStatement.status",
"comment": "MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error).\r\rThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "MedicationStatement.status"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"path": "MedicationStatement.statusReason",
"min": 0,
"definition": "Captures the reason for the current state of the MedicationStatement.",
"isModifier": false,
"short": "Reason for current status",
"mapping": [ {
"map": "Event.statusReason",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/reason-medication-status-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatementStatusReason"
} ],
"description": "A coded concept indicating the reason for the status of the statement."
},
"max": "*",
"id": "MedicationStatement.statusReason",
"comment": "This is generally only used for \"exception\" statuses such as \"not-taken\", \"on-hold\", \"cancelled\" or \"entered-in-error\". The reason for performing the event at all is captured in reasonCode, not here.",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.statusReason"
},
"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": "MedicationStatement.category",
"min": 0,
"definition": "Indicates where the medication is expected to be consumed or administered.",
"isModifier": false,
"short": "Type of medication usage",
"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" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-statement-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatementCategory"
} ],
"description": "A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered."
},
"max": "1",
"id": "MedicationStatement.category",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "MedicationStatement.category"
}
}, {
"path": "MedicationStatement.medication[x]",
"min": 1,
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that gives a reason for absent or unknown Medication..",
"isModifier": false,
"short": "What medication was taken",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".participation[typeCode=CSM].role[classCode=ADMM or MANU]",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/medication-uv-ips" ]
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-medication-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationCode"
} ],
"description": "Representation of unknown or absent medications"
},
"max": "1",
"id": "MedicationStatement.medication[x]",
"comment": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource.",
"base": {
"max": "1",
"min": 1,
"path": "MedicationStatement.medication[x]"
},
"isSummary": true
}, {
"path": "MedicationStatement.subject",
"min": 1,
"definition": "The person, animal or group who is/was taking the medication.",
"isModifier": false,
"short": "Who is/was taking the medication",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PID-3-Patient ID List",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=PAT]",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ],
"max": "1",
"id": "MedicationStatement.subject",
"base": {
"max": "1",
"min": 1,
"path": "MedicationStatement.subject"
},
"isSummary": true
}, {
"path": "MedicationStatement.subject.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": "MedicationStatement.subject.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.subject.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": "MedicationStatement.subject.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": "MedicationStatement.subject.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.subject.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.subject.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.subject.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.subject.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.subject.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.subject.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.subject.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.context",
"min": 0,
"definition": "The encounter or episode of care that establishes the context for this MedicationStatement.",
"isModifier": false,
"short": "Encounter / Episode associated with MedicationStatement",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ]
} ],
"max": "1",
"id": "MedicationStatement.context",
"base": {
"max": "1",
"min": 0,
"path": "MedicationStatement.context"
},
"isSummary": true
}, {
"path": "MedicationStatement.context.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": "MedicationStatement.context.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.context.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": "MedicationStatement.context.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": "MedicationStatement.context.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.context.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.context.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.context.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.context.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.context.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.context.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.context.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.effective[x]",
"min": 0,
"definition": "The interval of time during which it is being asserted that the patient is/was/will be taking the medication ( or was not taking, when the MedicationStatement.taken element is No).",
"isModifier": false,
"short": "The date/time or interval when the medication is/was/will taken",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "MedicationStatement.effective[x]",
"comment": "This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the \"end\" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.",
"base": {
"max": "1",
"min": 0,
"path": "MedicationStatement.effective[x]"
},
"isSummary": true
}, {
"path": "MedicationStatement.dateAsserted",
"min": 0,
"definition": "The date when the medication statement was asserted by the information source.",
"isModifier": false,
"short": "When the statement was asserted?",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "MedicationStatement.dateAsserted",
"base": {
"max": "1",
"min": 0,
"path": "MedicationStatement.dateAsserted"
},
"isSummary": true
}, {
"path": "MedicationStatement.informationSource",
"min": 0,
"definition": "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.",
"isModifier": false,
"short": "Person or organization that provided the information about the taking of this medication",
"mapping": [ {
"map": "FiveWs.source",
"identity": "w5"
}, {
"map": ".participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "MedicationStatement.informationSource",
"base": {
"max": "1",
"min": 0,
"path": "MedicationStatement.informationSource"
},
"isSummary": false
}, {
"path": "MedicationStatement.informationSource.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": "MedicationStatement.informationSource.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.informationSource.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": "MedicationStatement.informationSource.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": "MedicationStatement.informationSource.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.informationSource.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.informationSource.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.informationSource.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.informationSource.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.informationSource.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.informationSource.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.informationSource.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.derivedFrom",
"min": 0,
"definition": "Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.",
"isModifier": false,
"short": "Additional supporting information",
"mapping": [ {
"map": ".outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "*",
"id": "MedicationStatement.derivedFrom",
"comment": "Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.derivedFrom"
},
"isSummary": false
}, {
"path": "MedicationStatement.derivedFrom.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": "MedicationStatement.derivedFrom.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.derivedFrom.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": "MedicationStatement.derivedFrom.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": "MedicationStatement.derivedFrom.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.derivedFrom.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.derivedFrom.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.derivedFrom.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.derivedFrom.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.derivedFrom.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.derivedFrom.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.derivedFrom.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"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": "MedicationStatement.reasonCode",
"min": 0,
"definition": "A reason for why the medication is being/was taken.",
"isModifier": false,
"short": "Reason for why the medication is being/was taken",
"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" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/condition-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationReason"
} ],
"description": "A coded concept identifying why the medication is being taken."
},
"max": "*",
"id": "MedicationStatement.reasonCode",
"condition": [ "ele-1" ],
"comment": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.reasonCode"
}
}, {
"path": "MedicationStatement.reasonReference",
"min": 0,
"definition": "Condition or observation that supports why the medication is being/was taken.",
"isModifier": false,
"short": "Condition or observation that supports why the medication is being/was taken",
"mapping": [ {
"map": "Event.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport" ]
} ],
"max": "*",
"id": "MedicationStatement.reasonReference",
"comment": "This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.reasonReference"
},
"isSummary": false
}, {
"path": "MedicationStatement.reasonReference.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": "MedicationStatement.reasonReference.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.reasonReference.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": "MedicationStatement.reasonReference.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": "MedicationStatement.reasonReference.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MedicationStatement.reasonReference.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MedicationStatement.reasonReference.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "MedicationStatement.reasonReference.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.reasonReference.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "MedicationStatement.reasonReference.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MedicationStatement.reasonReference.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.reasonReference.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.note",
"min": 0,
"definition": "Provides extra information about the medication statement that is not conveyed by the other attributes.",
"isModifier": false,
"short": "Further information about the statement",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "MedicationStatement.note",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.note"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage",
"min": 0,
"definition": "Indicates how the medication is/was or should be taken by the patient.",
"isModifier": false,
"short": "Details of how medication is/was taken or should be taken",
"mapping": [ {
"map": "refer dosageInstruction mapping",
"identity": "rim"
} ],
"type": [ {
"code": "Dosage"
} ],
"mustSupport": true,
"max": "*",
"id": "MedicationStatement.dosage",
"comment": "The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, \"from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily.\" It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.",
"base": {
"max": "*",
"min": 0,
"path": "MedicationStatement.dosage"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.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": "MedicationStatement.dosage.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.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": "MedicationStatement.dosage.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": "MedicationStatement.dosage.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": "MedicationStatement.dosage.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": "MedicationStatement.dosage.sequence",
"requirements": "If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.",
"min": 0,
"definition": "Indicates the order in which the dosage instructions should be applied or interpreted.",
"isModifier": false,
"short": "The order of the dosage instructions",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "integer"
} ],
"max": "1",
"id": "MedicationStatement.dosage.sequence",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.sequence"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.text",
"requirements": "Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.",
"min": 0,
"definition": "Free text dosage instructions e.g. SIG.",
"isModifier": false,
"short": "Free text dosage instructions e.g. SIG",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "MedicationStatement.dosage.text",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.text"
},
"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": "MedicationStatement.dosage.additionalInstruction",
"requirements": "Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, \"Swallow with plenty of water\" which might or might not be coded.",
"min": 0,
"definition": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\").",
"isModifier": false,
"short": "Supplemental instruction or warnings to the patient - e.g. \"with meals\", \"may cause drowsiness\"",
"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" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/additional-instruction-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdditionalInstruction"
} ],
"description": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\"."
},
"max": "*",
"id": "MedicationStatement.dosage.additionalInstruction",
"condition": [ "ele-1" ],
"comment": "Information about administration or preparation of the medication (e.g. \"infuse as rapidly as possibly via intraperitoneal port\" or \"immediately following drug x\") should be populated in dosage.text.",
"base": {
"max": "*",
"min": 0,
"path": "Dosage.additionalInstruction"
}
}, {
"path": "MedicationStatement.dosage.patientInstruction",
"min": 0,
"definition": "Instructions in terms that are understood by the patient or consumer.",
"isModifier": false,
"short": "Patient or consumer oriented instructions",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "MedicationStatement.dosage.patientInstruction",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.patientInstruction"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing",
"requirements": "The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.",
"min": 0,
"definition": "When medication should be administered.",
"isModifier": false,
"short": "When medication should be administered",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Timing"
} ],
"mustSupport": true,
"max": "1",
"id": "MedicationStatement.dosage.timing",
"comment": "This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.timing"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.event",
"requirements": "In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.",
"min": 0,
"definition": "Identifies specific times when the event occurs.",
"isModifier": false,
"short": "When the event occurs",
"mapping": [ {
"map": "QLIST",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "*",
"id": "MedicationStatement.dosage.timing.event",
"base": {
"max": "*",
"min": 0,
"path": "Timing.event"
},
"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())"
}, {
"key": "tim-9",
"human": "If there's an offset, there must be a when (and not C, CM, CD, CV)",
"xpath": "not(exists(f:offset)) or exists(f:when)",
"source": "Timing.repeat",
"severity": "error",
"expression": "offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))"
}, {
"key": "tim-5",
"human": "period SHALL be a non-negative value",
"xpath": "f:period/@value >= 0 or not(f:period/@value)",
"source": "Timing.repeat",
"severity": "error",
"expression": "period.exists() implies period >= 0"
}, {
"key": "tim-6",
"human": "If there's a periodMax, there must be a period",
"xpath": "not(exists(f:periodMax)) or exists(f:period)",
"source": "Timing.repeat",
"severity": "error",
"expression": "periodMax.empty() or period.exists()"
}, {
"key": "tim-7",
"human": "If there's a durationMax, there must be a duration",
"xpath": "not(exists(f:durationMax)) or exists(f:duration)",
"source": "Timing.repeat",
"severity": "error",
"expression": "durationMax.empty() or duration.exists()"
}, {
"key": "tim-8",
"human": "If there's a countMax, there must be a count",
"xpath": "not(exists(f:countMax)) or exists(f:count)",
"source": "Timing.repeat",
"severity": "error",
"expression": "countMax.empty() or count.exists()"
}, {
"key": "tim-1",
"human": "if there's a duration, there needs to be duration units",
"xpath": "not(exists(f:duration)) or exists(f:durationUnit)",
"source": "Timing.repeat",
"severity": "error",
"expression": "duration.empty() or durationUnit.exists()"
}, {
"key": "tim-10",
"human": "If there's a timeOfDay, there cannot be be a when, or vice versa",
"xpath": "not(exists(f:timeOfDay)) or not(exists(f:when))",
"source": "Timing.repeat",
"severity": "error",
"expression": "timeOfDay.empty() or when.empty()"
}, {
"key": "tim-2",
"human": "if there's a period, there needs to be period units",
"xpath": "not(exists(f:period)) or exists(f:periodUnit)",
"source": "Timing.repeat",
"severity": "error",
"expression": "period.empty() or periodUnit.exists()"
}, {
"key": "tim-4",
"human": "duration SHALL be a non-negative value",
"xpath": "f:duration/@value >= 0 or not(f:duration/@value)",
"source": "Timing.repeat",
"severity": "error",
"expression": "duration.exists() implies duration >= 0"
} ],
"path": "MedicationStatement.dosage.timing.repeat",
"requirements": "Many timing schedules are determined by regular repetitions.",
"min": 0,
"definition": "A set of rules that describe when the event is scheduled.",
"isModifier": false,
"short": "When the event is to occur",
"mapping": [ {
"map": "Implies PIVL or EIVL",
"identity": "rim"
} ],
"type": [ {
"code": "Element"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.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": "MedicationStatement.dosage.timing.repeat.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.timing.repeat.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": "MedicationStatement.dosage.timing.repeat.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": "MedicationStatement.dosage.timing.repeat.bounds[x]",
"min": 0,
"definition": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.",
"isModifier": false,
"short": "Length/Range of lengths, or (Start and/or end) limits",
"mapping": [ {
"map": "IVL(TS) used in a QSI",
"identity": "rim"
} ],
"type": [ {
"code": "Duration"
}, {
"code": "Period"
}, {
"code": "Range",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/range-uv-ips" ]
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.bounds[x]",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.bounds[x]"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.count",
"requirements": "Repetitions may be limited by end time or total occurrences.",
"min": 0,
"definition": "A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.",
"isModifier": false,
"short": "Number of times to repeat",
"mapping": [ {
"map": "PIVL.count",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.count",
"comment": "If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.count"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.countMax",
"min": 0,
"definition": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.",
"isModifier": false,
"short": "Maximum number of times to repeat",
"mapping": [ {
"map": "PIVL.count",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.countMax",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.countMax"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.duration",
"requirements": "Some activities are not instantaneous and need to be maintained for a period of time.",
"min": 0,
"definition": "How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.",
"isModifier": false,
"short": "How long when it happens",
"mapping": [ {
"map": "PIVL.phase",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.duration",
"comment": "For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.duration"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.durationMax",
"requirements": "Some activities are not instantaneous and need to be maintained for a period of time.",
"min": 0,
"definition": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.",
"isModifier": false,
"short": "How long when it happens (Max)",
"mapping": [ {
"map": "PIVL.phase",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.durationMax",
"comment": "For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.durationMax"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.durationUnit",
"min": 0,
"definition": "The units of time for the duration, in UCUM units.",
"isModifier": false,
"short": "s | min | h | d | wk | mo | a - unit of time (UCUM)",
"mapping": [ {
"map": "PIVL.phase.unit",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/units-of-time",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UnitsOfTime"
} ],
"description": "A unit of time (units from UCUM)."
},
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.durationUnit",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.durationUnit"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.frequency",
"min": 0,
"definition": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.",
"isModifier": false,
"short": "Event occurs frequency times per period",
"mapping": [ {
"map": "PIVL.phase",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"meaningWhenMissing": "If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this",
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.frequency",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.frequency"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.frequencyMax",
"min": 0,
"definition": "If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.",
"isModifier": false,
"short": "Event occurs up to frequencyMax times per period",
"mapping": [ {
"map": "PIVL.phase",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.frequencyMax",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.frequencyMax"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.period",
"min": 0,
"definition": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.",
"isModifier": false,
"short": "Event occurs frequency times per period",
"mapping": [ {
"map": "PIVL.phase",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.period",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.period"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.periodMax",
"min": 0,
"definition": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3-5 days.",
"isModifier": false,
"short": "Upper limit of period (3-4 hours)",
"mapping": [ {
"map": "PIVL.phase",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.periodMax",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.periodMax"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.periodUnit",
"min": 0,
"definition": "The units of time for the period in UCUM units.",
"isModifier": false,
"short": "s | min | h | d | wk | mo | a - unit of time (UCUM)",
"mapping": [ {
"map": "PIVL.phase.unit",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/units-of-time",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UnitsOfTime"
} ],
"description": "A unit of time (units from UCUM)."
},
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.periodUnit",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.periodUnit"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.dayOfWeek",
"min": 0,
"definition": "If one or more days of week is provided, then the action happens only on the specified day(s).",
"isModifier": false,
"short": "mon | tue | wed | thu | fri | sat | sun",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DayOfWeek"
} ]
},
"max": "*",
"id": "MedicationStatement.dosage.timing.repeat.dayOfWeek",
"comment": "If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.",
"base": {
"max": "*",
"min": 0,
"path": "Timing.repeat.dayOfWeek"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.timeOfDay",
"min": 0,
"definition": "Specified time of day for action to take place.",
"isModifier": false,
"short": "Time of day for action",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "time"
} ],
"max": "*",
"id": "MedicationStatement.dosage.timing.repeat.timeOfDay",
"comment": "When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.",
"base": {
"max": "*",
"min": 0,
"path": "Timing.repeat.timeOfDay"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.when",
"requirements": "Timings are frequently determined by occurrences such as waking, eating and sleep.",
"min": 0,
"definition": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.",
"isModifier": false,
"short": "Code for time period of occurrence",
"mapping": [ {
"map": "EIVL.event",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/event-timing",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventTiming"
} ],
"description": "Real world event relating to the schedule."
},
"max": "*",
"id": "MedicationStatement.dosage.timing.repeat.when",
"comment": "When more than one event is listed, the event is tied to the union of the specified events.",
"base": {
"max": "*",
"min": 0,
"path": "Timing.repeat.when"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.repeat.offset",
"min": 0,
"definition": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.",
"isModifier": false,
"short": "Minutes from event (before or after)",
"mapping": [ {
"map": "EIVL.offset",
"identity": "rim"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"max": "1",
"id": "MedicationStatement.dosage.timing.repeat.offset",
"base": {
"max": "1",
"min": 0,
"path": "Timing.repeat.offset"
},
"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": "MedicationStatement.dosage.timing.code",
"min": 0,
"definition": "A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).",
"isModifier": false,
"short": "BID | TID | QID | AM | PM | QD | QOD | +",
"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" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/timing-abbreviation",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TimingAbbreviation"
} ],
"description": "Code for a known / defined timing pattern."
},
"max": "1",
"id": "MedicationStatement.dosage.timing.code",
"condition": [ "ele-1" ],
"comment": "BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is \"always at 7am and 6pm\". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or the a structured representation should be used (in this case, specifying the two event times).",
"base": {
"max": "1",
"min": 0,
"path": "Timing.code"
}
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.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": "MedicationStatement.dosage.timing.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
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.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": "MedicationStatement.dosage.timing.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"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/event-timing"
},
"max": "1",
"id": "MedicationStatement.dosage.timing.code.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.coding.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.coding.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.coding.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.timing.code.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": "MedicationStatement.dosage.timing.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": "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": "MedicationStatement.dosage.timing.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": "MedicationStatement.dosage.asNeeded[x]",
"min": 0,
"definition": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).",
"isModifier": false,
"short": "Take \"as needed\" (for x)",
"mapping": [ {
"map": ".outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code=\"as needed\"].value=boolean or codable concept",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAsNeededReason"
} ],
"description": "A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\" etc."
},
"max": "1",
"id": "MedicationStatement.dosage.asNeeded[x]",
"comment": "Can express \"as needed\" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express \"as needed\" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not \"prn\" or \"as needed\".",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.asNeeded[x]"
},
"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": "MedicationStatement.dosage.site",
"requirements": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"definition": "Body site to administer to.",
"isModifier": false,
"short": "Body site to administer to",
"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" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/approach-site-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationSite"
} ],
"description": "A coded concept describing the site location the medicine enters into or onto the body."
},
"max": "1",
"id": "MedicationStatement.dosage.site",
"condition": [ "ele-1" ],
"comment": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.site"
}
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips"
},
"max": "*",
"id": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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/target-site-uv-ips"
},
"max": "1",
"id": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.coding.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.coding.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.coding.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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": "MedicationStatement.dosage.site.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
}, {
"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": "MedicationStatement.dosage.route",
"requirements": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.",
"min": 0,
"definition": "How drug should enter body.",
"isModifier": false,
"short": "How drug should enter body",
"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/route-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RouteOfAdministration"
} ],
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject."
},
"max": "1",
"id": "MedicationStatement.dosage.route",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.route"
}
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration",
"description": "EDQM Standards Terms"
},
"max": "*",
"id": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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-route-of-administration"
},
"max": "1",
"id": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.coding.display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.coding.display.extension:translation",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.coding.display.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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": "MedicationStatement.dosage.route.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
}, {
"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": "MedicationStatement.dosage.method",
"requirements": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.",
"min": 0,
"definition": "Technique for administering medication.",
"isModifier": false,
"short": "Technique for administering medication",
"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" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/administration-method-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationMethod"
} ],
"description": "A coded concept describing the technique by which the medicine is administered."
},
"max": "1",
"id": "MedicationStatement.dosage.method",
"condition": [ "ele-1" ],
"comment": "Terminologies used often pre-coordinate this term with the route and or form of administration.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.method"
}
}, {
"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": "MedicationStatement.dosage.doseAndRate",
"min": 0,
"definition": "The amount of medication administered.",
"isModifier": false,
"short": "Amount of medication administered",
"type": [ {
"code": "Element"
} ],
"max": "*",
"id": "MedicationStatement.dosage.doseAndRate",
"base": {
"max": "*",
"min": 0,
"path": "Dosage.doseAndRate"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.doseAndRate.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": "MedicationStatement.dosage.doseAndRate.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.doseAndRate.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": "MedicationStatement.dosage.doseAndRate.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": "MedicationStatement.dosage.doseAndRate.type",
"min": 1,
"definition": "The kind of dose or rate specified, for example, ordered or calculated.",
"isModifier": false,
"short": "The kind of dose or rate specified",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/dose-rate-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DoseAndRateType"
} ],
"description": "The kind of dose or rate specified."
},
"max": "1",
"id": "MedicationStatement.dosage.doseAndRate.type",
"base": {
"max": "1",
"min": 1,
"path": "Dosage.doseAndRate.type"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.doseAndRate.dose[x]",
"requirements": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"definition": "Amount of medication per dose.",
"isModifier": false,
"short": "Amount of medication per dose",
"mapping": [ {
"map": ".doseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Range"
}, {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "MedicationStatement.dosage.doseAndRate.dose[x]",
"comment": "Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.doseAndRate.dose[x]"
},
"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())"
}, {
"key": "qty-3",
"human": "If a code for the unit is present, the system SHALL also be present",
"xpath": "not(exists(f:code)) or exists(f:system)",
"source": "Quantity",
"severity": "error",
"expression": "code.empty() or system.exists()"
}, {
"key": "sqty-1",
"human": "The comparator is not used on a SimpleQuantity",
"xpath": "not(exists(f:comparator))",
"source": "Quantity",
"severity": "error",
"expression": "comparator.empty()"
} ],
"path": "MedicationStatement.dosage.doseAndRate.rateQuantity",
"requirements": "Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.",
"min": 0,
"definition": "The comparator is not used on a SimpleQuantity",
"isModifier": false,
"short": "A fixed quantity (no comparator)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "SN (see also Range) or CQ",
"identity": "v2"
}, {
"map": "PQ, IVL, MO, CO, depending on the values",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"sliceName": "rateQuantity",
"max": "0",
"id": "MedicationStatement.dosage.doseAndRate.rateQuantity:rateQuantity",
"condition": [ "ele-1" ],
"comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.doseAndRate.rate[x]"
}
}, {
"path": "MedicationStatement.dosage.maxDosePerPeriod",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.",
"min": 0,
"definition": "Upper limit on medication per unit of time.",
"isModifier": false,
"short": "Upper limit on medication per unit of time",
"mapping": [ {
"map": ".maxDoseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Ratio"
} ],
"max": "0",
"id": "MedicationStatement.dosage.maxDosePerPeriod",
"comment": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets every 4 hours to a maximum of 8/day\".",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.maxDosePerPeriod"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.",
"min": 0,
"definition": "Upper limit on medication per administration.",
"isModifier": false,
"short": "Upper limit on medication per administration",
"mapping": [ {
"map": "not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/quantity-uv-ips" ]
} ],
"max": "0",
"id": "MedicationStatement.dosage.maxDosePerAdministration",
"comment": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.maxDosePerAdministration"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration.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": "MedicationStatement.dosage.maxDosePerAdministration.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration.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": "MedicationStatement.dosage.maxDosePerAdministration.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": "MedicationStatement.dosage.maxDosePerAdministration.value",
"requirements": "Precision is handled implicitly in almost all cases of measurement.",
"min": 0,
"definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"isModifier": false,
"short": "Numerical value (with implicit precision)",
"mapping": [ {
"map": "SN.2 / CQ - N/A",
"identity": "v2"
}, {
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerAdministration.value",
"comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.value"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration.comparator",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"isModifier": true,
"short": "< | <= | >= | > - how to understand the value",
"mapping": [ {
"map": "SN.1 / CQ.1",
"identity": "v2"
}, {
"map": "IVL properties",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
} ],
"description": "How the Quantity should be understood and represented."
},
"max": "0",
"id": "MedicationStatement.dosage.maxDosePerAdministration.comparator",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.comparator"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration.unit",
"requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min": 0,
"definition": "A human-readable form of the unit.",
"isModifier": false,
"short": "Unit representation",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.unit",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerAdministration.unit",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.unit"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration.system",
"requirements": "Need to know the system that defines the coded form of the unit.",
"min": 0,
"definition": "The identification of the system that provides the coded form of the unit.",
"isModifier": false,
"short": "System that defines coded unit form",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "CO.codeSystem, PQ.translation.codeSystem",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerAdministration.system",
"condition": [ "qty-3" ],
"base": {
"max": "1",
"min": 0,
"path": "Quantity.system"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerAdministration.code",
"requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min": 0,
"definition": "A computer processable form of the unit in some unit representation system.",
"isModifier": false,
"short": "Coded form of the unit",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.code, MO.currency, PQ.translation.code",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerAdministration.code",
"comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.code"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.",
"min": 0,
"definition": "Upper limit on medication per lifetime of the patient.",
"isModifier": false,
"short": "Upper limit on medication per lifetime of the patient",
"mapping": [ {
"map": "not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/quantity-uv-ips" ]
} ],
"max": "0",
"id": "MedicationStatement.dosage.maxDosePerLifetime",
"base": {
"max": "1",
"min": 0,
"path": "Dosage.maxDosePerLifetime"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime.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": "MedicationStatement.dosage.maxDosePerLifetime.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime.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": "MedicationStatement.dosage.maxDosePerLifetime.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": "MedicationStatement.dosage.maxDosePerLifetime.value",
"requirements": "Precision is handled implicitly in almost all cases of measurement.",
"min": 0,
"definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"isModifier": false,
"short": "Numerical value (with implicit precision)",
"mapping": [ {
"map": "SN.2 / CQ - N/A",
"identity": "v2"
}, {
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerLifetime.value",
"comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.value"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime.comparator",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"isModifier": true,
"short": "< | <= | >= | > - how to understand the value",
"mapping": [ {
"map": "SN.1 / CQ.1",
"identity": "v2"
}, {
"map": "IVL properties",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
} ],
"description": "How the Quantity should be understood and represented."
},
"max": "0",
"id": "MedicationStatement.dosage.maxDosePerLifetime.comparator",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.comparator"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime.unit",
"requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min": 0,
"definition": "A human-readable form of the unit.",
"isModifier": false,
"short": "Unit representation",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.unit",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerLifetime.unit",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.unit"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime.system",
"requirements": "Need to know the system that defines the coded form of the unit.",
"min": 0,
"definition": "The identification of the system that provides the coded form of the unit.",
"isModifier": false,
"short": "System that defines coded unit form",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "CO.codeSystem, PQ.translation.codeSystem",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerLifetime.system",
"condition": [ "qty-3" ],
"base": {
"max": "1",
"min": 0,
"path": "Quantity.system"
},
"isSummary": true
}, {
"path": "MedicationStatement.dosage.maxDosePerLifetime.code",
"requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min": 0,
"definition": "A computer processable form of the unit in some unit representation system.",
"isModifier": false,
"short": "Coded form of the unit",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.code, MO.currency, PQ.translation.code",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "MedicationStatement.dosage.maxDosePerLifetime.code",
"comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.code"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "e91c5414-9b1d-445a-9a41-e39e002923cc",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/ips/StructureDefinition/medicationstatement-uv-ips",
"version": "0.2.0",
"differential": {
"element": [ {
"id": "MedicationStatement",
"path": "MedicationStatement"
}, {
"id": "MedicationStatement.extension",
"path": "MedicationStatement.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "MedicationStatement.extension:dateAbsentReason",
"path": "MedicationStatement.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ]
} ],
"sliceName": "dateAbsentReason",
"mustSupport": true
}, {
"id": "MedicationStatement.basedOn",
"path": "MedicationStatement.basedOn"
}, {
"id": "MedicationStatement.basedOn.identifier",
"max": "0",
"path": "MedicationStatement.basedOn.identifier"
}, {
"id": "MedicationStatement.partOf",
"path": "MedicationStatement.partOf"
}, {
"id": "MedicationStatement.partOf.identifier",
"max": "0",
"path": "MedicationStatement.partOf.identifier"
}, {
"id": "MedicationStatement.status",
"path": "MedicationStatement.status",
"mustSupport": true
}, {
"id": "MedicationStatement.category",
"path": "MedicationStatement.category",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.medication[x]",
"path": "MedicationStatement.medication[x]",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/medication-uv-ips" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-medication-uv-ips",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationCode"
} ],
"description": "Representation of unknown or absent medications"
},
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that gives a reason for absent or unknown Medication..",
"mustSupport": true
}, {
"id": "MedicationStatement.subject",
"path": "MedicationStatement.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ]
}, {
"id": "MedicationStatement.subject.identifier",
"max": "0",
"path": "MedicationStatement.subject.identifier"
}, {
"id": "MedicationStatement.context",
"path": "MedicationStatement.context"
}, {
"id": "MedicationStatement.context.identifier",
"max": "0",
"path": "MedicationStatement.context.identifier"
}, {
"id": "MedicationStatement.effective[x]",
"path": "MedicationStatement.effective[x]",
"mustSupport": true
}, {
"id": "MedicationStatement.informationSource",
"path": "MedicationStatement.informationSource"
}, {
"id": "MedicationStatement.informationSource.identifier",
"max": "0",
"path": "MedicationStatement.informationSource.identifier"
}, {
"id": "MedicationStatement.derivedFrom",
"path": "MedicationStatement.derivedFrom"
}, {
"id": "MedicationStatement.derivedFrom.identifier",
"max": "0",
"path": "MedicationStatement.derivedFrom.identifier"
}, {
"id": "MedicationStatement.reasonCode",
"path": "MedicationStatement.reasonCode",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.reasonReference",
"path": "MedicationStatement.reasonReference"
}, {
"id": "MedicationStatement.reasonReference.identifier",
"max": "0",
"path": "MedicationStatement.reasonReference.identifier"
}, {
"id": "MedicationStatement.dosage",
"path": "MedicationStatement.dosage",
"mustSupport": true
}, {
"id": "MedicationStatement.dosage.text",
"path": "MedicationStatement.dosage.text",
"mustSupport": true
}, {
"id": "MedicationStatement.dosage.additionalInstruction",
"path": "MedicationStatement.dosage.additionalInstruction",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.patientInstruction",
"path": "MedicationStatement.dosage.patientInstruction",
"mustSupport": true
}, {
"id": "MedicationStatement.dosage.timing",
"path": "MedicationStatement.dosage.timing",
"mustSupport": true
}, {
"id": "MedicationStatement.dosage.timing.repeat",
"path": "MedicationStatement.dosage.timing.repeat"
}, {
"id": "MedicationStatement.dosage.timing.repeat.bounds[x]",
"path": "MedicationStatement.dosage.timing.repeat.bounds[x]",
"type": [ {
"code": "Duration"
}, {
"code": "Period"
}, {
"code": "Range",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/range-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.timing.code",
"path": "MedicationStatement.dosage.timing.code",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.timing.code.coding",
"path": "MedicationStatement.dosage.timing.code.coding"
}, {
"id": "MedicationStatement.dosage.timing.code.coding.system",
"path": "MedicationStatement.dosage.timing.code.coding.system",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/event-timing"
}
}, {
"id": "MedicationStatement.dosage.site",
"path": "MedicationStatement.dosage.site",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.site.coding",
"path": "MedicationStatement.dosage.site.coding",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips"
}
}, {
"id": "MedicationStatement.dosage.site.coding.system",
"path": "MedicationStatement.dosage.site.coding.system",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips"
}
}, {
"id": "MedicationStatement.dosage.route",
"path": "MedicationStatement.dosage.route",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ],
"mustSupport": true
}, {
"id": "MedicationStatement.dosage.route.coding",
"path": "MedicationStatement.dosage.route.coding",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration",
"description": "EDQM Standards Terms"
}
}, {
"id": "MedicationStatement.dosage.route.coding.system",
"path": "MedicationStatement.dosage.route.coding.system",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration"
}
}, {
"id": "MedicationStatement.dosage.method",
"path": "MedicationStatement.dosage.method",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.doseAndRate",
"path": "MedicationStatement.dosage.doseAndRate"
}, {
"id": "MedicationStatement.dosage.doseAndRate.rateQuantity:rateQuantity",
"max": "0",
"path": "MedicationStatement.dosage.doseAndRate.rateQuantity",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"sliceName": "rateQuantity"
}, {
"id": "MedicationStatement.dosage.maxDosePerPeriod",
"max": "0",
"path": "MedicationStatement.dosage.maxDosePerPeriod"
}, {
"id": "MedicationStatement.dosage.maxDosePerAdministration",
"max": "0",
"path": "MedicationStatement.dosage.maxDosePerAdministration",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/quantity-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.maxDosePerAdministration.comparator",
"max": "0",
"path": "MedicationStatement.dosage.maxDosePerAdministration.comparator"
}, {
"id": "MedicationStatement.dosage.maxDosePerLifetime",
"max": "0",
"path": "MedicationStatement.dosage.maxDosePerLifetime",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/quantity-uv-ips" ]
} ]
}, {
"id": "MedicationStatement.dosage.maxDosePerLifetime.comparator",
"max": "0",
"path": "MedicationStatement.dosage.maxDosePerLifetime.comparator"
} ]
},
"contact": [ {
"name": "Christof Gessner"
}, {
"name": "François Macary"
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
}