Medication

Return to types list

Type Properties

Properties
PropertyValue
id5c5f1223-f63c-4464-870c-3e36ba471def
nameMedication
uncreatablefalse
immutablefalse
singletonfalse
transformsform, mtt, stt, upversion
allow-readonlytrue

Type Details

medication  Information related to a medication.
NameTypeIsRequiredDescription
namestringNoName of medication.
codet:nonNegativeIntNoClinical code for medication.
date-discontinuedd:approx-date-timeNoDate medication was discontinued.
date-filledd:approx-date-timeNoDate medication prescription was filled.
date-prescribedd:approx-date-timeNoDate medication was prescribed.
is-prescribedbooleanNoTrue if medication was prescribed.
indicationstringNoFree form indication for medication.
amount-prescribedstringNoFree form amount prescribed for medication.
dose-valuemed:DoseValueNoDoses of medication.
dose-unitt:codable-valueNoDose unit of medication.
strength-valuet:nonNegativeIntNoStrength of medication.
strength-unitt:codable-valueNoFree form strength unit of medication.
frequencystringNoFree form frequency of medication.
routet:codable-valueNoRoute of medication.
durationstringNoFree form duration of medication.
duration-unitt:codable-valueNoFree form duration units of medication.
refillst:nonNegativeIntNoNumber of medication refills.
refills-leftt:nonNegativeIntNoNumber of medication refills left.
days-supplyt:nonNegativeIntNoNumber of days supply of medication.
prescription-durationt:duration-valueNoDuration of prescription.
instructionsstringNoFree form medication instructions.
substitution-permittedbooleanNoTrue of substitution is permitted.
pharmacyt:contactNoPharmacy.
prescription-numberstringNoFree form prescription number.
DoseValue  Defines a medication dosage.
NameTypeIsRequiredDescription
descriptionstringNoFree form text describing the dose that should be taken.
exact-doset:positiveDoubleNoThe dose value as an exact dose value. The dosage to be taken is exactly specified.
min-doset:positiveDoubleNoThe minimum dosage that should be taken. The dosage to be taken is specified as a range with this value indicating the minimum dosage that should be taken.
max-doset:positiveDoubleNoThe maximum dosage that should be taken. The dosage to be taken is specified as a range with this value indicating the maximum dosage that should be taken.

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">5C5F1223-F63C-4464-870C-3E36BA471DEF</type-id>
      <type-name xmlns="http://www.w3.org/2001/XMLSchema">Medication</type-name>
      <wrapper-class-name xmlns="http://www.w3.org/2001/XMLSchema">MedicationV1</wrapper-class-name>
      <wrapper-class-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136338</wrapper-class-fwlink>
      <sample-xml-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136339</sample-xml-fwlink>
      <data-type-guide-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136337</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">
                Note: Please use the new version of this data type instead of this version.
                <br />
                This thing type describes a medication a person has.
            </remarks>
    </documentation>
  </annotation>
  <complexType name="DoseValue">
    <annotation>
      <documentation>
        <summary>
                    Defines a medication dosage.
                </summary>
        <remarks>
                    The dose taken may be a fixed amount, like 2 (meaning
                    2 capsules, 2 tablets, etc.), or it may be a range, like
                    1/2 - 1, and it may also include free-form text.
                </remarks>
      </documentation>
    </annotation>
    <sequence>
      <element minOccurs="0" name="description" type="string">
        <annotation>
          <documentation>
            <summary>
                            Free form text describing the dose that should be
                            taken.
                        </summary>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="exact-dose" type="t:positiveDouble">
        <annotation>
          <documentation>
            <summary>
                            The dose value as an exact dose value.
                        </summary>
            <remarks>
                            The dosage to be taken is exactly specified.
                        </remarks>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="min-dose" type="t:positiveDouble">
        <annotation>
          <documentation>
            <summary>
                            The minimum dosage that should be taken.
                        </summary>
            <remarks>
                            The dosage to be taken is specified as a range
                            with this value indicating the minimum dosage
                            that should be taken.
                        </remarks>
          </documentation>
        </annotation>
      </element>
      <element minOccurs="0" name="max-dose" type="t:positiveDouble">
        <annotation>
          <documentation>
            <summary>
                            The maximum dosage that should be taken.
                        </summary>
            <remarks>
                            The dosage to be taken is specified as a range
                            with this value indicating the maximum dosage
                            that should be taken.
                        </remarks>
          </documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
  <element name="medication">
    <complexType>
      <annotation>
        <documentation>
          <summary>
                        Information related to a medication.
                    </summary>
          <remarks>
                        Note: Please use the new version of this data type instead of this version.
                        <br />
                        This thing type describes a medication a person has.
                    </remarks>
        </documentation>
      </annotation>
      <sequence>
        <element minOccurs="0" name="name" type="string">
          <annotation>
            <documentation>
              <summary>
                                Name of medication.
                             </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" maxOccurs="unbounded" name="code" type="t:nonNegativeInt">
          <annotation>
            <documentation>
              <summary>
                                Clinical code for medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="date-discontinued" type="d:approx-date-time">
          <annotation>
            <documentation>
              <summary>
                                Date medication was discontinued.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="date-filled" type="d:approx-date-time">
          <annotation>
            <documentation>
              <summary>
                                Date medication prescription was filled.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="date-prescribed" type="d:approx-date-time">
          <annotation>
            <documentation>
              <summary>
                                Date medication was prescribed.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="is-prescribed" type="boolean">
          <annotation>
            <documentation>
              <summary>
                                True if medication was prescribed.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="indication" type="string">
          <annotation>
            <documentation>
              <summary>
                                Free form indication for medication.
                        </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="amount-prescribed" type="string">
          <annotation>
            <documentation>
              <summary>
                                Free form amount prescribed for medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="dose-value" type="med:DoseValue">
          <annotation>
            <documentation>
              <summary>
                                Doses of medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="dose-unit" type="t:codable-value">
          <annotation>
            <documentation>
              <summary>
                                Dose unit of medication.
                            </summary>
              <preferred-vocabulary>medication-dose-units</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="strength-value" type="t:nonNegativeInt">
          <annotation>
            <documentation>
              <summary>
                                Strength of medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="strength-unit" type="t:codable-value">
          <annotation>
            <documentation>
              <summary>
                                Free form strength unit of medication.
                            </summary>
              <preferred-vocabulary>medication-strength-unit</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="frequency" type="string">
          <annotation>
            <documentation>
              <summary>
                                Free form frequency of medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="route" type="t:codable-value">
          <annotation>
            <documentation>
              <summary>
                                Route of medication.
                            </summary>
              <preferred-vocabulary>medication-routes</preferred-vocabulary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="duration" type="string">
          <annotation>
            <documentation>
              <summary>
                                Free form duration of medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="duration-unit" type="t:codable-value">
          <annotation>
            <documentation>
              <summary>
                                Free form duration units of medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="refills" type="t:nonNegativeInt">
          <annotation>
            <documentation>
              <summary>
                                Number of medication refills.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="refills-left" type="t:nonNegativeInt">
          <annotation>
            <documentation>
              <summary>
                                Number of medication refills left.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="days-supply" type="t:nonNegativeInt">
          <annotation>
            <documentation>
              <summary>
                                Number of days supply of medication.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="prescription-duration" type="t:duration-value">
          <annotation>
            <documentation>
              <summary>
                                Duration of prescription.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="instructions" type="string">
          <annotation>
            <documentation>
              <summary>
                                Free form medication instructions.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="substitution-permitted" type="boolean">
          <annotation>
            <documentation>
              <summary>
                                True of substitution is permitted.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="pharmacy" type="t:contact">
          <annotation>
            <documentation>
              <summary>
                                Pharmacy.
                            </summary>
            </documentation>
          </annotation>
        </element>
        <element minOccurs="0" name="prescription-number" type="string">
          <annotation>
            <documentation>
              <summary>
                                Free form prescription number.
                            </summary>
            </documentation>
          </annotation>
        </element>
      </sequence>
    </complexType>
  </element>
</schema>


Columns

Columns describe this type in the STT and MTT transformations.

Columns
TagLabelTypeWidth
nameNameString100
dose-valueDoseString100
strength-valueStrengthString100
frequencyFrequencyString100
routeRouteString100
refills-leftRefills LeftString100
instructionsInstructionsString100
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