National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
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-current 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-current | ||||
| Standards status: Trial-use | Maturity Level: 4 | 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:  |
|---|---|---|---|---|
  Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:implementation-guide |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself,
and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate
includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |
| extension:security-details |
0..* | (Complex) | Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | |
| extension:dynamic-registration |
0..* | (Complex) | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider
dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security
are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |
| extension:associated-servers |
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 | |
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange
between systems adheres to specific security protocols when needed. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
| extension:ihe-specific-connection-type |
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) | |
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
 extension:environmentType |
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) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..* | Identifier | Identifies this endpoint across multiple systems | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
  assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| status |
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) | |
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
| name |
0..1 | string | A name that this endpoint can be identified by | |
| managingOrganization |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
| Slices for contact |
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 | |
  contact:All Slices |
Content/Rules for all slices | |||
 system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
0..1 | string | The actual contact point details | |
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
 contact:configuration-url |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
  system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) |
| value |
1..1 | string | an https:// URL for app developers | |
 use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
| period |
0..1 | Period | Interval the endpoint is expected to be operational | |
| payloadType |
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) | |
| payloadMimeType |
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) | |
| address |
1..1 | url | The technical base address for connecting to this endpoint | |
| header |
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-current | 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-current | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:implementation-guide |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself,
and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate
includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |
| extension:security-details |
0..* | (Complex) | Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | |
| extension:dynamic-registration |
0..* | (Complex) | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider
dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security
are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |
| extension:associated-servers |
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 | |
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange
between systems adheres to specific security protocols when needed. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
| extension:ihe-specific-connection-type |
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) | |
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| extension:environmentType |
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) | |
| identifier |
0..* | Identifier | Identifies this endpoint across multiple systems | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| status |
1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active (no extensions allowed) | |
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
| name |
0..1 | string | A name that this endpoint can be identified by | |
| managingOrganization |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
| Slices for contact |
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 | |
| contact:All Slices |
Content/Rules for all slices | |||
| system |
0..1 | code | phone | fax | email | pager | url | sms | other | |
| value |
0..1 | string | The actual contact point details | |
| contact:configuration-url |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: url (extensions allowed) | |
| value |
1..1 | string | an https:// URL for app developers | |
| period |
0..1 | Period | Interval the endpoint is expected to be operational | |
| payloadType |
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) | |
| payloadMimeType |
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) | |
| address |
1..1 | url | The technical base address for connecting to this endpoint | |
| header |
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-current | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-current | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
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". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:implementation-guide |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |||||
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself,
and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate
includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |||||
| extension:security-details |
0..* | (Complex) | Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | |||||
| extension:dynamic-registration |
0..* | (Complex) | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider
dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security
are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |||||
| extension:associated-servers |
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 | |||||
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange
between systems adheres to specific security protocols when needed. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |||||
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |||||
| extension:ihe-specific-connection-type |
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) | |||||
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| extension:environmentType |
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) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifies this endpoint across multiple systems | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
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. | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
0..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |||||
| status |
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) | |||||
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |||||
| name |
0..1 | string | A name that this endpoint can be identified by | |||||
| managingOrganization |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
| Slices for contact |
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 | |||||
| contact:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
0..1 | string | The actual contact point details | |||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| contact:configuration-url |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) | ||||
| value |
1..1 | string | an https:// URL for app developers | |||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| period |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
| payloadType |
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) | |||||
| payloadMimeType |
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) | |||||
| address |
1..1 | url | The technical base address for connecting to this endpoint | |||||
| header |
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-current | 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-current | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-current | 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: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:implementation-guide |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself,
and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate
includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |
| extension:security-details |
0..* | (Complex) | Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | |
| extension:dynamic-registration |
0..* | (Complex) | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider
dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security
are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |
| extension:associated-servers |
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 | |
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange
between systems adheres to specific security protocols when needed. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
| extension:ihe-specific-connection-type |
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) | |
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| extension:environmentType |
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) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Identifies this endpoint across multiple systems | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| status |
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) | |
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
| name |
0..1 | string | A name that this endpoint can be identified by | |
| managingOrganization |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
| Slices for contact |
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 | |
| contact:All Slices |
Content/Rules for all slices | |||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
0..1 | string | The actual contact point details | |
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
| contact:configuration-url |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) |
| value |
1..1 | string | an https:// URL for app developers | |
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
| period |
0..1 | Period | Interval the endpoint is expected to be operational | |
| payloadType |
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) | |
| payloadMimeType |
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) | |
| address |
1..1 | url | The technical base address for connecting to this endpoint | |
| header |
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-current | 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-current | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:implementation-guide |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself,
and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate
includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |
| extension:security-details |
0..* | (Complex) | Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | |
| extension:dynamic-registration |
0..* | (Complex) | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider
dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security
are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |
| extension:associated-servers |
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 | |
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange
between systems adheres to specific security protocols when needed. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |
| extension:ihe-specific-connection-type |
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) | |
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| extension:environmentType |
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) | |
| identifier |
0..* | Identifier | Identifies this endpoint across multiple systems | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| status |
1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active (no extensions allowed) | |
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |
| name |
0..1 | string | A name that this endpoint can be identified by | |
| managingOrganization |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
| Slices for contact |
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 | |
| contact:All Slices |
Content/Rules for all slices | |||
| system |
0..1 | code | phone | fax | email | pager | url | sms | other | |
| value |
0..1 | string | The actual contact point details | |
| contact:configuration-url |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: url (extensions allowed) | |
| value |
1..1 | string | an https:// URL for app developers | |
| period |
0..1 | Period | Interval the endpoint is expected to be operational | |
| payloadType |
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) | |
| payloadMimeType |
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) | |
| address |
1..1 | url | The technical base address for connecting to this endpoint | |
| header |
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-current | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦2.0.0-current | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-current | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
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". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:implementation-guide |
0..* | (Complex) | Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide | |||||
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself,
and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate
includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |||||
| extension:security-details |
0..* | (Complex) | Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | |||||
| extension:dynamic-registration |
0..* | (Complex) | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider
dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security
are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |||||
| extension:associated-servers |
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 | |||||
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange
between systems adheres to specific security protocols when needed. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |||||
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |||||
| extension:ihe-specific-connection-type |
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) | |||||
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| extension:environmentType |
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) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifies this endpoint across multiple systems | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
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. | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
0..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |||||
| status |
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) | |||||
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |||||
| name |
0..1 | string | A name that this endpoint can be identified by | |||||
| managingOrganization |
0..1 | Reference(NDH Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
| Slices for contact |
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 | |||||
| contact:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
0..1 | string | The actual contact point details | |||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| contact:configuration-url |
0..* | ContactPoint | Website where developers can configure access to this endpoint | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url (extensions allowed) | ||||
| value |
1..1 | string | an https:// URL for app developers | |||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| period |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
| payloadType |
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) | |||||
| payloadMimeType |
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) | |||||
| address |
1..1 | url | The technical base address for connecting to this endpoint | |||||
| header |
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-current | 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-current | This IG |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦2.0.0-current | 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: 4
Other representations of profile: CSV, Excel, Schematron
| Name | Type | Description | Expression |
| access-control-mechanism | token |
Use this search parameter to find endpoints by access-control approach so clients can match expected authentication and authorization patterns. Applies to Endpoint records. |
Endpoint.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism').value.ofType(CodeableConcept)
|
| connection-type | token |
Protocol/Profile/Standard to be used with this endpoint connection |
Endpoint.connectionType
|
| dynamic-registration-trust-profile | token |
Use this search parameter to find endpoints that support dynamic trust-profile registration so onboarding can be automated and scalable. Applies to Endpoint records. |
Endpoint.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration').extension.where(url='trustProfile').value.ofType(CodeableConcept)
|
| 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 |
Select Endpoints managed by the specified organization |
Endpoint.managingOrganization
|
| payload-type | token |
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
Endpoint.payloadType
|
| security-details | token |
Use this search parameter to identify endpoints by trust framework so they can connect through compatible security and policy communities. Applies to Endpoint records. |
Endpoint.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details').extension.where(url='trustFrameworkType').value.ofType(CodeableConcept)
|
| 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.
IG © 2023+ HL7 International / Patient Administration.
Package hl7.fhir.us.ndh#2.0.0-current based on FHIR 4.0.1.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change