HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 Release 1 - Standard for Trial-Use International flag

HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG, published by HRSA BPHC. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/drajer-health/uds-plus/ and changes regularly. See the Directory of published versions

Resource Profile: De-Identified UDS Plus MedicationStatement

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-medicationstatement Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: UDSPlusMedicationStatement

The UDS+ profile is based on the MedicationStatement resource and establishes the core elements, extensions, vocabularies and value sets for representing MedicationStatement for UDS+ program.

Introduction

This profile is used to represent de-identified MedicationStatement information. The de-identification process has to remove all data elements not explicitly identified as "SUPPORTED" in the profile.

The HHS De-identification Guidance is to be followed to ensure appropriate level of de-identification is performed.

According to the HHS guidance, dates should not have a precision of more than the year. This means month and day cannot be included. This includes MedicationStatement.authoredOn.

In FHIR Resources, text elements and reference.display elements which provide human readable information to the providers may be generated using programs and tools from the data present within the resource. For e.g a MedicationStatement resource text element may contain information such as the MedicationStatement date, patient information. This type of information will enable identification of the individuals. In order to avoid inadvertent revealing of PII/PHI, text elements cannot be included in the De-identified FHIR resource and the submission will be rejected when text elements are present by the validation process.

Ids and References

The original MedicationStatement resource id should not be included in the De-identified MedicationStatement instance. Instead a new id should be created and provided as part of the FHIR resource. The Data Submitter should be capable of using the generated id to relink the data to the original MedicationStatement. All resource references to the MedicationStatement submitted as part of the UDS+ report should refer to newly generated id.

Resource references cannot contain text element as it may contain PHI/PII. The text element for following references are not allowed

  • subject
  • encounter

Date Truncation

