Patient Cost Transparency Implementation Guide
2.0.0 - STU 2 United States of America flag

This page is part of the Da Vinci Patient Cost Transparency Implementation Guide (v2.0.0: 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

: SubscriptionTopic - GFE Available for Subject Notification - JSON Representation

Page standards status: Trial-use Maturity Level: 2

Raw json | Download

{
  "resourceType" : "SubscriptionTopic",
  "id" : "davinci-pct-gfe-available-subject-notification",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: SubscriptionTopic davinci-pct-gfe-available-subject-notification</b></p><a name=\"davinci-pct-gfe-available-subject-notification\"> </a><a name=\"hcdavinci-pct-gfe-available-subject-notification\"> </a><table class=\"grid\"><tr><td><b>SubscriptionTopic</b></td><td>SubscriptionTopic - GFE Available for Subject Notification</td></tr><tr><td><b>Description</b></td><td><div><p>Subject focused Subscription Topic for when a Good Faith Estimate (GFE) Packet DocumentReference is created or updated (for FHIR R4). This represents that an GFE Packet, either contained in or referred to by the DocumentReference has been newly created and is available or has been updated, should updates be made.</p>\n<p><strong>Canonical URL:</strong> http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-subject-notification</p>\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>Criteria</b></th><th><b>Description</b></th></tr><tr><td><a href=\"http://hl7.org/fhir/R4/documentreference.html\">http://hl7.org/fhir/StructureDefinition/DocumentReference</a></td><td>create, update</td><td><div><ul>\n<li>create result = test-passes</li>\n<li>current = type=gfe-packet</li>\n<li>require both = false</li>\n</ul>\n</div></td><td><div><p>Triggered when an GFE Packet DocumentReference is created or updated</p>\n</div></td></tr></table><table class=\"grid\"><tr><td colspan=\"4\"><b>Can Filter By</b></td></tr><tr><th><b>Resource</b></th><th><b>Filter Parameter</b></th><th><b>Filter Definition</b></th><th><b>Comparators</b></th></tr><tr><td><a href=\"http://hl7.org/fhir/R4/documentreference.html\">http://hl7.org/fhir/StructureDefinition/DocumentReference</a></td><td>subject</td><td><a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-subject\">subject</a></td><td>Equals</td></tr><tr><td><a href=\"http://hl7.org/fhir/R4/documentreference.html\">http://hl7.org/fhir/StructureDefinition/DocumentReference</a></td><td>status</td><td><a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-status\">status</a></td><td>Equals</td></tr><tr><td><a href=\"http://hl7.org/fhir/R4/documentreference.html\">http://hl7.org/fhir/StructureDefinition/DocumentReference</a></td><td>doc-status</td><td><a href=\"SearchParameter-DocumentReference-doc-status.html\">DocumentReferenceDocStatus</a></td><td>Equals</td></tr></table><table class=\"grid\"><tr><td colspan=\"1\"><b>Notification Shapes</b></td></tr><tr><th><b>Resource</b></th></tr><tr><td><a href=\"http://hl7.org/fhir/R4/documentreference.html\">http://hl7.org/fhir/StructureDefinition/DocumentReference</a></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fm"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-pct/ImplementationGuide/hl7.fhir.us.davinci-pct"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-pct/ImplementationGuide/hl7.fhir.us.davinci-pct"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-subject-notification",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.4.44.4"
    }
  ],
  "version" : "2.0.0",
  "name" : "PCTGFEAvailableSubjectSubscriptionTopic",
  "title" : "SubscriptionTopic - GFE Available for Subject Notification",
  "status" : "active",
  "experimental" : false,
  "date" : "2025-04-05",
  "publisher" : "HL7 International / Financial Management",
  "contact" : [
    {
      "name" : "HL7 International / Financial Management",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fm"
        },
        {
          "system" : "email",
          "value" : "fmlists@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "Subject focused Subscription Topic for when a Good Faith Estimate (GFE) Packet DocumentReference is created or updated (for FHIR R4). This represents that an GFE Packet, either contained in or referred to by the DocumentReference has been newly created and is available or has been updated, should updates be made.\n\r**Canonical URL:** http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-subject-notification",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "resourceTrigger" : [
    {
      "description" : "Triggered when an GFE Packet DocumentReference is created or updated",
      "resource" : "http://hl7.org/fhir/StructureDefinition/DocumentReference",
      "supportedInteraction" : [
        "create",
        "update"
      ],
      "queryCriteria" : {
        "resultForCreate" : "test-passes",
        "current" : "type=gfe-packet",
        "resultForDelete" : "test-passes",
        "requireBoth" : false
      }
    }
  ],
  "canFilterBy" : [
    {
      "description" : "Filter based on the subject of a DocumentReference.",
      "resource" : "DocumentReference",
      "filterParameter" : "subject",
      "filterDefinition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
      "comparator" : [
        "eq"
      ]
    },
    {
      "description" : "Filter based on the status (current | superseded | entered-in-error) of a DocumentReference.",
      "resource" : "DocumentReference",
      "filterParameter" : "status",
      "filterDefinition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
      "comparator" : [
        "eq"
      ]
    },
    {
      "description" : "Filter based on the document status (registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown) of a DocumentReference.",
      "resource" : "DocumentReference",
      "filterParameter" : "doc-status",
      "filterDefinition" : "http://hl7.org/fhir/us/davinci-pct/SearchParameter/DocumentReference-doc-status",
      "comparator" : [
        "eq"
      ]
    }
  ],
  "notificationShape" : [
    {
      "resource" : "DocumentReference"
    }
  ]
}