Medication

Return to types list

Type Properties

Properties Property Value id 5c5f1223-f63c-4464-870c-3e36ba471def name Medication uncreatable false immutable false singleton false transforms form, mtt, stt, upversion allow-readonly true

Type Details

medication  Information related to a medication. Name Type IsRequired Description name string No Name of medication. code t:nonNegativeInt No Clinical code for medication. date-discontinued d:approx-date-time No Date medication was discontinued. date-filled d:approx-date-time No Date medication prescription was filled. date-prescribed d:approx-date-time No Date medication was prescribed. is-prescribed boolean No True if medication was prescribed. indication string No Free form indication for medication. amount-prescribed string No Free form amount prescribed for medication. dose-value med:DoseValue No Doses of medication. dose-unit t:codable-value No Dose unit of medication. strength-value t:nonNegativeInt No Strength of medication. strength-unit t:codable-value No Free form strength unit of medication. frequency string No Free form frequency of medication. route t:codable-value No Route of medication. duration string No Free form duration of medication. duration-unit t:codable-value No Free form duration units of medication. refills t:nonNegativeInt No Number of medication refills. refills-left t:nonNegativeInt No Number of medication refills left. days-supply t:nonNegativeInt No Number of days supply of medication. prescription-duration t:duration-value No Duration of prescription. instructions string No Free form medication instructions. substitution-permitted boolean No True of substitution is permitted. pharmacy t:contact No Pharmacy. prescription-number string No Free form prescription number.

DoseValue  Defines a medication dosage. Name Type IsRequired Description description string No Free form text describing the dose that should be taken. exact-dose t:positiveDouble No The dose value as an exact dose value. The dosage to be taken is exactly specified. min-dose t:positiveDouble No The 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-dose t:positiveDouble No The 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 (meaning2 capsules, 2 tablets, etc.), or it may be a range, like1/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 betaken.</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 rangewith this value indicating the minimum dosagethat 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 rangewith this value indicating the maximum dosagethat 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 Tag Label Type Width name Name String 100 dose-value Dose String 100 strength-value Strength String 100 frequency Frequency String 100 route Route String 100 refills-left Refills Left String 100 instructions Instructions String 100 wc-id ID String 50 wc-version Version Stamp String 50 wc-note Note String 100 wc-tags Tags String 100 wc-date Effective Date DateTime 50 wc-type Type Name String 50 wc-typeid Type ID String 50 wc-source Source String 100 wc-brands Brands String 100 wc-relatedthings Related Items String 100 wc-ispersonal Is Personal Boolean 40 wc-audit-personname Changed by String 100 wc-audit-date Date DateTime 100 wc-audit-action Action String 100 wc-audit-appname App String 100 wc-issigned Signed Boolean 50 wc-isdownversioned Down Versioned Boolean 50 wc-isupversioned Up Versioned Boolean 50 wc-state Item State String 50