The Data Submitter has to truncate the following dates to only have a precision of year

  • effective[x]
  • dateAsserted

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
MedicationStatement.id This element must be supported. This element is included in summaries. 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
MedicationStatement.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
MedicationStatement.medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.medication[x].medicationReference Reference(Medication)
MedicationStatement.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
MedicationStatement.effective[x] This element must be supported. This element is included in summaries. C 0..1 The date/time or interval when the medication is/was/will be taken
Constraints: uds-plus-medstat-1, uds-plus-medstat-1a, uds-plus-medstat-1b, uds-plus-medstat-2, uds-plus-medstat-2a, uds-plus-medstat-2b, uds-plus-medstat-3, uds-plus-medstat-3a, uds-plus-medstat-3b
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element must be supported. This element is included in summaries. C 0..1 dateTime When the statement was asserted?
Constraints: uds-plus-medstat-4, uds-plus-medstat-4a, uds-plus-medstat-4b
MedicationStatement.dosage This element must be supported. 0..* Dosage Details of how medication is/was taken or should be taken
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.timing This element is included in summaries. C 0..1 Timing When medication should be administered
Constraints: uds-plus-medstat-5, uds-plus-medstat-6, uds-plus-medstat-7, uds-plus-medstat-8

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
uds-plus-medstat-1 error MedicationStatement.effective[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-1a error MedicationStatement.effective[x] All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-1b error MedicationStatement.effective[x] All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-2 error MedicationStatement.effective[x] All Period.start data elements should be truncated to a year only for de-identified resources. $this is Period and Period.start.exists() implies $this.start.toString().length() = 4
uds-plus-medstat-2a error MedicationStatement.effective[x] All Period.start data elements should have valid year > 1900 $this is Period and Period.start.exists() implies $this.start.toString() >= '1900'
uds-plus-medstat-2b error MedicationStatement.effective[x] All Period.start data elements should have valid year < 2030 $this is Period and Period.start.exists() implies $this.start.toString() <= '2030'
uds-plus-medstat-3 error MedicationStatement.effective[x] All Period.end data elements should be truncated to a year only for de-identified resources. $this is Period and Period.end.exists() implies $this.end.toString().length() = 4
uds-plus-medstat-3a error MedicationStatement.effective[x] All Period.end data elements should have valid year > 1900 $this is Period and Period.end.exists() implies $this.end.toString() >= '1900'
uds-plus-medstat-3b error MedicationStatement.effective[x] All Period.end data elements should have valid year < 2030 $this is Period and Period.end.exists() implies $this.end.toString() <= '2030'
uds-plus-medstat-4 error MedicationStatement.dateAsserted All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-4a error MedicationStatement.dateAsserted All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-4b error MedicationStatement.dateAsserted All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-5 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.count() = 1
uds-plus-medstat-6 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4
uds-plus-medstat-7 error MedicationStatement.dosage.timing All Timing data elements should have valid year > 1900 $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900'
uds-plus-medstat-8 error MedicationStatement.dosage.timing All Timing data elements should have valid year < 2030 $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030'

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
MedicationStatement.id This element must be supported. 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
MedicationStatement.text 0..0 Cannot include any text in the resource as part of the de-identified data.
MedicationStatement.contained 0..0 Cannot include any contained resources in the resource as part of the de-identified data.
MedicationStatement.medication[x] This element must be supported. 1..1 CodeableConcept, Reference(Medication) What medication was taken
MedicationStatement.subject This element must be supported. 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
MedicationStatement.subject.display 0..0 Text alternative for the resource
MedicationStatement.effective[x] This element must be supported. C 0..1 The date/time or interval when the medication is/was/will be taken
Constraints: uds-plus-medstat-1, uds-plus-medstat-1a, uds-plus-medstat-1b, uds-plus-medstat-2, uds-plus-medstat-2a, uds-plus-medstat-2b, uds-plus-medstat-3, uds-plus-medstat-3a, uds-plus-medstat-3b
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element must be supported. C 0..1 dateTime When the statement was asserted?
Constraints: uds-plus-medstat-4, uds-plus-medstat-4a, uds-plus-medstat-4b
MedicationStatement.informationSource
MedicationStatement.informationSource.display 0..0 Text alternative for the resource
MedicationStatement.note 0..0 Further information about the statement
MedicationStatement.dosage This element must be supported. 0..* Dosage Details of how medication is/was taken or should be taken
MedicationStatement.dosage.timing C 0..1 Timing When medication should be administered
Constraints: uds-plus-medstat-5, uds-plus-medstat-6, uds-plus-medstat-7, uds-plus-medstat-8

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
uds-plus-medstat-1 error MedicationStatement.effective[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-1a error MedicationStatement.effective[x] All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-1b error MedicationStatement.effective[x] All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-2 error MedicationStatement.effective[x] All Period.start data elements should be truncated to a year only for de-identified resources. $this is Period and Period.start.exists() implies $this.start.toString().length() = 4
uds-plus-medstat-2a error MedicationStatement.effective[x] All Period.start data elements should have valid year > 1900 $this is Period and Period.start.exists() implies $this.start.toString() >= '1900'
uds-plus-medstat-2b error MedicationStatement.effective[x] All Period.start data elements should have valid year < 2030 $this is Period and Period.start.exists() implies $this.start.toString() <= '2030'
uds-plus-medstat-3 error MedicationStatement.effective[x] All Period.end data elements should be truncated to a year only for de-identified resources. $this is Period and Period.end.exists() implies $this.end.toString().length() = 4
uds-plus-medstat-3a error MedicationStatement.effective[x] All Period.end data elements should have valid year > 1900 $this is Period and Period.end.exists() implies $this.end.toString() >= '1900'
uds-plus-medstat-3b error MedicationStatement.effective[x] All Period.end data elements should have valid year < 2030 $this is Period and Period.end.exists() implies $this.end.toString() <= '2030'
uds-plus-medstat-4 error MedicationStatement.dateAsserted All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-4a error MedicationStatement.dateAsserted All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-4b error MedicationStatement.dateAsserted All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-5 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.count() = 1
uds-plus-medstat-6 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4
uds-plus-medstat-7 error MedicationStatement.dosage.timing All Timing data elements should have valid year > 1900 $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900'
uds-plus-medstat-8 error MedicationStatement.dosage.timing All Timing data elements should have valid year < 2030 $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030'
NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
MedicationStatement.id This element must be supported. This element is included in summaries. 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
MedicationStatement.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MedicationStatement.extension 0..* Extension Additional content defined by implementations
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.identifier This element is included in summaries. 0..* Identifier External identifier
MedicationStatement.basedOn This element is included in summaries. 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
MedicationStatement.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
MedicationStatement.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
MedicationStatement.statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
MedicationStatement.category This element is included in summaries. 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
MedicationStatement.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
MedicationStatement.medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.medication[x].medicationReference Reference(Medication)
MedicationStatement.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
MedicationStatement.subject.id 0..1 string Unique id for inter-element referencing
MedicationStatement.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MedicationStatement.subject.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MedicationStatement.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
MedicationStatement.context This element is included in summaries. 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
MedicationStatement.effective[x] This element must be supported. This element is included in summaries. C 0..1 The date/time or interval when the medication is/was/will be taken
Constraints: uds-plus-medstat-1, uds-plus-medstat-1a, uds-plus-medstat-1b, uds-plus-medstat-2, uds-plus-medstat-2a, uds-plus-medstat-2b, uds-plus-medstat-3, uds-plus-medstat-3a, uds-plus-medstat-3b
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element must be supported. This element is included in summaries. C 0..1 dateTime When the statement was asserted?
Constraints: uds-plus-medstat-4, uds-plus-medstat-4a, uds-plus-medstat-4b
MedicationStatement.informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
MedicationStatement.informationSource.id 0..1 string Unique id for inter-element referencing
MedicationStatement.informationSource.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.informationSource.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MedicationStatement.informationSource.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MedicationStatement.informationSource.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
MedicationStatement.derivedFrom 0..* Reference(Resource) Additional supporting information
MedicationStatement.reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.
MedicationStatement.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
MedicationStatement.dosage This element must be supported. 0..* Dosage Details of how medication is/was taken or should be taken
MedicationStatement.dosage.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
MedicationStatement.dosage.text This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
MedicationStatement.dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
MedicationStatement.dosage.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
MedicationStatement.dosage.timing This element is included in summaries. C 0..1 Timing When medication should be administered
Constraints: uds-plus-medstat-5, uds-plus-medstat-6, uds-plus-medstat-7, uds-plus-medstat-8
MedicationStatement.dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): 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.
MedicationStatement.dosage.asNeeded[x].asNeededBoolean boolean
MedicationStatement.dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
MedicationStatement.dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
MedicationStatement.dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
MedicationStatement.dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
MedicationStatement.dosage.doseAndRate This element is included in summaries. 0..* Element Amount of medication administered
MedicationStatement.dosage.doseAndRate.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.doseAndRate.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.doseAndRate.type This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationStatement.dosage.doseAndRate.dose[x] This element is included in summaries. 0..1 Amount of medication per dose
MedicationStatement.dosage.doseAndRate.dose[x].doseRange Range
MedicationStatement.dosage.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.doseAndRate.rate[x] This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationStatement.dosage.doseAndRate.rate[x].rateRatio Ratio
MedicationStatement.dosage.doseAndRate.rate[x].rateRange Range
MedicationStatement.dosage.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
MedicationStatement.dosage.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
Constraints: sqty-1
MedicationStatement.dosage.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
Constraints: sqty-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​statusReason Base example SNOMED CT Drug Therapy Status codes 📍4.0.1 FHIR Std.
MedicationStatement.​category Base preferred Medication usage category codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​informationSource.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error MedicationStatement.dosage.maxDosePerAdministration, MedicationStatement.dosage.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()
uds-plus-medstat-1 error MedicationStatement.effective[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-1a error MedicationStatement.effective[x] All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-1b error MedicationStatement.effective[x] All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-2 error MedicationStatement.effective[x] All Period.start data elements should be truncated to a year only for de-identified resources. $this is Period and Period.start.exists() implies $this.start.toString().length() = 4
uds-plus-medstat-2a error MedicationStatement.effective[x] All Period.start data elements should have valid year > 1900 $this is Period and Period.start.exists() implies $this.start.toString() >= '1900'
uds-plus-medstat-2b error MedicationStatement.effective[x] All Period.start data elements should have valid year < 2030 $this is Period and Period.start.exists() implies $this.start.toString() <= '2030'
uds-plus-medstat-3 error MedicationStatement.effective[x] All Period.end data elements should be truncated to a year only for de-identified resources. $this is Period and Period.end.exists() implies $this.end.toString().length() = 4
uds-plus-medstat-3a error MedicationStatement.effective[x] All Period.end data elements should have valid year > 1900 $this is Period and Period.end.exists() implies $this.end.toString() >= '1900'
uds-plus-medstat-3b error MedicationStatement.effective[x] All Period.end data elements should have valid year < 2030 $this is Period and Period.end.exists() implies $this.end.toString() <= '2030'
uds-plus-medstat-4 error MedicationStatement.dateAsserted All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-4a error MedicationStatement.dateAsserted All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-4b error MedicationStatement.dateAsserted All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-5 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.count() = 1
uds-plus-medstat-6 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4
uds-plus-medstat-7 error MedicationStatement.dosage.timing All Timing data elements should have valid year > 1900 $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900'
uds-plus-medstat-8 error MedicationStatement.dosage.timing All Timing data elements should have valid year < 2030 $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030'

This structure is derived from MedicationStatement

Summary

Mandatory: 3 elements
Must-Support: 7 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
MedicationStatement.id This element must be supported. This element is included in summaries. 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
MedicationStatement.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
MedicationStatement.medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.medication[x].medicationReference Reference(Medication)
MedicationStatement.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
MedicationStatement.effective[x] This element must be supported. This element is included in summaries. C 0..1 The date/time or interval when the medication is/was/will be taken
Constraints: uds-plus-medstat-1, uds-plus-medstat-1a, uds-plus-medstat-1b, uds-plus-medstat-2, uds-plus-medstat-2a, uds-plus-medstat-2b, uds-plus-medstat-3, uds-plus-medstat-3a, uds-plus-medstat-3b
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element must be supported. This element is included in summaries. C 0..1 dateTime When the statement was asserted?
Constraints: uds-plus-medstat-4, uds-plus-medstat-4a, uds-plus-medstat-4b
MedicationStatement.dosage This element must be supported. 0..* Dosage Details of how medication is/was taken or should be taken
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.timing This element is included in summaries. C 0..1 Timing When medication should be administered
Constraints: uds-plus-medstat-5, uds-plus-medstat-6, uds-plus-medstat-7, uds-plus-medstat-8

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
uds-plus-medstat-1 error MedicationStatement.effective[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-1a error MedicationStatement.effective[x] All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-1b error MedicationStatement.effective[x] All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-2 error MedicationStatement.effective[x] All Period.start data elements should be truncated to a year only for de-identified resources. $this is Period and Period.start.exists() implies $this.start.toString().length() = 4
uds-plus-medstat-2a error MedicationStatement.effective[x] All Period.start data elements should have valid year > 1900 $this is Period and Period.start.exists() implies $this.start.toString() >= '1900'
uds-plus-medstat-2b error MedicationStatement.effective[x] All Period.start data elements should have valid year < 2030 $this is Period and Period.start.exists() implies $this.start.toString() <= '2030'
uds-plus-medstat-3 error MedicationStatement.effective[x] All Period.end data elements should be truncated to a year only for de-identified resources. $this is Period and Period.end.exists() implies $this.end.toString().length() = 4
uds-plus-medstat-3a error MedicationStatement.effective[x] All Period.end data elements should have valid year > 1900 $this is Period and Period.end.exists() implies $this.end.toString() >= '1900'
uds-plus-medstat-3b error MedicationStatement.effective[x] All Period.end data elements should have valid year < 2030 $this is Period and Period.end.exists() implies $this.end.toString() <= '2030'
uds-plus-medstat-4 error MedicationStatement.dateAsserted All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-4a error MedicationStatement.dateAsserted All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-4b error MedicationStatement.dateAsserted All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-5 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.count() = 1
uds-plus-medstat-6 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4
uds-plus-medstat-7 error MedicationStatement.dosage.timing All Timing data elements should have valid year > 1900 $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900'
uds-plus-medstat-8 error MedicationStatement.dosage.timing All Timing data elements should have valid year < 2030 $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030'

Differential View

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
MedicationStatement.id This element must be supported. 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
MedicationStatement.text 0..0 Cannot include any text in the resource as part of the de-identified data.
MedicationStatement.contained 0..0 Cannot include any contained resources in the resource as part of the de-identified data.
MedicationStatement.status This element must be supported. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
MedicationStatement.medication[x] This element must be supported. 1..1 CodeableConcept, Reference(Medication) What medication was taken
MedicationStatement.subject This element must be supported. 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
MedicationStatement.subject.display 0..0 Text alternative for the resource
MedicationStatement.effective[x] This element must be supported. C 0..1 The date/time or interval when the medication is/was/will be taken
Constraints: uds-plus-medstat-1, uds-plus-medstat-1a, uds-plus-medstat-1b, uds-plus-medstat-2, uds-plus-medstat-2a, uds-plus-medstat-2b, uds-plus-medstat-3, uds-plus-medstat-3a, uds-plus-medstat-3b
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element must be supported. C 0..1 dateTime When the statement was asserted?
Constraints: uds-plus-medstat-4, uds-plus-medstat-4a, uds-plus-medstat-4b
MedicationStatement.informationSource
MedicationStatement.informationSource.display 0..0 Text alternative for the resource
MedicationStatement.note 0..0 Further information about the statement
MedicationStatement.dosage This element must be supported. 0..* Dosage Details of how medication is/was taken or should be taken
MedicationStatement.dosage.timing C 0..1 Timing When medication should be administered
Constraints: uds-plus-medstat-5, uds-plus-medstat-6, uds-plus-medstat-7, uds-plus-medstat-8

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
uds-plus-medstat-1 error MedicationStatement.effective[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-1a error MedicationStatement.effective[x] All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-1b error MedicationStatement.effective[x] All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-2 error MedicationStatement.effective[x] All Period.start data elements should be truncated to a year only for de-identified resources. $this is Period and Period.start.exists() implies $this.start.toString().length() = 4
uds-plus-medstat-2a error MedicationStatement.effective[x] All Period.start data elements should have valid year > 1900 $this is Period and Period.start.exists() implies $this.start.toString() >= '1900'
uds-plus-medstat-2b error MedicationStatement.effective[x] All Period.start data elements should have valid year < 2030 $this is Period and Period.start.exists() implies $this.start.toString() <= '2030'
uds-plus-medstat-3 error MedicationStatement.effective[x] All Period.end data elements should be truncated to a year only for de-identified resources. $this is Period and Period.end.exists() implies $this.end.toString().length() = 4
uds-plus-medstat-3a error MedicationStatement.effective[x] All Period.end data elements should have valid year > 1900 $this is Period and Period.end.exists() implies $this.end.toString() >= '1900'
uds-plus-medstat-3b error MedicationStatement.effective[x] All Period.end data elements should have valid year < 2030 $this is Period and Period.end.exists() implies $this.end.toString() <= '2030'
uds-plus-medstat-4 error MedicationStatement.dateAsserted All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-4a error MedicationStatement.dateAsserted All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-4b error MedicationStatement.dateAsserted All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-5 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.count() = 1
uds-plus-medstat-6 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4
uds-plus-medstat-7 error MedicationStatement.dosage.timing All Timing data elements should have valid year > 1900 $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900'
uds-plus-medstat-8 error MedicationStatement.dosage.timing All Timing data elements should have valid year < 2030 $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
MedicationStatement.id This element must be supported. This element is included in summaries. 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
MedicationStatement.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MedicationStatement.extension 0..* Extension Additional content defined by implementations
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.identifier This element is included in summaries. 0..* Identifier External identifier
MedicationStatement.basedOn This element is included in summaries. 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
MedicationStatement.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
MedicationStatement.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
MedicationStatement.statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
MedicationStatement.category This element is included in summaries. 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
MedicationStatement.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
MedicationStatement.medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.medication[x].medicationReference Reference(Medication)
MedicationStatement.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
MedicationStatement.subject.id 0..1 string Unique id for inter-element referencing
MedicationStatement.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MedicationStatement.subject.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MedicationStatement.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
MedicationStatement.context This element is included in summaries. 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
MedicationStatement.effective[x] This element must be supported. This element is included in summaries. C 0..1 The date/time or interval when the medication is/was/will be taken
Constraints: uds-plus-medstat-1, uds-plus-medstat-1a, uds-plus-medstat-1b, uds-plus-medstat-2, uds-plus-medstat-2a, uds-plus-medstat-2b, uds-plus-medstat-3, uds-plus-medstat-3a, uds-plus-medstat-3b
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element must be supported. This element is included in summaries. C 0..1 dateTime When the statement was asserted?
Constraints: uds-plus-medstat-4, uds-plus-medstat-4a, uds-plus-medstat-4b
MedicationStatement.informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
MedicationStatement.informationSource.id 0..1 string Unique id for inter-element referencing
MedicationStatement.informationSource.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.informationSource.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MedicationStatement.informationSource.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MedicationStatement.informationSource.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
MedicationStatement.derivedFrom 0..* Reference(Resource) Additional supporting information
MedicationStatement.reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.
MedicationStatement.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
MedicationStatement.dosage This element must be supported. 0..* Dosage Details of how medication is/was taken or should be taken
MedicationStatement.dosage.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
MedicationStatement.dosage.text This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
MedicationStatement.dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
MedicationStatement.dosage.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
MedicationStatement.dosage.timing This element is included in summaries. C 0..1 Timing When medication should be administered
Constraints: uds-plus-medstat-5, uds-plus-medstat-6, uds-plus-medstat-7, uds-plus-medstat-8
MedicationStatement.dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): 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.
MedicationStatement.dosage.asNeeded[x].asNeededBoolean boolean
MedicationStatement.dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
MedicationStatement.dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
MedicationStatement.dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
MedicationStatement.dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
MedicationStatement.dosage.doseAndRate This element is included in summaries. 0..* Element Amount of medication administered
MedicationStatement.dosage.doseAndRate.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.doseAndRate.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.doseAndRate.type This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationStatement.dosage.doseAndRate.dose[x] This element is included in summaries. 0..1 Amount of medication per dose
MedicationStatement.dosage.doseAndRate.dose[x].doseRange Range
MedicationStatement.dosage.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.doseAndRate.rate[x] This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationStatement.dosage.doseAndRate.rate[x].rateRatio Ratio
MedicationStatement.dosage.doseAndRate.rate[x].rateRange Range
MedicationStatement.dosage.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
MedicationStatement.dosage.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
Constraints: sqty-1
MedicationStatement.dosage.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
Constraints: sqty-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​statusReason Base example SNOMED CT Drug Therapy Status codes 📍4.0.1 FHIR Std.
MedicationStatement.​category Base preferred Medication usage category codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​informationSource.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error MedicationStatement.dosage.maxDosePerAdministration, MedicationStatement.dosage.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()
uds-plus-medstat-1 error MedicationStatement.effective[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-1a error MedicationStatement.effective[x] All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-1b error MedicationStatement.effective[x] All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-2 error MedicationStatement.effective[x] All Period.start data elements should be truncated to a year only for de-identified resources. $this is Period and Period.start.exists() implies $this.start.toString().length() = 4
uds-plus-medstat-2a error MedicationStatement.effective[x] All Period.start data elements should have valid year > 1900 $this is Period and Period.start.exists() implies $this.start.toString() >= '1900'
uds-plus-medstat-2b error MedicationStatement.effective[x] All Period.start data elements should have valid year < 2030 $this is Period and Period.start.exists() implies $this.start.toString() <= '2030'
uds-plus-medstat-3 error MedicationStatement.effective[x] All Period.end data elements should be truncated to a year only for de-identified resources. $this is Period and Period.end.exists() implies $this.end.toString().length() = 4
uds-plus-medstat-3a error MedicationStatement.effective[x] All Period.end data elements should have valid year > 1900 $this is Period and Period.end.exists() implies $this.end.toString() >= '1900'
uds-plus-medstat-3b error MedicationStatement.effective[x] All Period.end data elements should have valid year < 2030 $this is Period and Period.end.exists() implies $this.end.toString() <= '2030'
uds-plus-medstat-4 error MedicationStatement.dateAsserted All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
uds-plus-medstat-4a error MedicationStatement.dateAsserted All dateTime data elements should have valid year > 1900 $this is DateTime implies $this.toString() >= '1900'
uds-plus-medstat-4b error MedicationStatement.dateAsserted All dateTime data elements should have valid year < 2030 $this is DateTime implies $this.toString() <= '2030'
uds-plus-medstat-5 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.count() = 1
uds-plus-medstat-6 error MedicationStatement.dosage.timing All Timing.event data elements should be truncated to a year only for de-identified resources. $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4
uds-plus-medstat-7 error MedicationStatement.dosage.timing All Timing data elements should have valid year > 1900 $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900'
uds-plus-medstat-8 error MedicationStatement.dosage.timing All Timing data elements should have valid year < 2030 $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030'

This structure is derived from MedicationStatement

Summary

Mandatory: 3 elements
Must-Support: 7 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron