STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Endpoint-examples-general-template.json

Raw JSON (canonical form)

Sample endpoint data

{
  "resourceType": "Bundle",
  "id": "b0a5e4277-83c4-4adb-87e2-e3efe3369b6f",
  "meta": {
    "lastUpdated": "2012-05-29T23:45:32Z"
  },
  "type": "collection",
  "entry": [
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/71",
      "resource": {
        "resourceType": "Endpoint",
        "id": "71",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              CarePlan repository, CarePlan<br/>\n              Address: https://sqlonfhir-dstu2.azurewebsites.net/fhir</div>"
        },
        "status": "active",
        "name": "CarePlan repository",
        "managingOrganization": {
          "display": "Telstra Health"
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "https://sqlonfhir-dstu2.azurewebsites.net/fhir",
        "payloadFormat": "application/fhir+xml",
        "payloadType": [
          {
            "coding": [
              {
                "code": "CarePlan"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/72",
      "resource": {
        "resourceType": "Endpoint",
        "id": "72",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Questionnaire Destination, QuestionnaireResponse<br/>\n              Address: https://sqlonfhir-dstu2.azurewebsites.net/fhir</div>"
        },
        "status": "active",
        "name": "Questionnaire Destination",
        "managingOrganization": {
          "display": "Telstra Health"
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "https://sqlonfhir-dstu2.azurewebsites.net/fhir",
        "payloadFormat": "application/fhir+xml",
        "payloadType": [
          {
            "coding": [
              {
                "code": "QuestionnaireResponse"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/73",
      "resource": {
        "resourceType": "Endpoint",
        "id": "73",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Referral Requests, ReferralRequest<br/>\n              Address: https://sqlonfhir-dstu2.azurewebsites.net/fhir</div>"
        },
        "status": "active",
        "name": "Referral Requests",
        "managingOrganization": {
          "display": "Telstra Health"
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "https://sqlonfhir-dstu2.azurewebsites.net/fhir",
        "payloadFormat": "application/fhir+xml",
        "payloadType": [
          {
            "coding": [
              {
                "code": "ReferralRequest"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/74",
      "resource": {
        "resourceType": "Endpoint",
        "id": "74",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Referral Requests, ReferralRequest QuestionnaireResponse<br/>\n              Address: https://open.epic.com/Interface/FHIR</div>"
        },
        "status": "active",
        "name": "Referral Requests",
        "managingOrganization": {
          "display": "Epic demo organization"
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "https://open.epic.com/Interface/FHIR",
        "payloadFormat": "application/fhir+json",
        "payloadType": [
          {
            "coding": [
              {
                "code": "ReferralRequest QuestionnaireResponse"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/75",
      "resource": {
        "resourceType": "Endpoint",
        "id": "75",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Subscription receiver, ReferralRequest<br/>\n              Address: subscriptions@example.org</div>"
        },
        "status": "active",
        "name": "Subscription receiver",
        "managingOrganization": {
          "display": "Telstra Health"
        },
        "connectionType": {
          "code": "email"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST PUT DELETE"
          }
        ],
        "address": "subscriptions@example.org",
        "payloadFormat": "application/fhir+xml",
        "payloadType": [
          {
            "coding": [
              {
                "code": "ReferralRequest"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/76",
      "resource": {
        "resourceType": "Endpoint",
        "id": "76",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              valid usecase?, CDA-EventSummary<br/>\n              Address: https://sqlonfhir-dstu2.azurewebsites.net/fhir</div>"
        },
        "status": "active",
        "name": "valid usecase?",
        "managingOrganization": {
          "display": "Telstra Health"
        },
        "connectionType": {
          "code": "message"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "https://sqlonfhir-dstu2.azurewebsites.net/fhir",
        "payloadFormat": "PDF",
        "payloadType": [
          {
            "coding": [
              {
                "code": "CDA-EventSummary"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/77",
      "resource": {
        "resourceType": "Endpoint",
        "id": "77",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              v2 referral Requests, REF-I12<br/>\n              Address: 127.0.0.1</div>"
        },
        "status": "active",
        "name": "v2 referral Requests",
        "managingOrganization": {
          "display": "Epic demo organization"
        },
        "connectionType": {
          "code": "MLLP"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "127.0.0.1",
        "payloadFormat": "HL7v2",
        "payloadType": [
          {
            "coding": [
              {
                "code": "REF-I12"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/78",
      "resource": {
        "resourceType": "Endpoint",
        "id": "78",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              xds event summaries, CDA-EventSummary<br/>\n              Address: https://open.epic.com/Interface/XDS.b</div>"
        },
        "status": "active",
        "name": "xds event summaries",
        "managingOrganization": {
          "display": "Epic demo organization"
        },
        "connectionType": {
          "code": "SOAP"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST"
          }
        ],
        "address": "https://open.epic.com/Interface/XDS.b",
        "payloadFormat": "XDA/XDS",
        "payloadType": [
          {
            "coding": [
              {
                "code": "CDA-EventSummary"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/79",
      "resource": {
        "resourceType": "Endpoint",
        "id": "79",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Enterprise Image Archive, varies (application/dicom, application/dicom+xml, image/jpeg, and many more)<br/>\n              Address: https://pacs.hospital.org/dicomweb</div>"
        },
        "status": "active",
        "name": "Enterprise Image Archive",
        "managingOrganization": {
          "display": "Multi-site Co."
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "GET OPTIONS"
          }
        ],
        "address": "https://pacs.hospital.org/dicomweb",
        "payloadFormat": "DICOM WADO-RS",
        "payloadType": [
          {
            "coding": [
              {
                "code": "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/80",
      "resource": {
        "resourceType": "Endpoint",
        "id": "80",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Enterprise Image Archive, varies (application/dicom, application/dicom+xml, image/jpeg, and many more)<br/>\n              Address: https://pacs.hospital.org/dicomweb</div>"
        },
        "status": "active",
        "name": "Enterprise Image Archive",
        "managingOrganization": {
          "display": "Multi-site Co."
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "GET OPTIONS"
          }
        ],
        "address": "https://pacs.hospital.org/dicomweb",
        "payloadFormat": "DICOM QIDO-RS",
        "payloadType": [
          {
            "coding": [
              {
                "code": "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/81",
      "resource": {
        "resourceType": "Endpoint",
        "id": "81",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Enterprise Image Archive, varies (application/dicom, application/dicom+xml, image/jpeg, and many more)<br/>\n              Address: https://pacs.hospital.org/dicomweb</div>"
        },
        "status": "active",
        "name": "Enterprise Image Archive",
        "managingOrganization": {
          "display": "Multi-site Co."
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "POST OPTIONS"
          }
        ],
        "address": "https://pacs.hospital.org/dicomweb",
        "payloadFormat": "DICOM STOW-RS",
        "payloadType": [
          {
            "coding": [
              {
                "code": "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/82",
      "resource": {
        "resourceType": "Endpoint",
        "id": "82",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Enterprise Image Archive, varies (application/dicom, application/dicom+xml, image/jpeg, and many more)<br/>\n              Address: https://pacs.hospital.org/dicomweb</div>"
        },
        "status": "active",
        "name": "Enterprise Image Archive",
        "managingOrganization": {
          "display": "Multi-site Co."
        },
        "connectionType": {
          "code": "rest-hook"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "GET PUT POST DELETE OPTIONS"
          }
        ],
        "address": "https://pacs.hospital.org/dicomweb",
        "payloadFormat": "DICOM STOW-RS",
        "payloadType": [
          {
            "coding": [
              {
                "code": "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/83",
      "resource": {
        "resourceType": "Endpoint",
        "id": "83",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Enterprise Image Archive, varies (application/dicom, application/dicom+xml, image/jpeg, and many more)<br/>\n              Address: https://pacs.hospital.org/wadoUri</div>"
        },
        "status": "active",
        "name": "Enterprise Image Archive",
        "managingOrganization": {
          "display": "Multi-site Co."
        },
        "connectionType": {
          "code": "websocket"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "GET"
          }
        ],
        "address": "https://pacs.hospital.org/wadoUri",
        "payloadFormat": "DICOM WADO-URI",
        "payloadType": [
          {
            "coding": [
              {
                "code": "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "http://hl7.org/fhir/Endpoint/84",
      "resource": {
        "resourceType": "Endpoint",
        "id": "84",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n              Enterprise Image Archive, varies (application/dicom, application/dicom+xml, image/jpeg, and many more)<br/>\n              Address: https://pacs.hospital.org/IHEInvokeImageDisplay</div>"
        },
        "status": "active",
        "name": "Enterprise Image Archive",
        "managingOrganization": {
          "display": "Multi-site Co."
        },
        "connectionType": {
          "code": "websocket"
        },
        "method": [
          {
            "system": "http://hl7.org/fhir/ValueSet/http-verb",
            "code": "GET"
          }
        ],
        "address": "https://pacs.hospital.org/IHEInvokeImageDisplay",
        "payloadFormat": "IHE IID",
        "payloadType": [
          {
            "coding": [
              {
                "code": "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
              }
            ]
          }
        ]
      }
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.