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

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

: eRSD PlanDefinition Instance NamedEvent Example - JSON Representation

Active as of 2020-12-01

Raw json | Download

{
  "resourceType" : "PlanDefinition",
  "id" : "plandefinition-ersd-instance-namedEvent-example",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: PlanDefinition plandefinition-ersd-instance-namedEvent-example</b></p><a name=\"plandefinition-ersd-instance-namedEvent-example\"> </a><a name=\"hcplandefinition-ersd-instance-namedEvent-example\"> </a><a name=\"plandefinition-ersd-instance-namedEvent-example-en-US\"> </a><p><b>url</b>: <a href=\"PlanDefinition-plandefinition-ersd-instance-namedEvent-example.html\">PlanDefinition eRSD PlanDefinition Instance NamedEvent 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 \r\n\r\nThis 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: \r\n\r\nNote 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.\r\n\r\nThis 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.1</p><p><b>version</b>: 2.1.2</p><p><b>name</b>: PlanDefinition_eRSD_Instance_namedEvent_Example</p><p><b>title</b>: eRSD PlanDefinition Instance NamedEvent 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-12-01 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>This PlanDefinition is a simplified duplicate of the eRSD PlanDefinition Instance created for the purposes of demonstrating by example the usage of the US Public Health Named Event extension.</p>\n</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><blockquote><p><b>action</b></p><blockquote><p><b>id</b></p>start-workflow</blockquote><p><b>description</b>: This action represents the start of the reporting workflow in response to the encounter-start event</p><p><b>textEquivalent</b>: Start the reporting workflow in response to an encounter-start event</p><p><b>code</b>: <span title=\"Codes:{http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions initiate-reporting-workflow}\">Initiate a reporting workflow</span></p><blockquote><p><b>trigger</b></p><blockquote><p><b>id</b></p>encounter-start</blockquote><p><b>US Public Health Named Event Type Extension</b>: <span title=\"Codes:{http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-triggerdefinition-namedevents encounter-start}\">Indicates the start of an encounter</span></p><p><b>type</b>: Named Event</p><p><b>name</b>: encounter-start</p></blockquote></blockquote></div>"
  },
  "url" : "http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-namedEvent-example",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.46.34.1"
    }
  ],
  "version" : "2.1.2",
  "name" : "PlanDefinition_eRSD_Instance_namedEvent_Example",
  "title" : "eRSD PlanDefinition Instance NamedEvent Example",
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code" : "workflow-definition",
        "display" : "Workflow Definition"
      }
    ]
  },
  "status" : "active",
  "experimental" : true,
  "date" : "2020-12-01T12:32:29.858-05:00",
  "publisher" : "HL7 International / Public Health",
  "contact" : [
    {
      "name" : "HL7 International / Public Health",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "This PlanDefinition is a simplified duplicate of the eRSD PlanDefinition Instance created for the purposes of demonstrating by example the usage of the US Public Health Named Event extension.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ],
      "text" : "United States of America"
    }
  ],
  "effectivePeriod" : {
    "start" : "2020-12-01"
  },
  "action" : [
    {
      "id" : "start-workflow",
      "description" : "This action represents the start of the reporting workflow in response to the encounter-start event",
      "textEquivalent" : "Start the reporting workflow in response to an encounter-start event",
      "code" : [
        {
          "coding" : [
            {
              "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions",
              "code" : "initiate-reporting-workflow",
              "display" : "Initiate a reporting workflow"
            }
          ]
        }
      ],
      "trigger" : [
        {
          "id" : "encounter-start",
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-triggerdefinition-namedevents",
                    "code" : "encounter-start",
                    "display" : "Indicates the start of an encounter"
                  }
                ]
              }
            }
          ],
          "type" : "named-event",
          "name" : "encounter-start"
        }
      ]
    }
  ]
}