Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example Endpoint/b5711af0a-d678-46d1-86e9-66e454cf1522 (JSON)

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

Collection of endpoint examples

{
  "resourceType" : "Bundle",
  "id" : "b5711af0a-d678-46d1-86e9-66e454cf1522",
  "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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7-fhir-rest"
        }]
      }],
      "name" : "CarePlan repository",
      "managingOrganization" : {
        "display" : "Telstra Health"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "CarePlan"
          }]
        }],
        "mimeType" : ["application/fhir+xml"]
      }],
      "address" : "https://sqlonfhir-dstu2.azurewebsites.net/fhir"
    }
  },
  {
    "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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7-fhir-rest"
        }]
      }],
      "name" : "Questionnaire Destination",
      "managingOrganization" : {
        "display" : "Telstra Health"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "QuestionnaireResponse"
          }]
        }],
        "mimeType" : ["application/fhir+xml"]
      }],
      "address" : "https://sqlonfhir-dstu2.azurewebsites.net/fhir"
    }
  },
  {
    "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, ServiceRequest<br/>\n              Address: https://sqlonfhir-dstu2.azurewebsites.net/fhir</div>"
      },
      "status" : "active",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7-fhir-rest"
        }]
      }],
      "name" : "Referral Requests",
      "managingOrganization" : {
        "display" : "Telstra Health"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "ServiceRequest"
          }]
        }],
        "mimeType" : ["application/fhir+xml"]
      }],
      "address" : "https://sqlonfhir-dstu2.azurewebsites.net/fhir"
    }
  },
  {
    "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, ServiceRequest QuestionnaireResponse<br/>\n              Address: https://open.epic.com/Interface/FHIR</div>"
      },
      "status" : "active",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7-fhir-rest"
        }]
      }],
      "name" : "Referral Requests",
      "managingOrganization" : {
        "display" : "Epic demo organization"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "ServiceRequest QuestionnaireResponse"
          }]
        }],
        "mimeType" : ["application/fhir+json"]
      }],
      "address" : "https://open.epic.com/Interface/FHIR"
    }
  },
  {
    "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, ServiceRequest<br/>\n              Address: mailto:subscriptions@example.org</div>"
      },
      "status" : "active",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "secure-email"
        }]
      }],
      "name" : "Subscription receiver",
      "managingOrganization" : {
        "display" : "Telstra Health"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "ServiceRequest"
          }]
        }],
        "mimeType" : ["application/fhir+xml"]
      }],
      "address" : "mailto:subscriptions@example.org"
    }
  },
  {
    "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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7-fhir-msg"
        }]
      }],
      "name" : "valid usecase?",
      "managingOrganization" : {
        "display" : "Telstra Health"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "CDA-EventSummary"
          }]
        }],
        "mimeType" : ["application/pdf"]
      }],
      "address" : "https://sqlonfhir-dstu2.azurewebsites.net/fhir"
    }
  },
  {
    "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: mllp://127.0.0.1:4001</div>"
      },
      "status" : "active",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7v2-mllp"
        }]
      }],
      "name" : "v2 referral Requests",
      "managingOrganization" : {
        "display" : "Epic demo organization"
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "REF-I12"
          }]
        }],
        "mimeType" : ["x-application/hl7-v2+er7"]
      }],
      "address" : "mllp://127.0.0.1:4001"
    }
  },
  {
    "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              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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "dicom-wado-rs"
        }]
      }],
      "name" : "Enterprise Image Archive",
      "managingOrganization" : {
        "display" : "Multi-site Co."
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
          }]
        }],
        "mimeType" : ["application/dicom; variant=DICOM WADO-RS"]
      }],
      "address" : "https://pacs.hospital.org/dicomweb"
    }
  },
  {
    "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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "dicom-qido-rs"
        }]
      }],
      "name" : "Enterprise Image Archive",
      "managingOrganization" : {
        "display" : "Multi-site Co."
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
          }]
        }],
        "mimeType" : ["application/dicom; variant=DICOM QIDO-RS"]
      }],
      "address" : "https://pacs.hospital.org/dicomweb"
    }
  },
  {
    "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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "dicom-stow-rs"
        }]
      }],
      "name" : "Enterprise Image Archive",
      "managingOrganization" : {
        "display" : "Multi-site Co."
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
          }]
        }],
        "mimeType" : ["application/dicom; variant=DICOM STOW-RS"]
      }],
      "address" : "https://pacs.hospital.org/dicomweb"
    }
  },
  {
    "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",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "dicom-stow-rs"
        }]
      }],
      "name" : "Enterprise Image Archive",
      "managingOrganization" : {
        "display" : "Multi-site Co."
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
          }]
        }],
        "mimeType" : ["application/dicom; variant=DICOM STOW-RS"]
      }],
      "address" : "https://pacs.hospital.org/dicomweb"
    }
  },
  {
    "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/wadoUri</div>"
      },
      "status" : "active",
      "connectionType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "dicom-wado-uri"
        }]
      }],
      "name" : "Enterprise Image Archive",
      "managingOrganization" : {
        "display" : "Multi-site Co."
      },
      "payload" : [{
        "type" : [{
          "coding" : [{
            "code" : "varies (application/dicom, application/dicom+xml, image/jpeg, and many more)"
          }]
        }],
        "mimeType" : ["application/dicom; variant=DICOM WADO-URI"]
      }],
      "address" : "https://pacs.hospital.org/wadoUri"
    }
  }]
}

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.