cURL
curl "https://api.haau3.com/v1/fhir/r4/Endpoint/Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358" \
-H "Authorization: Bearer $HAAU3_API_KEY"import { Haau3 } from "@haau3/sdk";
const haau3 = new Haau3(); // reads HAAU3_API_KEY
const endpoint = await haau3.readEndpoint("Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358");
console.log(endpoint.id);
from haau3 import Haau3
client = Haau3() # reads HAAU3_API_KEY
endpoint = client.read_endpoint("Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358")
print(endpoint.get("id"))
package main
import (
"context"
"fmt"
"log"
"github.com/haau3/haau3-go"
)
func main() {
ctx := context.Background()
client, err := haau3.NewClient() // reads HAAU3_API_KEY
if err != nil {
log.Fatal(err)
}
endpoint, err := client.ReadEndpoint(ctx, "Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358")
if err != nil {
log.Fatal(err)
}
if endpoint.ID != nil {
fmt.Println(*endpoint.ID)
}
}
{
"resourceType": "Endpoint",
"id": "Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358",
"meta": {
"lastUpdated": "2026-10-14T21:06:26.920943075Z",
"profile": [
"http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"
],
"versionId": "1"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS",
"code": "complete",
"display": "Complete"
}
]
}
}
],
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest",
"display": "HL7 FHIR"
},
"managingOrganization": {
"reference": "Organization/Organization-1326655846"
},
"address": "https://api.platform.athenahealth.com/22363/brand/1/csg/1/fhir/r4",
"payloadType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"version": "1.0.0",
"code": "not-applicable"
}
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "forbidden",
"details": {
"coding": [
{
"system": "https://haau3.com/fhir/CodeSystem/api-error",
"code": "test-key-outside-sandbox",
"display": "Test key outside the Sandbox"
}
],
"text": "This is a test key, which works only in the Sandbox (https://api.haau3.com/v1/sandbox/fhir/r4). Send this request with a live key; create one in the dashboard. See https://docs.haau3.com/authentication#test-and-live-keys"
}
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}Provider directory
Read an Endpoint
Read one endpoint by id, as returned by a search on this service.
GET
/
v1
/
fhir
/
r4
/
Endpoint
/
{id}
cURL
curl "https://api.haau3.com/v1/fhir/r4/Endpoint/Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358" \
-H "Authorization: Bearer $HAAU3_API_KEY"import { Haau3 } from "@haau3/sdk";
const haau3 = new Haau3(); // reads HAAU3_API_KEY
const endpoint = await haau3.readEndpoint("Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358");
console.log(endpoint.id);
from haau3 import Haau3
client = Haau3() # reads HAAU3_API_KEY
endpoint = client.read_endpoint("Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358")
print(endpoint.get("id"))
package main
import (
"context"
"fmt"
"log"
"github.com/haau3/haau3-go"
)
func main() {
ctx := context.Background()
client, err := haau3.NewClient() // reads HAAU3_API_KEY
if err != nil {
log.Fatal(err)
}
endpoint, err := client.ReadEndpoint(ctx, "Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358")
if err != nil {
log.Fatal(err)
}
if endpoint.ID != nil {
fmt.Println(*endpoint.ID)
}
}
{
"resourceType": "Endpoint",
"id": "Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358",
"meta": {
"lastUpdated": "2026-10-14T21:06:26.920943075Z",
"profile": [
"http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"
],
"versionId": "1"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS",
"code": "complete",
"display": "Complete"
}
]
}
}
],
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest",
"display": "HL7 FHIR"
},
"managingOrganization": {
"reference": "Organization/Organization-1326655846"
},
"address": "https://api.platform.athenahealth.com/22363/brand/1/csg/1/fhir/r4",
"payloadType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"version": "1.0.0",
"code": "not-applicable"
}
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "forbidden",
"details": {
"coding": [
{
"system": "https://haau3.com/fhir/CodeSystem/api-error",
"code": "test-key-outside-sandbox",
"display": "Test key outside the Sandbox"
}
],
"text": "This is a test key, which works only in the Sandbox (https://api.haau3.com/v1/sandbox/fhir/r4). Send this request with a live key; create one in the dashboard. See https://docs.haau3.com/authentication#test-and-live-keys"
}
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}Authorizations
A live platform API key (haau3_sk_live_…), sent as Authorization: Bearer <key>. It works for every service outside the Sandbox. Create one on the API keys page at https://platform.haau3.com.
Headers
An id of your own for this request, as a UUID. It comes back in the X-Correlation-Id header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids.
Path Parameters
The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.
Pattern:
^[A-Za-z0-9\-.]{1,64}$