Document Subscription for Mobile (DSUBm)
1.0.1-current - ci-build International flag

Document Subscription for Mobile (DSUBm), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.DSUBm/ and changes regularly. See the Directory of published versions

: SubscriptionTopic for DocumentReference Multi-Patient resource with DocumentReference Subscription for Minimal Update Option - JSON Representation

Active as of 2024-07-08

Raw json | Download


{
  "resourceType" : "SubscriptionTopic",
  "id" : "DSUBm-SubscriptionTopic-DocReference-MultiPatient-MinUpdate",
  "meta" : {
    "versionId" : "1"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: SubscriptionTopic DSUBm-SubscriptionTopic-DocReference-MultiPatient-MinUpdate</b></p><a name=\"DSUBm-SubscriptionTopic-DocReference-MultiPatient-MinUpdate\"> </a><a name=\"hcDSUBm-SubscriptionTopic-DocReference-MultiPatient-MinUpdate\"> </a><a name=\"hcDSUBm-SubscriptionTopic-DocReference-MultiPatient-MinUpdate-en-US\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">version: versionId: id (PrimitiveType/SubscriptionTopic.meta.versionId): native = id -&gt; 1</p></div><table class=\"grid\"><tr><td><b>SubscriptionTopic</b></td><td>SubscriptionTopic for DocumentReference Multi-Patient resource with DocumentReference Subscription for Minimal Update Option</td></tr><tr><td><b>Description</b></td><td><div><p>Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription.\nThis topic SHALL be used in all DocumentReference subscriptions that have not a specific patient in the criteria element.\nNote that:</p>\n<ul>\n<li>the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used)</li>\n<li>the resourceTrigger.resource element SHALL be a DocumentReference resource</li>\n<li>the canFilterBy.filterParameter does not include the patient and patient.identifier parameters</li>\n<li>this resource SHALL be used when the &quot;DocumentReference Subscription for Minimal Update Option&quot; is supported</li>\n<li>the events are creation, deletion and update only in the &quot;status&quot; of a DocumentReference</li>\n</ul>\n</div></td></tr><tr><td><b>Copyright Statement:</b></td><td> null</td></tr></table><table class=\"grid\"><tr><td colspan=\"4\"><b>Resource Triggers</b></td></tr><tr><th><b>Resource</b></th><th><b>Interactions</b></th><th><b>Description</b></th><th><b>FHIR Path</b></th></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>create, delete</td><td><div><p>A DocumentReference resource is created or deleted.</p>\n</div></td><td/></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>update</td><td><div><p>A DocumentReference resource is updated only in the &quot;status&quot;.</p>\n</div></td><td>(%previous.status != %current.status)</td></tr></table><table class=\"grid\"><tr><td colspan=\"2\"><b>Can Filter By</b></td></tr><tr><th><b>Resource</b></th><th><b>Filter Parameter</b></th></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>author</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>category</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>event</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>facility</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>format</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>security-label</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>setting</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>status</td></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>type</td></tr></table><table class=\"grid\"><tr><td colspan=\"2\"><b>Notification Shapes</b></td></tr><tr><th><b>Resource</b></th><th><b>Includes</b></th></tr><tr><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference</a></td><td>DocumentReference:subject</td></tr></table></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-MinUpdate",
  "version" : "1.0.1-current",
  "title" : "SubscriptionTopic for DocumentReference Multi-Patient resource with DocumentReference Subscription for Minimal Update Option",
  "status" : "active",
  "date" : "2024-07-08T16:22:32+00:00",
  "publisher" : "IHE IT Infrastructure Technical Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "IHE IT Infrastructure Technical Committee",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription.\nThis topic SHALL be used in all DocumentReference subscriptions that have not a specific patient in the criteria element.\nNote that:\n- the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used)\n- the resourceTrigger.resource element SHALL be a DocumentReference resource\n- the canFilterBy.filterParameter does not include the patient and patient.identifier parameters\n- this resource SHALL be used when the \"DocumentReference Subscription for Minimal Update Option\" is supported\n- the events are creation, deletion and update only in the \"status\" of a DocumentReference\n",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "resourceTrigger" : [
    {
      "description" : "A DocumentReference resource is created or deleted.",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "supportedInteraction" : [
        "create",
        "delete"
      ]
    },
    {
      "description" : "A DocumentReference resource is updated only in the \"status\".",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "supportedInteraction" : [
        "update"
      ],
      "fhirPathCriteria" : "(%previous.status != %current.status)"
    }
  ],
  "canFilterBy" : [
    {
      "description" : "Filter based on the author of an DocumentReference. (DocumentEntry.author)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "author"
    },
    {
      "description" : "Filter based on the event of a DocumentReference. (DocumentEntry.class)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "category"
    },
    {
      "description" : "Filter based on the status of a DocumentReference. (DocumentEntry.eventCodeList)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "event"
    },
    {
      "description" : "Filter based on the facility in which the DocumentReference has been compiled. (DocumentEntry.healthcareFacilityTypeCode)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "facility"
    },
    {
      "description" : "Filter based on the format of the DocumentReference . (DocumentEntry.formatCode)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "format"
    },
    {
      "description" : "Filter based on the security-label of the DocumentReference (DocumentEntry.confidentialityCode)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "security-label"
    },
    {
      "description" : "Filter based on the practice setting of the DocumentReference (practiceSetting)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "setting"
    },
    {
      "description" : "Filter based on the status of the DocumentReference (DocumentEntry.availabilityStatus)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "status"
    },
    {
      "description" : "Filter based on the type of a DocumentReference. (DocumentReference.type)",
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "filterParameter" : "type"
    }
  ],
  "notificationShape" : [
    {
      "resource" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference",
      "include" : [
        "DocumentReference:subject"
      ]
    }
  ]
}