Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: OhhSubscription - JSON Profile

Active as of 2025-12-03

JSON representation of the ohh-subscription resource profile.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "ohh-subscription",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition ohh-subscription</b></p><a name=\"ohh-subscription\"> </a><a name=\"hcohh-subscription\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ohh-subscription-definitions.html#Subscription\">Subscription</a><a name=\"Subscription\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Server push subscription criteria</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ohh-subscription-definitions.html#Subscription.criteria\">criteria</a><a name=\"Subscription.criteria\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( ohh-subscription-criteria )\">C</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Rule for server push</span><br class=\"constraint\"/><span title=\"null\" class=\"constraint\">Constraints: </span><span style=\"font-weight:bold\" title=\"Criteria can only be on QuestionnaireResponse, PlanDefinition, or CarePlan\" class=\"constraint\">ohh-subscription-criteria</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ohh-subscription-definitions.html#Subscription.channel\">channel</a><a name=\"Subscription.channel\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ohh-subscription-definitions.html#Subscription.channel.type\">type</a><a name=\"Subscription.channel.type\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">rest-hook | websocket | email | sms | message</span><br/><span style=\"font-weight:bold\">Fixed Value: </span><span style=\"color: darkgreen\">rest-hook</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "url" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription",
      "version" : "0.1.0",
      "name" : "OhhSubscription",
      "title" : "OHH Subscription Profile",
      "status" : "active",
      "date" : "2025-12-03T12:00:57+00:00",
      "publisher" : "Open Health Hub",
      "contact" : [
        {
          "name" : "Open Health Hub",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.openhealthhub.com"
            },
            {
              "system" : "email",
              "value" : "support@openhealthhub.com"
            }
          ]
        }
      ],
      "description" : "Subscriptions are used to trigger a webhook request when a resource that matches the criteria has been created or updated.",
      "fhirVersion" : "4.0.1",
      "mapping" : [
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        },
        {
          "identity" : "w5",
          "uri" : "http://hl7.org/fhir/fivews",
          "name" : "FiveWs Pattern Mapping"
        }
      ],
      "kind" : "resource",
      "abstract" : false,
      "type" : "Subscription",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Subscription",
      "derivation" : "constraint",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "4.0.1"
          }
        ],
        "element" : [
          {
            "id" : "Subscription",
            "path" : "Subscription",
            "short" : "Server push subscription criteria",
            "definition" : "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.",
            "alias" : [
              "WebHook",
              "Hook",
              "Routing Rule"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Subscription",
              "min" : 0,
              "max" : "*"
            },
            "constraint" : [
              {
                "key" : "dom-2",
                "severity" : "error",
                "human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
                "expression" : "contained.contained.empty()",
                "xpath" : "not(parent::f:contained and f:contained)",
                "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
              },
              {
                "key" : "dom-3",
                "severity" : "error",
                "human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
                "expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
                "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
                "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
              },
              {
                "key" : "dom-4",
                "severity" : "error",
                "human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
                "expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
                "xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
                "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
              },
              {
                "key" : "dom-5",
                "severity" : "error",
                "human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
                "expression" : "contained.meta.security.empty()",
                "xpath" : "not(exists(f:contained/*/f:meta/f:security))",
                "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
              },
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
                    "valueBoolean" : true
                  },
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
                    "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
                  }
                ],
                "key" : "dom-6",
                "severity" : "warning",
                "human" : "A resource should have narrative for robust management",
                "expression" : "text.`div`.exists()",
                "xpath" : "exists(f:text/h:div)",
                "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "Entity. Role, or Act"
              },
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Subscription.id",
            "path" : "Subscription.id",
            "short" : "Logical id of this artifact",
            "definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
            "comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Resource.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "id"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          },
          {
            "id" : "Subscription.meta",
            "path" : "Subscription.meta",
            "short" : "Metadata about the resource",
            "definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Resource.meta",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Meta"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          },
          {
            "id" : "Subscription.implicitRules",
            "path" : "Subscription.implicitRules",
            "short" : "A set of rules under which this content was created",
            "definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
            "comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Resource.implicitRules",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "uri"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : true,
            "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
            "isSummary" : true
          },
          {
            "id" : "Subscription.language",
            "path" : "Subscription.language",
            "short" : "Language of the resource content",
            "definition" : "The base language in which the resource is written.",
            "comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Resource.language",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "binding" : {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
                  "valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
                },
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                  "valueString" : "Language"
                }
              ],
              "strength" : "preferred",
              "description" : "A human language.",
              "valueSet" : "http://hl7.org/fhir/ValueSet/languages|4.0.1"
            }
          },
          {
            "id" : "Subscription.text",
            "path" : "Subscription.text",
            "short" : "Text summary of the resource, for human interpretation",
            "definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
            "comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
            "alias" : [
              "narrative",
              "html",
              "xhtml",
              "display"
            ],
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "DomainResource.text",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Narrative"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "Act.text?"
              }
            ]
          },
          {
            "id" : "Subscription.contained",
            "path" : "Subscription.contained",
            "short" : "Contained, inline Resources",
            "definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
            "comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
            "alias" : [
              "inline resources",
              "anonymous resources",
              "contained resources"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "DomainResource.contained",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Resource"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Subscription.extension",
            "path" : "Subscription.extension",
            "short" : "Additional content defined by implementations",
            "definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
            "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
            "alias" : [
              "extensions",
              "user content"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "DomainResource.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Subscription.modifierExtension",
            "path" : "Subscription.modifierExtension",
            "short" : "Extensions that cannot be ignored",
            "definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
            "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
            "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
            "alias" : [
              "extensions",
              "user content"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "DomainResource.modifierExtension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : true,
            "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Subscription.status",
            "path" : "Subscription.status",
            "short" : "requested | active | error | off",
            "definition" : "The status of the subscription, which marks the server state for managing the subscription.",
            "comment" : "A client can only submit subscription resources in the requested or off state. Only the server can  move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Subscription.status",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : true,
            "isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
            "isSummary" : true,
            "binding" : {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                  "valueString" : "SubscriptionStatus"
                }
              ],
              "strength" : "required",
              "description" : "The status of a subscription.",
              "valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|4.0.1"
            },
            "mapping" : [
              {
                "identity" : "w5",
                "map" : "FiveWs.status"
              }
            ]
          },
          {
            "id" : "Subscription.contact",
            "path" : "Subscription.contact",
            "short" : "Contact details for source (e.g. troubleshooting)",
            "definition" : "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Subscription.contact",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "ContactPoint"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true,
            "mapping" : [
              {
                "identity" : "w5",
                "map" : "FiveWs.subject[x]"
              },
              {
                "identity" : "w5",
                "map" : "FiveWs.subject"
              }
            ]
          },
          {
            "id" : "Subscription.end",
            "path" : "Subscription.end",
            "short" : "When to automatically delete the subscription",
            "definition" : "The time for the server to turn the subscription off.",
            "comment" : "The server is permitted to deviate from this time but should observe it.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Subscription.end",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "instant"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true,
            "mapping" : [
              {
                "identity" : "w5",
                "map" : "FiveWs.done[x]"
              }
            ]
          },
          {
            "id" : "Subscription.reason",
            "path" : "Subscription.reason",
            "short" : "Description of why this subscription was created",
            "definition" : "A description of why this subscription is defined.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Subscription.reason",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true,
            "mapping" : [
              {
                "identity" : "w5",
                "map" : "FiveWs.why[x]"
              }
            ]
          },
          {
            "id" : "Subscription.criteria",
            "path" : "Subscription.criteria",
            "short" : "Rule for server push",
            "definition" : "The rules that the server should use to determine when to generate notifications for this subscription.",
            "comment" : "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Subscription.criteria",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ohh-subscription-criteria",
                "severity" : "error",
                "human" : "Criteria can only be on QuestionnaireResponse, PlanDefinition, or CarePlan",
                "expression" : "matches('^(QuestionnaireResponse|PlanDefinition|CarePlan).*')",
                "source" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          },
          {
            "id" : "Subscription.error",
            "path" : "Subscription.error",
            "short" : "Latest error note",
            "definition" : "A record of the last error that occurred when the server processed a notification.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Subscription.error",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          },
          {
            "id" : "Subscription.channel",
            "path" : "Subscription.channel",
            "short" : "The channel on which to report matches to the criteria",
            "definition" : "Details where to send notifications when resources are received that meet the criteria.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Subscription.channel",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "BackboneElement"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          },
          {
            "id" : "Subscription.channel.id",
            "path" : "Subscription.channel.id",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "Unique id for inter-element referencing",
            "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "string"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Subscription.channel.extension",
            "path" : "Subscription.channel.extension",
            "short" : "Additional content defined by implementations",
            "definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
            "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
            "alias" : [
              "extensions",
              "user content"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Subscription.channel.modifierExtension",
            "path" : "Subscription.channel.modifierExtension",
            "short" : "Extensions that cannot be ignored even if unrecognized",
            "definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
            "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
            "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
            "alias" : [
              "extensions",
              "user content",
              "modifiers"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "BackboneElement.modifierExtension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : true,
            "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
            "isSummary" : true,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Subscription.channel.type",
            "path" : "Subscription.channel.type",
            "short" : "rest-hook | websocket | email | sms | message",
            "definition" : "The type of channel to send notifications on.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Subscription.channel.type",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "fixedCode" : "rest-hook",
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true,
            "binding" : {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                  "valueString" : "SubscriptionChannelType"
                }
              ],
              "strength" : "required",
              "description" : "The type of method used to execute a subscription.",
              "valueSet" : "http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1"
            }
          },
          {
            "id" : "Subscription.channel.endpoint",
            "path" : "Subscription.channel.endpoint",
            "short" : "Where the channel points to",
            "definition" : "The url that describes the actual end-point to send messages to.",
            "comment" : "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Subscription.channel.endpoint",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "url"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          },
          {
            "id" : "Subscription.channel.payload",
            "path" : "Subscription.channel.payload",
            "short" : "MIME type to send, or omit for no payload",
            "definition" : "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type \"text/plain\" may also be used for Email and SMS subscriptions.",
            "comment" : "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Subscription.channel.payload",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true,
            "binding" : {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                  "valueString" : "MimeType"
                }
              ],
              "strength" : "required",
              "description" : "The mime type of an attachment. Any valid mime type is allowed.",
              "valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
            }
          },
          {
            "id" : "Subscription.channel.header",
            "path" : "Subscription.channel.header",
            "short" : "Usage depends on the channel type",
            "definition" : "Additional headers / information to send as part of the notification.",
            "comment" : "Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Subscription.channel.header",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : true
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "Subscription",
            "path" : "Subscription"
          },
          {
            "id" : "Subscription.criteria",
            "path" : "Subscription.criteria",
            "constraint" : [
              {
                "key" : "ohh-subscription-criteria",
                "severity" : "error",
                "human" : "Criteria can only be on QuestionnaireResponse, PlanDefinition, or CarePlan",
                "expression" : "matches('^(QuestionnaireResponse|PlanDefinition|CarePlan).*')",
                "source" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription"
              }
            ]
          },
          {
            "id" : "Subscription.channel.type",
            "path" : "Subscription.channel.type",
            "fixedCode" : "rest-hook"
          }
        ]
      }
    }