HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.1.0 - STU1 Release 1.1 - Standard for Trial-Use International flag

This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v1.1.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, 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: 1.1.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

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
... id S 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
... text 0..0
... contained 0..0
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was taken
... subject S 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
.... display 0..0
... effective[x] SC 0..1 The date/time or interval when the medication is/was/will be taken
uds-plus-medstat-1: All dateTime data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-2: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-3: All Period.end data elements should be truncated to a year only for de-identified resources.
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SC 0..1 dateTime When the statement was asserted?
uds-plus-medstat-4: All dateTime data elements should be truncated to a year only for de-identified resources.
... informationSource
.... display 0..0
... note 0..0
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
.... timing C 0..1 Timing When medication should be administered
uds-plus-medstat-5: All Timing.event data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-6: All Timing.event data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
uds-plus-medstat-1errorMedicationStatement.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-2errorMedicationStatement.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-3errorMedicationStatement.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-4errorMedicationStatement.dateAssertedAll 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-5errorMedicationStatement.dosage.timingAll 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-6errorMedicationStatement.dosage.timingAll 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
... id SΣ 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
... effective[x] SΣC 0..1 The date/time or interval when the medication is/was/will be taken
uds-plus-medstat-1: All dateTime data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-2: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-3: All Period.end data elements should be truncated to a year only for de-identified resources.
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣC 0..1 dateTime When the statement was asserted?
uds-plus-medstat-4: All dateTime data elements should be truncated to a year only for de-identified resources.
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... timing ΣC 0..1 Timing When medication should be administered
uds-plus-medstat-5: All Timing.event data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-6: All Timing.event data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-medstat-1errorMedicationStatement.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-2errorMedicationStatement.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-3errorMedicationStatement.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-4errorMedicationStatement.dateAssertedAll 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-5errorMedicationStatement.dosage.timingAll 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-6errorMedicationStatement.dosage.timingAll 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
... id SΣ 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External identifier
... basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
... status ?!SΣ 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.

... statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category Σ 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.

... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 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).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] SΣC 0..1 The date/time or interval when the medication is/was/will be taken
uds-plus-medstat-1: All dateTime data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-2: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-3: All Period.end data elements should be truncated to a year only for de-identified resources.
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣC 0..1 dateTime When the statement was asserted?
uds-plus-medstat-4: All dateTime data elements should be truncated to a year only for de-identified resources.
... informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 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).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... derivedFrom 0..* Reference(Resource) Additional supporting information
... 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.


... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 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".


.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing ΣC 0..1 Timing When medication should be administered
uds-plus-medstat-5: All Timing.event data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-6: All Timing.event data elements should be truncated to a year only for de-identified resources.
.... asNeeded[x] Σ 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.

..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 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.

.... route Σ 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.

.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.informationSource.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
MedicationStatement.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
MedicationStatement.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationStatement.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationStatement.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-medstat-1errorMedicationStatement.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-2errorMedicationStatement.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-3errorMedicationStatement.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-4errorMedicationStatement.dateAssertedAll 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-5errorMedicationStatement.dosage.timingAll 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-6errorMedicationStatement.dosage.timingAll 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

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

Differential View

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
... id S 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
... text 0..0
... contained 0..0
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was taken
... subject S 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
.... display 0..0
... effective[x] SC 0..1 The date/time or interval when the medication is/was/will be taken
uds-plus-medstat-1: All dateTime data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-2: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-3: All Period.end data elements should be truncated to a year only for de-identified resources.
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SC 0..1 dateTime When the statement was asserted?
uds-plus-medstat-4: All dateTime data elements should be truncated to a year only for de-identified resources.
... informationSource
.... display 0..0
... note 0..0
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
.... timing C 0..1 Timing When medication should be administered
uds-plus-medstat-5: All Timing.event data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-6: All Timing.event data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
uds-plus-medstat-1errorMedicationStatement.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-2errorMedicationStatement.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-3errorMedicationStatement.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-4errorMedicationStatement.dateAssertedAll 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-5errorMedicationStatement.dosage.timingAll 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-6errorMedicationStatement.dosage.timingAll 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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
... id SΣ 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
... effective[x] SΣC 0..1 The date/time or interval when the medication is/was/will be taken
uds-plus-medstat-1: All dateTime data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-2: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-3: All Period.end data elements should be truncated to a year only for de-identified resources.
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣC 0..1 dateTime When the statement was asserted?
uds-plus-medstat-4: All dateTime data elements should be truncated to a year only for de-identified resources.
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... timing ΣC 0..1 Timing When medication should be administered
uds-plus-medstat-5: All Timing.event data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-6: All Timing.event data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-medstat-1errorMedicationStatement.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-2errorMedicationStatement.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-3errorMedicationStatement.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-4errorMedicationStatement.dateAssertedAll 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-5errorMedicationStatement.dosage.timingAll 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-6errorMedicationStatement.dosage.timingAll 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement De-Identified UDS Plus MedicationStatement
... id SΣ 0..1 id The de-identified MedicationStatement identifier created by the health center to send data to UDS+ Data Receiver
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External identifier
... basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
... status ?!SΣ 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.

... statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category Σ 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.

... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(De-Identified UDS Plus Patient) Who is/was taking the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 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).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] SΣC 0..1 The date/time or interval when the medication is/was/will be taken
uds-plus-medstat-1: All dateTime data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-2: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-3: All Period.end data elements should be truncated to a year only for de-identified resources.
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣC 0..1 dateTime When the statement was asserted?
uds-plus-medstat-4: All dateTime data elements should be truncated to a year only for de-identified resources.
... informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 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).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... derivedFrom 0..* Reference(Resource) Additional supporting information
... 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.


... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 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".


.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing ΣC 0..1 Timing When medication should be administered
uds-plus-medstat-5: All Timing.event data elements should be truncated to a year only for de-identified resources.
uds-plus-medstat-6: All Timing.event data elements should be truncated to a year only for de-identified resources.
.... asNeeded[x] Σ 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.

..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 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.

.... route Σ 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.

.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.informationSource.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
MedicationStatement.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
MedicationStatement.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationStatement.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationStatement.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-medstat-1errorMedicationStatement.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-2errorMedicationStatement.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-3errorMedicationStatement.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-4errorMedicationStatement.dateAssertedAll 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-5errorMedicationStatement.dosage.timingAll 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-6errorMedicationStatement.dosage.timingAll 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

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