National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint | Version: 2.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: NdhEndpoint | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.40 | |||||
This profile enables NDH to publish trusted, implementation-ready technical endpoints so directory consumers can reliably discover, evaluate, and connect to electronic exchange services including APIs and messaging; it adds endpoint-focused extensions for trust, registration, access control, testing, and environment context, and applies ValueSet bindings that standardize connection type, payload type, and MIME-type semantics.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
![]() ![]() ![]() |
0..* | (Complex) | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked
to this endpoint. If a server is associated, its type and URL will be included URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |
![]() ![]() ![]() |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
0..1 | string | The actual contact point details | |
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
![]() ![]() ![]() |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
![]() ![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) |
![]() ![]() ![]() ![]() |
1..1 | string | an https:// URL for app developers | |
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | |
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | |
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
![]() ![]() ![]() |
0..* | (Complex) | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked
to this endpoint. If a server is associated, its type and URL will be included URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |
![]() ![]() ![]() |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active (no extensions allowed) | |
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() |
0..1 | string | The actual contact point details | |
![]() ![]() ![]() |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: url (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | an https:// URL for app developers | |
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | |
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | |
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |||||
![]() ![]() ![]() |
0..* | (Complex) | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked
to this endpoint. If a server is associated, its type and URL will be included URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() |
0..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) | ||||
![]() ![]() ![]() ![]() |
1..1 | string | an https:// URL for app developers | |||||
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | |||||
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Endpoint.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
Summary
Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
![]() ![]() ![]() |
0..* | (Complex) | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked
to this endpoint. If a server is associated, its type and URL will be included URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |
![]() ![]() ![]() |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
0..1 | string | The actual contact point details | |
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
![]() ![]() ![]() |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
![]() ![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) |
![]() ![]() ![]() ![]() |
1..1 | string | an https:// URL for app developers | |
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | |
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | |
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
![]() ![]() ![]() |
0..* | (Complex) | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked
to this endpoint. If a server is associated, its type and URL will be included URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |
![]() ![]() ![]() |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active (no extensions allowed) | |
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() |
0..1 | string | The actual contact point details | |
![]() ![]() ![]() |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: url (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | an https:// URL for app developers | |
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | |
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | |
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-ballot | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |||||
![]() ![]() ![]() |
0..* | (Complex) | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked
to this endpoint. If a server is associated, its type and URL will be included URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() |
0..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) | ||||
![]() ![]() ![]() ![]() |
1..1 | string | an https:// URL for app developers | |||||
![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | |||||
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Endpoint.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact:configuration-url.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
Summary
Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
| Name | Type | Description | Expression |
| connection-type | token |
Protocol/Profile/Standard to be used with this endpoint connection |
Endpoint.connectionType
|
| identifier | token |
Identifies this endpoint across multiple systems |
Endpoint.identifier
|
| ihe-connection-type | token |
Use this search parameter to find endpoints by detailed IHE-specific connection semantics when general connection types are not precise enough. Applies to Endpoint records. |
Endpoint.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type').value.ofType(CodeableConcept)
|
| ihe-mcsd-purpose-of-use | token |
This SearchParameter enables finding Endpoints or Organizatoins by the purpose of use code. This resource is created as informative content. |
(extension('https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse').value.ofType(CodeableConcept))
|
| name | string |
A name that this endpoint can be identified by |
Endpoint.name
|
| organization | reference |
The organization that is managing the endpoint |
Endpoint.managingOrganization
|
| payload-type | token |
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
Endpoint.payloadType
|
| specificType | token |
This SearchParameter enables finding Endpoints by the specificType code. This resource is created as informative content. |
(extension('https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype').value.ofType(CodeableConcept))
|
| status | token |
The current status of the Endpoint (usually expected to be active) |
Endpoint.status
|
| verification-status | token |
Use this search parameter to find records by verification standing to prioritize trusted and current directory data. Applies to Endpoint, HealthcareService, Organization, Location, Practitioner, PractitionerRole, InsurancePlan, OrganizationAffiliation, and Group records. |
extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status').value
|
| _include | Example |
|---|---|
| Endpoint:organization | GET [base]/Endpoint?_include=Endpoint:organization |
| _revinclude |
|---|
| HealthcareService:endpoint |
| InsurancePlan:endpoint |
| Location:endpoint |
| Organization:endpoint |
| OrganizationAffiliation:endpoint |
| Practitioner: endpoint |
| PractitionerRole:endpoint |
| VerifcationResult:target |
The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.