AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Endpoint - a FHIR REST API endpoint example - JSON Representation

Raw json | Download

{
  "resourceType" : "Endpoint",
  "id" : "example1",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org.au/fhir/StructureDefinition/au-endpoint"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Endpoint example1</b></p><a name=\"example1\"> </a><a name=\"hcexample1\"> </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\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-au-endpoint.html\">AU Base Endpoint</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Downunder Hospital FHIR API (HL7 FHIR (Endpoint Connection Type#hl7-fhir-rest)): https://fhir.downunderhospital.example.com/R4</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"The status of the endpoint\">Status:</td><td>Active</td><td style=\"background-color: #f3f5da\" title=\"The interval during which the endpoint is expected to be operational\">Valid Period:</td><td>2023-07-01 --&gt; (ongoing)</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=\"https://fhir.downunderhospital.example.com/R4\">https://fhir.downunderhospital.example.com/R4</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\"><a href=\"http://terminology.hl7.org/7.4.0/CodeSystem-endpoint-connection-type.html#endpoint-connection-type-hl7-fhir-rest\">Endpoint Connection Type: hl7-fhir-rest</a> (HL7 FHIR)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The type of content that may be used at this endpoint\">Payload Type:</td><td colspan=\"3\"><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/endpoint-payload-type any}\">Any</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The mime types that can be sent to and/or received from the endpoint\">Mime Type:</td><td colspan=\"3\"><ul><li>application/fhir+json</li><li>application/fhir+xml</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The organization that manages this endpoint\">Managed By:</td><td colspan=\"3\"><a href=\"Organization-example0.html\">Downunder Hospital</a></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Contact details for a human to contact about the endpoint\">Contact Detail</td><td colspan=\"3\"><ul><li><a href=\"mailto:admini@downunderhospital.example.com\">admini@downunderhospital.example.com</a></li><li><a href=\"tel:+61255505560\">+61255505560</a></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"R5: `Endpoint.environmentType` (new:CodeableConcept)\"><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/StructureDefinition-ext-R5-Endpoint.environmentType.html\">R5: The type of environment(s) exposed at this endpoint (new)</a></td><td colspan=\"3\"><span title=\"Codes:{http://hl7.org/fhir/endpoint-environment prod}\">Production</span></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType",
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/endpoint-environment",
            "code" : "prod",
            "display" : "Production"
          }
        ]
      }
    }
  ],
  "identifier" : [
    {
      "system" : "http://downunderhospital.example.com/id/endpoint",
      "value" : "DUH-FHIR-PROD-01"
    }
  ],
  "status" : "active",
  "connectionType" : {
    "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
    "code" : "hl7-fhir-rest",
    "display" : "HL7 FHIR"
  },
  "name" : "Downunder Hospital FHIR API",
  "managingOrganization" : {
    🔗 "reference" : "Organization/example0",
    "display" : "Downunder Hospital"
  },
  "contact" : [
    {
      "system" : "email",
      "value" : "admini@downunderhospital.example.com",
      "use" : "work"
    },
    {
      "system" : "phone",
      "value" : "+61255505560",
      "use" : "work"
    }
  ],
  "period" : {
    "start" : "2023-07-01"
  },
  "payloadType" : [
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "any"
        }
      ]
    }
  ],
  "payloadMimeType" : [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "address" : "https://fhir.downunderhospital.example.com/R4"
}