HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: US Public Health PlanDefinition Example - XML Representation

Active as of 2020-07-31

Raw xml | Download


<PlanDefinition xmlns="http://hl7.org/fhir">
  <id value="plandefinition-us-public-health-example"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: PlanDefinition plandefinition-us-public-health-example</b></p><a name="plandefinition-us-public-health-example"> </a><a name="hcplandefinition-us-public-health-example"> </a><a name="plandefinition-us-public-health-example-en-US"> </a><p><b>US Public Health Receiver Address Extension</b>: <a href="Endpoint-endpoint-ecr-ymca.html">Endpoint: status = active; connectionType = HL7 FHIR (Endpoint Connection Type#hl7-fhir-rest); payloadType = ; address = http://example.org/ymca/fhir</a></p><p><b>url</b>: <a href="PlanDefinition-plandefinition-us-public-health-example.html">PlanDefinition PlanDefinition US Public Health Example</a></p><p><b>identifier</b>: <a href="http://terminology.hl7.org/6.0.2/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt 

This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: 

Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.

This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:oid:2.16.840.1.113883.4.642.40.46.34.2</p><p><b>version</b>: 2.1.2</p><p><b>name</b>: PlanDefinitionUSPublicHealthExample</p><p><b>title</b>: PlanDefinition US Public Health Example</p><p><b>type</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/plan-definition-type workflow-definition}">Workflow Definition</span></p><p><b>status</b>: Active</p><p><b>experimental</b>: true</p><p><b>date</b>: 2020-07-31 12:32:29-0500</p><p><b>publisher</b>: HL7 International / Public Health</p><p><b>contact</b>: HL7 International / Public Health: <a href="http://www.hl7.org/Special/committees/pher">http://www.hl7.org/Special/committees/pher</a></p><p><b>description</b>: </p><div><p>An example US Public Health PlanDefinition</p>
</div><p><b>jurisdiction</b>: <span title="Codes:{urn:iso:std:iso:3166 US}">United States of America</span></p><p><b>effectivePeriod</b>: 2020-12-01 --&gt; (ongoing)</p><p><b>library</b>: <a href="Bundle-bundle-ersd-supplemental-example.html">Rule Filtersversion: null2.1.0)</a></p></div>
  </text>
  <extension
             url="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension">
    <valueReference>🔗 
      <reference value="Endpoint/endpoint-ecr-ymca"/>
    </valueReference>
  </extension>
  <url
       value="http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-us-public-health-example"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.46.34.2"/>
  </identifier>
  <version value="2.1.2"/>
  <name value="PlanDefinitionUSPublicHealthExample"/>
  <title value="PlanDefinition US Public Health Example"/>
  <type>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
      <code value="workflow-definition"/>
      <display value="Workflow Definition"/>
    </coding>
  </type>
  <status value="active"/>
  <experimental value="true"/>
  <date value="2020-07-31T12:32:29.858-05:00"/>
  <publisher value="HL7 International / Public Health"/>
  <contact>
    <name value="HL7 International / Public Health"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <description value="An example US Public Health PlanDefinition"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
    <text value="United States of America"/>
  </jurisdiction>
  <effectivePeriod>
    <start value="2020-12-01"/>
  </effectivePeriod>
  <library value="http://hl7.org/fhir/us/ecr/Library/RuleFilters|2.1.0"/>
</PlanDefinition>