National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

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 1.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

Resource Profile: NDH Base Endpoint Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint Version: 1.0.0-ballot
Active as of 2024-06-07 Computable Name: NdhEndpoint

Copyright/Legal: HL7 International

The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging.

Scope and Usage

The endpoint resource provides technical specifications for connecting to a specific location to transmit and retrieve information securely and accurately, according to the requirements of the endpoint owner. Unlike the CapabilityStatement, which describes the current system, the endpoint resource pertains to another system, potentially external to the current one. The endpoint could refer to locally hosted, regional, or national services.

Endpoint resources can be used to identify the location of endpoint details for various purposes, including referral requests to Organizations, OrganizationAffiliation, Locations, Practitioners, PractitionerRole or HealthcareServices. These resources can provide information on where to direct the referral request for efficient and effective care coordination.

Endpoint resources can also be useful for other purposes, such as facilitating preauthorization between insurance plans, network, and providers. They can be used to exchange information between care team members, allowing for seamless collaboration and communication among different healthcare providers involved in a patient’s care. By utilizing endpoint resources, relevant information can be shared securely and efficiently, helping to improve the quality of care and patient outcomes.

Boundaries and Relationships

CapabilityStatement vs Endpoint

The CapabilityStatement and the endpoint resource serve distinct purposes. While the CapabilityStatement describes the complete capability of a server, including the metadata of a specific server, the endpoint resource outlines the technical specifications for establishing connections and the intended purposes of such connections. The endpoint resource may only represent a small fraction of the server’s capabilities, and it may not even function as a FHIR endpoint.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint Endpoint
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... endpoint-usecase 0..* (Complex) Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
.... endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
.... fhir-ig 0..* (Complex) IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
.... 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
.... trust-framework 0..* (Complex) A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
.... 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
.... 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
.... 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)
.... connection-type-version 0..* CodeableConcept Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
.... endpoint-rank 0..1 positiveInt Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
.... 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 HIE Specific Connection Types Value Set (preferred)
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... 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)
.... testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
.... 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 S 0..* Identifier Identifies this endpoint across multiple systems
.... Slices for extension Content/Rules for all slices
..... 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 Base Organization Profile) Organization that issued id (may be just text)
... connectionType S 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name S 0..1 string A name that this endpoint can be identified by
... managingOrganization S 0..1 Reference(NDH Base Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... 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 S 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... endpoint-usecase 0..* (Complex) Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
.... endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
.... fhir-ig 0..* (Complex) IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
.... 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
.... trust-framework 0..* (Complex) A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
.... 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
.... 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
.... 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)
.... connection-type-version 0..* CodeableConcept Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
.... endpoint-rank 0..1 positiveInt Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
.... 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 HIE Specific Connection Types Value Set (preferred)
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... 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)
.... testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
.... 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
.... Slices for extension Content/Rules for all slices
..... 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 Base Organization Profile) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ 0..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... 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 SΣ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... endpoint-usecase 0..* (Complex) Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
.... endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
.... fhir-ig 0..* (Complex) IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
.... 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
.... trust-framework 0..* (Complex) A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
.... 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
.... 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
.... 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)
.... connection-type-version 0..* CodeableConcept Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
.... endpoint-rank 0..1 positiveInt Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
.... 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 HIE Specific Connection Types Value Set (preferred)
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... 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)
.... testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
.... 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 SΣ 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
..... 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 Base Organization Profile) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ 0..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
.... 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
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... 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
... 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 SΣ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG

This structure is derived from Endpoint

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint Endpoint
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... endpoint-usecase 0..* (Complex) Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
.... endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
.... fhir-ig 0..* (Complex) IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
.... 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
.... trust-framework 0..* (Complex) A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
.... 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
.... 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
.... 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)
.... connection-type-version 0..* CodeableConcept Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
.... endpoint-rank 0..1 positiveInt Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
.... 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 HIE Specific Connection Types Value Set (preferred)
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... 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)
.... testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
.... 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 S 0..* Identifier Identifies this endpoint across multiple systems
.... Slices for extension Content/Rules for all slices
..... 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 Base Organization Profile) Organization that issued id (may be just text)
... connectionType S 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name S 0..1 string A name that this endpoint can be identified by
... managingOrganization S 0..1 Reference(NDH Base Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... 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 S 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... endpoint-usecase 0..* (Complex) Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
.... endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
.... fhir-ig 0..* (Complex) IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
.... 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
.... trust-framework 0..* (Complex) A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
.... 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
.... 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
.... 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)
.... connection-type-version 0..* CodeableConcept Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
.... endpoint-rank 0..1 positiveInt Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
.... 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 HIE Specific Connection Types Value Set (preferred)
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... 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)
.... testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
.... 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
.... Slices for extension Content/Rules for all slices
..... 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 Base Organization Profile) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ 0..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... 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 SΣ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... endpoint-usecase 0..* (Complex) Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
.... endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
.... fhir-ig 0..* (Complex) IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
.... 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
.... trust-framework 0..* (Complex) A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
.... 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
.... 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
.... 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)
.... connection-type-version 0..* CodeableConcept Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
.... endpoint-rank 0..1 positiveInt Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
.... 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 HIE Specific Connection Types Value Set (preferred)
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... 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)
.... testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
.... 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 SΣ 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
..... 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 Base Organization Profile) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ 0..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
.... 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
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... 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
... 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 SΣ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG

This structure is derived from Endpoint

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

SearchParameter Name Type Example
access-control-mechanism token GET [base]/Endpoint?endpoint-access-control-mechanism=mutual-tls
connection-type-version token GET [base]/Endpoint?connection-type-version=4.0.1
dynamic-registration-trust-profile token GET [base]/Endpoint?dynamic-registration-trust-profile=udap
ihe-connection-type token GET [base]/Endpoint?ihe-connection-type=XCPD-InitGateway-PatientDiscovery-AsyncResponse
nonfhir-usecase-type token GET [base]/Endpoint?nonfhir-usecase-type=patient-access
trust-framework-type token GET [base]/Endpoin?trust-framework-type=DirectTrust
usecase-type token GET [base]/Endpoint?usecase-type=HOPERAT
verification-status token GET [base]/Endpoint?verification-status=complete

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

SearchParameter Name Type Example
connection-type token GET [base]/Endpoint?connection-type=hl7-fhir-rest
identifier token GET [base]/Endpoint?identifier={system}|{value}
organization reference GET [base]/Endpoint?organization.name=Hartford General Hospital
status token GET [base]/Endpoint?status=active

_include Search Parameter

_include Example
Endpoint:organization GET [base]/CareTeam?_include=Endpoint:organization

_revinclude Search parameter

_revinclude
CareTeam:endpoint
HealthcareService:endpoint
InsurancePlan:endpoint
Location:endpoint
Organization:endpoint
OrganizationAffiliation:endpoint
Practitioner: endpoint
PractitionerRole:endpoint
VerifcationResult:target

Special Search Parameters

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.