Regulatory Workflows and Interactions - pharma, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Example APIX interaction Endpoint with header

Raw json | Download

{
  "resourceType" : "Endpoint",
  "id" : "1005",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2026-02-02T00:22:34.166+00:00",
    "profile" : [
      🔗 "http://hl7.org/fhir/uv/apix/StructureDefinition/endpoint-subscription-notify"
    ]
  },
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Endpoint 1005</b></p><a name=\"1005\"> </a><a name=\"hc1005\"> </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: 1; Last updated: 2026-02-02 00:22:34+0000</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-endpoint-subscription-notify.html\">APIX Endpoint for FHIR Subscription Notifications</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Best Company FHIR Subscription Notification Endpoint (HL7 FHIR Subscription Notification Endpoint): http://example.org/host.docker.internal:3000/fhir-subscription-notify</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"The status of the endpoint\">Status:</td><td colspan=\"3\">Active</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The technical base address for connecting to this endpoint\">Address:</td><td colspan=\"3\"><a href=\"http://example.org/host.docker.internal:3000/fhir-subscription-notify\">http://example.org/host.docker.internal:3000/fhir-subscription-notify</a></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The protocol, profile or standard used to connect to the endpoint\">Connection Type:</td><td colspan=\"3\"><span title=\"Codes:{http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp hl7-fhir-subscription-notify}\">HL7 FHIR Subscription Notification Endpoint</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The set of payloads that are provided/available at this endpoint\">Payload:</td><td colspan=\"3\"><ul><li>Payload Type: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/endpoint-payload-type any}\">Any</span></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Headers to use when connecting to the endpoint\">Header:</td><td colspan=\"3\">Authorization: XXXXXXXX</td></tr></table></div>"
  },
  "identifier" : [
    {
      "system" : "http://example.org/submitter-system",
      "value" : "findMEanywhereUsingThisSystemAndValue"
    }
  ],
  "status" : "active",
  "connectionType" : [
    {
      "coding" : [
        {
          "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp",
          "code" : "hl7-fhir-subscription-notify"
        }
      ]
    }
  ],
  "name" : "Best Company FHIR Subscription Notification Endpoint",
  "payload" : [
    {
      "type" : [
        {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
              "code" : "any",
              "display" : "Any"
            }
          ]
        }
      ]
    }
  ],
  "address" : "http://example.org/host.docker.internal:3000/fhir-subscription-notify",
  "header" : [
    "Authorization: Bearer {{token}}"
  ]
}