Payer Provider Network Local Directory API Endpoint Profile - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v1.0.0-ballot

Logical id of this artifact

Meta

Metadata about the resource

id

0..1

Unique id for inter-element referencing

extension

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

versionId

Σ

0..1

Version specific identifier

lastUpdated

Σ

1..1

instant

When the resource version last changed

source

Σ

0..1

canonical(StructureDefinition)

Identifies where the resource comes from

profile

Σ

0..*

Profiles this resource claims to conform to

security

Σ

0..*

Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

tag

Σ

0..*

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

A set of rules under which this content was created

language

0..1

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

0..*

secure-exchange-artifacts

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

0..*

(Complex)

IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig

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

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

Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)

endpoint-rank

0..1

ihe-specific-connection-type

Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank

0..*

Reference(NDH Base Restriction) {c }

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

Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction

verification-status

0..1

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

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

Extensions that cannot be ignored

identifier

SΣ

0..*

Identifier

Identifies this endpoint across multiple systems

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

identifier-status

0..1

NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

type

Σ

0..1

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Σ

0..1

The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

Σ

0..1

The value that is unique
Example General: 123456

Σ

0..1

Reference(NDH Base Organization Profile)

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

status

?!SΣ

1..1

connectionType

SΣ

1..1

Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)

name

SΣ

0..1

Reference(Payer Provider Network Query Organization Profile)

A name that this endpoint can be identified by

managingOrganization

SΣ

0..1

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

Unique id for inter-element referencing

0..*

contactpoint-availabletime

Additional content defined by implementations
Slice: Unordered, Open by value:url

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

SΣC

0..1

phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

SΣ

0..1

The actual contact point details

use

?!Σ

0..1

home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

rank

Σ

0..1

Specify preferred order of use (1 = highest)

Σ

0..1

Time period when the contact point was/is in use

Σ

0..1

Interval the endpoint is expected to be operational

payloadType

SΣ

1..1

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

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

Documentation for this format

Usage depends on the channel type

Terminology Bindings

Path Conformance ValueSet / Code URI

Endpoint.meta.security

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

IdentifierUse

http://hl7.org/fhir/ValueSet/identifier-use|4.0.1

from the FHIR Standard

Endpoint.identifier.type

Identifier Type Codes

http://hl7.org/fhir/ValueSet/identifier-type

from the FHIR Standard

Endpoint.status

Fixed Value: active

http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1

from the FHIR Standard

Endpoint.connectionType

EndpointConnectionTypeVS

http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS

from this IG

Endpoint.contact.system

ContactPointSystem

http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1

from the FHIR Standard

Endpoint.contact.use

ContactPointUse

http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1

from the FHIR Standard

Endpoint.payloadType

EndpointPayloadTypeVS

http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS

from this IG

Endpoint.payloadMimeType

Description & Constraints

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)

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

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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		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 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		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
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 .
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)
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
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.
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
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

Snapshot View

Endpoint

0..*

NdhEndpoint

The technical details of an endpoint that can be used for electronic services

id

Σ

0..1

Logical id of this artifact

Meta

Metadata about the resource

id

0..1

Unique id for inter-element referencing

extension

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

versionId

Σ

0..1

Version specific identifier

lastUpdated

Σ

1..1

instant

When the resource version last changed

source

Σ

0..1

canonical(StructureDefinition)

Identifies where the resource comes from

profile

Σ

0..*

Profiles this resource claims to conform to

security

Σ

0..*

Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

tag

Σ

0..*

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

A set of rules under which this content was created

language

0..1

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

0..*

secure-exchange-artifacts

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

0..*

(Complex)

IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig

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

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

Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)

endpoint-rank

0..1

ihe-specific-connection-type

Preferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank

0..*

Reference(NDH Base Restriction) {c }

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

Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction

verification-status

0..1

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

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

Extensions that cannot be ignored

identifier

SΣ

0..*

Identifier

Identifies this endpoint across multiple systems

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

identifier-status

0..1

NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

type

Σ

0..1

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Σ

0..1

The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

Σ

0..1

The value that is unique
Example General: 123456

Σ

0..1

Reference(NDH Base Organization Profile)

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

status

?!SΣ

1..1

connectionType

SΣ

1..1

Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)

name

SΣ

0..1

Reference(Payer Provider Network Query Organization Profile)

A name that this endpoint can be identified by

managingOrganization

SΣ

0..1

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

Unique id for inter-element referencing

0..*

contactpoint-availabletime

Additional content defined by implementations
Slice: Unordered, Open by value:url

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

SΣC

0..1

phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

SΣ

0..1

The actual contact point details

use

?!Σ

0..1

home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

rank

Σ

0..1

Specify preferred order of use (1 = highest)

Σ

0..1

Time period when the contact point was/is in use

Σ

0..1

Interval the endpoint is expected to be operational

payloadType

SΣ

1..1

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

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