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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Payer Provider Network Local Directory API Endpoint Profile

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.

Usage:

• Refer to this Resource Profile: Payer Provider Network Query HealthcareService Profile, Payer Provider Network Query InsurancePlan Profile, Payer Provider Network Query Location Profile, Payer Provider Network Query Network Profile... Show 4 more, Payer Provider Network Query Organization Profile, Payer Provider Network Query OrganizationAffiliation Profile, Payer Provider Network Query Practitioner Profile and Payer Provider Network Query PractitionerRole
• Examples for this Resource Profile: DiamondOnyxHealth
• CapabilityStatements using this Resource Profile: Workflow Directory Server Payer Provider Network Query Capability Statement

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	NdhEndpoint	The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:endpoint-usecase	S	0..*	(Complex)	NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:endpoint-nonfhir-usecase		0..*	(Complex)	Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:fhir-ig		0..*	(Complex)	IGs supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension: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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension: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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:testing-certification		0..*	(Complex)	Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children 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) ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(Payer Provider Network Query Organization Profile)	Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children
contact	S	0..*	ContactPoint	Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension: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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
payloadType	SΣ	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) ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children
address	SΣ	1..1	url	The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	EndpointFhirMimeTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG

This structure is derived from NdhEndpoint

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	NdhEndpoint	The technical details of an endpoint that can be used for electronic services
Slices for extension				Content/Rules for all slices
extension:endpoint-usecase	S	0..*	EndpointUsecase	NDH Endpoint Usecase
managingOrganization		0..1	Reference(Payer Provider Network Query Organization Profile)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact	S	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
payloadType	S	1..1	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
address	S	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	NdhEndpoint	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. Additional Bindings Purpose AllLanguages Max Binding
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
extension:endpoint-usecase	S	0..*	(Complex)	NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
extension:endpoint-nonfhir-usecase		0..*	(Complex)	Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
extension:fhir-ig		0..*	(Complex)	IGs supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
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: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
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: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)
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:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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:testing-certification		0..*	(Complex)	Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
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	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
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 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(Payer Provider Network Query Organization Profile)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact	S	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
extension:contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension: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	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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	SΣ	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	SΣ	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Endpoint.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	EndpointFhirMimeTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG

This structure is derived from NdhEndpoint

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

• Payer Provider Network Query Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPn-ldapi-Organization)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	NdhEndpoint	The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:endpoint-usecase	S	0..*	(Complex)	NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:endpoint-nonfhir-usecase		0..*	(Complex)	Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:fhir-ig		0..*	(Complex)	IGs supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension: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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension: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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:testing-certification		0..*	(Complex)	Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children 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) ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(Payer Provider Network Query Organization Profile)	Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children
contact	S	0..*	ContactPoint	Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension: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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
payloadType	SΣ	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) ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children
address	SΣ	1..1	url	The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	EndpointFhirMimeTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG

Differential View

This structure is derived from NdhEndpoint

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	NdhEndpoint	The technical details of an endpoint that can be used for electronic services
Slices for extension				Content/Rules for all slices
extension:endpoint-usecase	S	0..*	EndpointUsecase	NDH Endpoint Usecase
managingOrganization		0..1	Reference(Payer Provider Network Query Organization Profile)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact	S	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
payloadType	S	1..1	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
address	S	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	NdhEndpoint	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. Additional Bindings Purpose AllLanguages Max Binding
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
extension:endpoint-usecase	S	0..*	(Complex)	NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
extension:endpoint-nonfhir-usecase		0..*	(Complex)	Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
extension:fhir-ig		0..*	(Complex)	IGs supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
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: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
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: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)
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:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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:testing-certification		0..*	(Complex)	Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
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	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
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 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(Payer Provider Network Query Organization Profile)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact	S	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
extension:contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension: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	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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	SΣ	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	SΣ	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Endpoint.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	EndpointFhirMimeTypeVS http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG

This structure is derived from NdhEndpoint

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

• Payer Provider Network Query Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPn-ldapi-Organization)

Other representations of profile: CSV, Excel, Schematron