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

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

Resource Profile: National 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: National Directory API CareTeam Profile, National Directory API HealthcareService Profile, National Directory API InsurancePlan Profile, National Directory API Location Profile... Show 5 more, National Directory API Network Profile, National Directory API Organization Profile, National Directory API OrganizationAffiliation Profile, National Directory API Practitioner Profile and National Directory API PractitionerRole
• Examples for this Resource Profile: Endpoint for Coordination of Care

Formal Views of Profile Content

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

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

This structure is derived from NdhEndpoint

Name	Flags	Card.	Type	Description & Constraints
Endpoint			NdhEndpoint
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:endpoint-usecase	S	0..*	EndpointUsecase	NDH Endpoint Usecase
extension:fhir-ig	S	0..*	FhirIg	NDH FHIR IG
extension:secure-exchange-artifacts	S	0..*	SecureExchangeArtifacts	NDH Secure Exchange Artifacts
extension:trust-framework	S	0..*	TrustFramework	NDH Trust Framework
extension:dynamic-registration	S	0..*	DynamicRegistration	NDH Dynamic Registration
extension:associated-servers	S	0..*	AssociatedServers	NDH Associated Servers
extension:access-control-mechanism	S	0..1	EndpointAccessControlMechanism	NDH Endpoint Access Control Mechanism
extension:connection-type-version	S	0..*	EndpointConnectionTypeVersion	NDH Endpoint Connection Type Version
extension:endpoint-rank	S	0..1	EndpointRank	NDH Endpoint Rank
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
identifier
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
managingOrganization		0..1	Reference(National Directory API 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)
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	Time period when the contact point was/is in use
period	S	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)
address	S	1..1	url	The technical base address for connecting to this endpoint
header	S	0..*	string	Usage depends on the channel type
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
meta	SΣ	0..1	Meta	Metadata about the resource
lastUpdated	Σ	1..1	instant	When the resource version last changed
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
endpoint-usecase	S	0..*	(Complex)	NDH 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	S	0..*	(Complex)	NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
secure-exchange-artifacts	S	0..*	(Complex)	NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
trust-framework	S	0..*	(Complex)	NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
dynamic-registration	S	0..*	(Complex)	NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
associated-servers	S	0..*	(Complex)	NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
access-control-mechanism	S	0..1	CodeableConcept	NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible)
connection-type-version	S	0..*	CodeableConcept	NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible)
endpoint-rank	S	0..1	positiveInt	NDH Endpoint Rank 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 IHE 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	S	1..1	CodeableConcept	NDH 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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: rofessional Credential Status (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
assigner	SΣ	0..1	Reference(National Directory API 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(National Directory API 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)
Slices for extension				Content/Rules for all slices
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH 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	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
period	SΣ	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	S	0..*	string	Usage depends on the channel type
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.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

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	SΣ	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	Σ	1..1	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		1..*	Extension	Extension Slice: Unordered, Open by value:url
endpoint-usecase	S	0..*	(Complex)	NDH 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	S	0..*	(Complex)	NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
secure-exchange-artifacts	S	0..*	(Complex)	NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
trust-framework	S	0..*	(Complex)	NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
dynamic-registration	S	0..*	(Complex)	NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
associated-servers	S	0..*	(Complex)	NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
access-control-mechanism	S	0..1	CodeableConcept	NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible)
connection-type-version	S	0..*	CodeableConcept	NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible)
endpoint-rank	S	0..1	positiveInt	NDH Endpoint Rank 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 IHE 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	S	1..1	CodeableConcept	NDH 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		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: rofessional Credential Status (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	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	SΣ	0..1	Reference(National Directory API 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(National Directory API 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
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH 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	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
period	SΣ	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	S	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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)

Differential View

This structure is derived from NdhEndpoint

Name	Flags	Card.	Type	Description & Constraints
Endpoint			NdhEndpoint
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:endpoint-usecase	S	0..*	EndpointUsecase	NDH Endpoint Usecase
extension:fhir-ig	S	0..*	FhirIg	NDH FHIR IG
extension:secure-exchange-artifacts	S	0..*	SecureExchangeArtifacts	NDH Secure Exchange Artifacts
extension:trust-framework	S	0..*	TrustFramework	NDH Trust Framework
extension:dynamic-registration	S	0..*	DynamicRegistration	NDH Dynamic Registration
extension:associated-servers	S	0..*	AssociatedServers	NDH Associated Servers
extension:access-control-mechanism	S	0..1	EndpointAccessControlMechanism	NDH Endpoint Access Control Mechanism
extension:connection-type-version	S	0..*	EndpointConnectionTypeVersion	NDH Endpoint Connection Type Version
extension:endpoint-rank	S	0..1	EndpointRank	NDH Endpoint Rank
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
identifier
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
managingOrganization		0..1	Reference(National Directory API 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)
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	Time period when the contact point was/is in use
period	S	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)
address	S	1..1	url	The technical base address for connecting to this endpoint
header	S	0..*	string	Usage depends on the channel type
Documentation for this format

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
meta	SΣ	0..1	Meta	Metadata about the resource
lastUpdated	Σ	1..1	instant	When the resource version last changed
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
endpoint-usecase	S	0..*	(Complex)	NDH 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	S	0..*	(Complex)	NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
secure-exchange-artifacts	S	0..*	(Complex)	NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
trust-framework	S	0..*	(Complex)	NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
dynamic-registration	S	0..*	(Complex)	NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
associated-servers	S	0..*	(Complex)	NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
access-control-mechanism	S	0..1	CodeableConcept	NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible)
connection-type-version	S	0..*	CodeableConcept	NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible)
endpoint-rank	S	0..1	positiveInt	NDH Endpoint Rank 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 IHE 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	S	1..1	CodeableConcept	NDH 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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: rofessional Credential Status (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
assigner	SΣ	0..1	Reference(National Directory API 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(National Directory API 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)
Slices for extension				Content/Rules for all slices
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH 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	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
period	SΣ	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	S	0..*	string	Usage depends on the channel type
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.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

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	SΣ	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	Σ	1..1	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		1..*	Extension	Extension Slice: Unordered, Open by value:url
endpoint-usecase	S	0..*	(Complex)	NDH 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	S	0..*	(Complex)	NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
secure-exchange-artifacts	S	0..*	(Complex)	NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
trust-framework	S	0..*	(Complex)	NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
dynamic-registration	S	0..*	(Complex)	NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
associated-servers	S	0..*	(Complex)	NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
access-control-mechanism	S	0..1	CodeableConcept	NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible)
connection-type-version	S	0..*	CodeableConcept	NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible)
endpoint-rank	S	0..1	positiveInt	NDH Endpoint Rank 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 IHE 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	S	1..1	CodeableConcept	NDH 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		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: rofessional Credential Status (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	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	SΣ	0..1	Reference(National Directory API 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(National Directory API 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
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH 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	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
period	SΣ	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	S	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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)

Other representations of profile: CSV, Excel, Schematron