Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

Sc-valueset-care-plan-activity-status.json

Example StructureDefinition/valueset-reference (XML)

Patient Care Vocabulary Work Group Maturity Level : N/A Standards Status : Informative

Raw JSON XML ( canonical form + also see JSON XML Format Specification )

Canonical Mapping for "CarePlanActivityStatus" reference

{ "resourceType" : "ConceptMap", "id" : "sc-care-plan-activity-status", "text" : { "status" : "generated", "div" : "<div>!-- Snipped for Brevity --></div>" }, "url" : "http://hl7.org/fhir/ConceptMap/sc-care-plan-activity-status", "version" : "4.0.1", "name" : "CarePlanActivityStatusCanonicalMap", "title" : "Canonical Mapping for \"CarePlanActivityStatus\"", "status" : "draft", "date" : "2019-11-01T09:29:23+11:00", "publisher" : "HL7 (FHIR Project)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }, { "system" : "email", "value" : "fhir@lists.hl7.org" }] }], "description" : "Canonical Mapping for \"Codes that reflect the current state of a care plan activity within its overall life cycle.\"", "sourceCanonical" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status", "targetCanonical" : "http://hl7.org/fhir/ValueSet/resource-status", "group" : [{ "source" : "http://hl7.org/fhir/care-plan-activity-status", "target" : "http://hl7.org/fhir/resource-status", "element" : [{ "code" : "entered-in-error", "target" : [{ "code" : "error", "equivalence" : "equivalent" }] }, { "code" : "not-started", "target" : [{ "code" : "draft", "equivalence" : "equivalent" }] }, { "code" : "scheduled", "target" : [{ "code" : "accepted", "equivalence" : "equivalent" }] }, { "code" : "in-progress", "target" : [{ "code" : "active", "equivalence" : "equivalent" }] }, { "code" : "on-hold", "target" : [{ "code" : "suspended", "equivalence" : "equivalent" }] }, { "code" : "stopped", "target" : [{ "code" : "failed", "equivalence" : "equivalent" }] }, { "code" : "completed", "target" : [{ "code" : "complete", "equivalence" : "equivalent" }] }, { "code" : "cancelled", "target" : [{ "code" : "abandoned", "equivalence" : "equivalent" }] }, { "code" : "unknown", "target" : [{ "code" : "unknown", "equivalence" : "equivalent" }] }] }] }
<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="valueset-reference"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/valueset-reference"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.5.1206"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="reference"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2020-12-28T16:55:11+11:00"/> 
  <publisher value="HL7"/> 
  <description value="A logical reference (e.g. a reference to ValueSet.url) that identifies the value

   set/version that identifies the set of possible coded values this coding was chosen
   from or constrained by."/> 
  <fhirVersion value="5.0.0"/> 
  <mapping> 
    <identity value="v2"/> 
    <uri value="http://hl7.org/v2"/> 
    <name value="HL7 v2 Mapping"/> 
  </mapping> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <context> 
    <type value="element"/> 
    <expression value="Coding"/> 
  </context> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Url of Value set the code was chosen from"/> 
      <definition value="A logical reference (e.g. a reference to ValueSet.url) that identifies the value

       set/version that identifies the set of possible coded values this coding was chosen
       from or constrained by."/> 
      <comment value="If this extension is used with an [extensible binding](terminologies.html#extensible),

       and the concept comes from outside the bound valueset, the value set SHALL be different
       from the bound valueset."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="CWE."/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="CD.valueSet/CD.valueSetVersion"/> 
      </mapping> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may

       be any string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="The definition may point directly to a computable or human-readable definition

       of the extensibility codes, or it may be a logical URI as declared in some other
       specification. The definition SHALL be a URI for the Structure Definition defining
       the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="uri"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-reference"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](

      extensibility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="uri"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Url of Value set the code was chosen from"/> 
      <definition value="A logical reference (e.g. a reference to ValueSet.url) that identifies the value

       set/version that identifies the set of possible coded values this coding was chosen
       from or constrained by."/> 
      <comment value="If this extension is used with an [extensible binding](terminologies.html#extensible),

       and the concept comes from outside the bound valueset, the value set SHALL be different
       from the bound valueset."/> 
      <min value="0"/> 
      <max value="1"/> 
      <isModifier value="false"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="CWE."/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="CD.valueSet/CD.valueSetVersion"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-reference"/> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="uri"/> 
      </type> 
    </element> 
  </differential> 

</

StructureDefinition

>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.