Medication

Return to types list

Type Properties

Properties
PropertyValue
id30cafccc-047d-4288-94ef-643571f7919d
nameMedication
uncreatablefalse
immutablefalse
singletonfalse
transformsform, mtt, stt, downversion
allow-readonlytrue

Type Details

medication  Information related to a medication.
NameTypeIsRequiredDescription
namet:codable-valueYesName and clinical code for the medication. This name should be understandable to the person taking the medication, such as the brand name.
generic-namet:codable-valueNoGeneric name and clinical code for the medication. The generic name is often the drug name rather than the brand name.
doset:general-measurementNoDose of the medication Examples: 1 tablet, 50 ml.
strengtht:general-measurementNoStrength of medication. Example: 500mg, 10 mg/ml
frequencyt:general-measurementNoHow often the medication is taken. Example: 1 tablet per day, 2 every 6 hours, as needed.
routet:codable-valueNoRoute of medication.
indicationt:codable-valueNoIndication for medication.
date-startedd:approx-date-timeNoDate medication was started.
date-discontinuedd:approx-date-timeNoDate medication was discontinued.
prescribedt:codable-valueNoThe source of the prescription A medication that is prescribed by a physician should code "prescribed" into this element.
prescriptionmed:PrescriptionNoDetails of a prescribed medication.
Prescription  Information related to a medication prescription.
NameTypeIsRequiredDescription
prescribed-byt:personYesThe person who prescribed this medication.
date-prescribedd:approx-date-timeNoDate medication was prescribed.
amount-prescribedt:general-measurementNoAmount of medication prescribed
substitutiont:codable-valueNoWhether a substitution is permitted. Example: Dispense as written, substitution allowed
refillst:nonNegativeIntNoNumber of medication refills.
days-supplyt:positiveIntNoNumber of days supply of medication.
prescription-expirationd:dateNoDate the prescription expires.
instructionst:codable-valueNoMedication instructions.

Schema

Open schema as a file

Verify XML against this schema

