FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/backport-payload-content

Packagehl7.fhir.uv.subscriptions-backport
Resource TypeStructureDefinition
Idbackport-payload-content
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/uv/subscriptions-backport/https://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-payload-content.html
URLhttp://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Version1.2.0-ballot
Statusactive
Date2024-06-17T16:09:47+00:00
NameBackportPayloadContent
TitleBackport R5 Subscription Payload Content Information
Realmuv
Authorityhl7
DescriptionHow much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
TypeExtension
Kindcomplex-type

Resources that use this resource

StructureDefinition
profile-subscriptionPAS Subscription
davinci-pct-aeob-available-author-subscriptionSubscription - AEOB Available for Author Notification
davinci-pct-aeob-available-subject-subscriptionSubscription - AEOB Available for Subject Notification
davinci-pct-gfe-available-author-subscriptionSubscription - GFE Available for Author Notification
davinci-pct-gfe-available-subject-subscriptionSubscription - GFE Available for Subject Notification
davinci-pct-gfe-task-update-subscriptionSubscription - GFE Coordination Task Update Notification
backport-subscriptionR4/B Topic-Based Subscription

Resources that this resource uses

ValueSet
backport-content-value-setBackported R5 Subscription Content Value Set

Examples of Use for Extension

ResourceVersion
hl7.fhir.us.consent-management#current:Subscription/FASTOrganizationSubscriptionExampleR4
hl7.fhir.us.consent-management#current:Subscription/FASTPatientSubscriptionExampleR4
hl7.fhir.us.davinci-atr#current:Subscription/atr-list-change-subscription-exampleR4
hl7.fhir.us.davinci-cdex#current:Subscription/cdex-task-inline-scenario1-subscription-activeR4
hl7.fhir.us.davinci-cdex#current:Subscription/cdex-task-inline-scenario1-subscription-requestedR4
hl7.fhir.us.davinci-pas#current:Subscription/PASSubscriptionExampleR4
hl7.fhir.us.davinci-pct#current:Subscription/example-aeob-available-author-subscription-fullR4
hl7.fhir.us.davinci-pct#current:Subscription/example-aeob-available-author-subscription-id-onlyR4
hl7.fhir.us.davinci-pct#current:Subscription/example-gfe-available-author-subscription-fullR4
hl7.fhir.us.davinci-pct#current:Subscription/example-gfe-available-author-subscription-id-onlyR4
hl7.fhir.us.davinci-pct#current:Subscription/example-gfe-available-subject-subscription-fullR4
hl7.fhir.us.davinci-pct#current:Subscription/example-gfe-task-subscriptionR4
hl7.fhir.us.davinci-pct#current:Subscription/example-gfe-task-subscription-partofR4
hl7.fhir.us.medmorph#current:Subscription/encounter-end-subscription-exampleR4
hl7.fhir.us.medmorph#current:Subscription/encounter-start-subscription-exampleR4
hl7.fhir.us.ndh#current:Subscription/TopicSubscriptionPractitionerQualificationChangeR4
hl7.fhir.us.physical-activity#current:Subscription/ExampleSubscriptionEmailR4
hl7.fhir.us.physical-activity#current:Subscription/ExampleSubscriptionSMSR4
hl7.fhir.us.physical-activity#current:Subscription/ExampleSubscriptionWebhookR4
hl7.fhir.us.physical-activity#current:Subscription/Scen2SubscriptionEhrR4
hl7.fhir.us.physical-activity#current:Subscription/Scen2SubscriptionGetFitR4
hl7.fhir.us.physical-activity#current:Subscription/Scen3SubscriptionEhrR4
hl7.fhir.uv.subscriptions-backport#current:Subscription/subscription-admissionR4B
hl7.fhir.uv.subscriptions-backport#current:Subscription/subscription-multi-resourceR4B
hl7.fhir.uv.subscriptions-backport#current:Subscription/subscription-zulipR4B
ihe.iti.dsubm#current:Subscription/ex-DocumentReference-MultiPatient-SubscriptionR4
ihe.iti.dsubm#current:Subscription/ex-DocumentReference-MultiPatient-Subscription-AllEventsR4
ihe.iti.dsubm#current:Subscription/ex-DocumentReference-MultiPatient-Subscription-MinUpdtR4
ihe.iti.dsubm#current:Subscription/ex-DocumentReference-PatientDependent-SubscriptionR4
ihe.iti.dsubm#current:Subscription/ex-DocumentReference-PatientDependent-Subscription-AllEventsR4
ihe.iti.dsubm#current:Subscription/ex-DocumentReference-PatientDependent-Subscription-MinUpdtR4
ihe.iti.dsubm#current:Subscription/ex-Folder-Basic-SubscrptionR4
ihe.iti.dsubm#current:Subscription/ex-Folder-FullUpdtOpt-SubscrptionR4
ihe.iti.dsubm#current:Subscription/ex-Folder-MinUpdtOpt-SubscrptionR4
ihe.iti.dsubm#current:Subscription/ex-Folder-UpdtOpt-SubscrptionR4
ihe.iti.dsubm#current:Subscription/ex-SubmissionSet-MultiPatient-SubscriptionR4
ihe.iti.dsubm#current:Subscription/ex-SubmissionSet-PatientDependent-SubscriptionR4

Narrative

Note: links and images are rebased to the (stated) source

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBackport R5 Subscription Payload Content Information
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
... value[x] 0..1codeNotification content level
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "backport-payload-content",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "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/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content",
  "version": "1.2.0-ballot",
  "name": "BackportPayloadContent",
  "title": "Backport R5 Subscription Payload Content Information",
  "status": "active",
  "date": "2024-06-17T16:09:47+00:00",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name": "Gino Canessa",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:gino.canessa@microsoft.com"
        }
      ]
    }
  ],
  "description": "How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "fhirVersion": "4.3.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "Subscription.channel.payload"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Backport R5 Subscription Payload Content Information",
        "definition": "How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
            "expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
            "xpath": "@value|f:*|h:div|self::f:Parameters",
            "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
      },
      {
        "id": "Extension.id",
        "path": "Extension.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": "id"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "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
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Notification content level",
        "definition": "How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.",
        "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": "Extension.value[x]",
          "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": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Backport R5 Subscription Payload Content Information",
        "definition": "How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content."
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Notification content level",
        "definition": "How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.",
        "comment": "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set"
        }
      }
    ]
  }
}