<?xml version="1.0" encoding="utf-16"?>
<schema xmlns:med="urn:com.microsoft.wc.thing.medication" xmlns:d="urn:com.microsoft.wc.dates" xmlns:t="urn:com.microsoft.wc.thing.types" targetNamespace="urn:com.microsoft.wc.thing.medication" xmlns="http://www.w3.org/2001/XMLSchema">
  <import schemaLocation="base.xsd" namespace="urn:com.microsoft.wc.thing.types" />
  <import schemaLocation="dates.xsd" namespace="urn:com.microsoft.wc.dates" />
  <annotation>
    <documentation>
      <type-id xmlns="http://www.w3.org/2001/XMLSchema">30cafccc-047d-4288-94ef-643571f7919d</type-id>
      <type-name xmlns="http://www.w3.org/2001/XMLSchema">Medication</type-name>
      <version xmlns="http://www.w3.org/2001/XMLSchema">2</version>
      <wrapper-class-name xmlns="http://www.w3.org/2001/XMLSchema">Medication</wrapper-class-name>
      <wrapper-class-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136191</wrapper-class-fwlink>
      <sample-xml-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136192</sample-xml-fwlink>
      <data-type-guide-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136190</data-type-guide-fwlink>
      <summary xmlns="http://www.w3.org/2001/XMLSchema">
                Information related to a medication.
            </summary>
      <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                This type contains information describing a medication, and is related to the medication fill type.
                Instances of the medication fill type are linked to instances of this type using related items. 
                For example, if the medication is prescribed, the medication fill describes typical information that a
                pharmacy would add.
            </remarks>
    </documentation>
  </annotation>
  <complexType name="Prescription">
    <annotation>
      <documentation>
        <summary xmlns="http://www.w3.org/2001/XMLSchema">
                        Information related to a medication prescription.
                    </summary>
      </documentation>
    </annotation>
    <sequence>
      <element name="prescribed-by" type="t:person">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                The person who prescribed this medication.
                            </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="date-prescribed" type="d:approx-date-time">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Date medication was prescribed.
                            </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="amount-prescribed" type="t:general-measurement">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Amount of medication prescribed
                            </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="substitution" type="t:codable-value">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Whether a substitution is permitted.
                            </summary>
            <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                                Example: Dispense as written, substitution allowed
                            </remarks>
            <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">medication-substitution</preferred-vocabulary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="refills" type="t:nonNegativeInt">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Number of medication refills.
                            </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="days-supply" type="t:positiveInt">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Number of days supply of medication.
                            </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="prescription-expiration" type="d:date">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                            Date the prescription expires.
                        </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="instructions" type="t:codable-value">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                            Medication instructions.
                        </summary>
          </documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
  <element name="medication">
    <complexType>
      <annotation>
        <documentation>
          <summary xmlns="http://www.w3.org/2001/XMLSchema">
                        Information related to a medication.
                    </summary>
          <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                        This type contains information describing a medication, and is related to the medication fill type.
                        Instances of the medication fill type are linked to instances of this type using related items. 
                        For example, if the medication is prescribed, the medication fill describes typical information that a
                        pharmacy would add.
                    </remarks>
        </documentation>
      </annotation>
      <sequence>
        <element name="name" type="t:codable-value">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Name and clinical code for the medication.
                             </summary>
              <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                                 This name should be understandable to the person taking
                                 the medication, such as the brand name.
                             </remarks>
              <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">Rxnorm</preferred-vocabulary>
              <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">NDC</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="generic-name" type="t:codable-value">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Generic name and clinical code for the medication.
                             </summary>
              <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                                 The generic name is often the drug name rather than the brand name.
                             </remarks>
              <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">Rxnorm</preferred-vocabulary>
              <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">NDC</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="dose" type="t:general-measurement">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Dose of the medication
                            </summary>
              <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                            Examples: 1 tablet, 50 ml.
                            </remarks>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="strength" type="t:general-measurement">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Strength of medication.
                            </summary>
              <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                                Example: 500mg, 10 mg/ml
                            </remarks>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="frequency" type="t:general-measurement">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                How often the medication is taken.
                            </summary>
              <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                                Example: 1 tablet per day, 2 every 6 hours, as needed. 
                            </remarks>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="route" type="t:codable-value">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Route of medication.
                            </summary>
              <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">medication-routes</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="indication" type="t:codable-value">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Indication for medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="date-started" type="d:approx-date-time">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Date medication was started.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="date-discontinued" type="d:approx-date-time">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Date medication was discontinued.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="prescribed" type="t:codable-value">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                The source of the prescription 
                            </summary>
              <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                                A medication that is prescribed by a physician should code "prescribed"
                                into this element. 
                            </remarks>
              <preferred-vocabulary xmlns="http://www.w3.org/2001/XMLSchema">medication-prescribed</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="prescription" type="med:Prescription">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                Details of a prescribed medication. 
                            </summary>
            </documentation>
          </annotation>
        </element>
      </sequence>
    </complexType>
  </element>
</schema>


Columns

Columns describe this type in the STT and MTT transformations.

Columns
TagLabelTypeWidth
nameNameString100
indicationReason for TakingString100
date-startedDate StartedString100
date-discontinuedDate StoppedString100
prescribed-byPrescribed ByString100
generic-nameGeneric NameString100
doseDoseString100
strengthStrengthString100
frequencyFrequencyString100
wc-idIDString50
wc-versionVersion StampString50
wc-noteNoteString100
wc-tagsTagsString100
wc-dateEffective DateDateTime50
wc-typeType NameString50
wc-typeidType IDString50
wc-sourceSourceString100
wc-brandsBrandsString100
wc-relatedthingsRelated ItemsString100
wc-ispersonalIs PersonalBoolean40
wc-audit-personnameChanged byString100
wc-audit-dateDateDateTime100
wc-audit-actionActionString100
wc-audit-appnameAppString100
wc-issignedSignedBoolean50
wc-isdownversionedDown VersionedBoolean50
wc-isupversionedUp VersionedBoolean50
wc-stateItem StateString50