National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPnQry-Endpoint | Version: 1.0.0-ballot | |||
| Active as of 2023-07-30 | Computable Name: NdhPnQryEndpoint | |||
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |
  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 | ||||
| Path | Conformance | ValueSet / Code |
| Endpoint.identifier.use | required | IdentifierUse |
| Endpoint.status | required | Fixed Value: active |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVS |
| Endpoint.contact.system | required | ContactPointSystem |
| Endpoint.contact.use | required | ContactPointUse |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVS |
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVS |
| 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| endpoint-usecase | 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 URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |||||
| trust-framework | 0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework | |||||
| dynamic-registration | 0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |||||
| associated-servers | 0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |||||
| access-control-mechanism | 0..1 | CodeableConcept | 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 | 0..* | CodeableConcept | Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: Endpoint Connection Type Version Value Set (extensible) | |||||
| endpoint-rank | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |||||
| ihe-specific-connection-type | 0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint HIE Specific Connection Types Value Set (preferred) | |||||
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| verification-status | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| testing-certification | 0..* | (Complex) | Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(NDH Base Organization Profile) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active | ||||
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | ||||
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 0..1 | Reference(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 | |||||
| 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. | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Endpoint.meta.security | extensible | All Security Labels | ||||
| Endpoint.meta.tag | example | CommonTags | ||||
| Endpoint.language | preferred | CommonLanguages
| ||||
| Endpoint.identifier.use | required | IdentifierUse | ||||
| Endpoint.identifier.type | extensible | Identifier Type Codes | ||||
| Endpoint.status | required | Fixed Value: active | ||||
| Endpoint.connectionType | extensible | EndpointConnectionTypeVS | ||||
| Endpoint.contact.system | required | ContactPointSystem | ||||
| Endpoint.contact.use | required | ContactPointUse | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVS |
This structure is derived from NdhEndpoint
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 | |
| 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
| Path | Conformance | ValueSet / Code |
| Endpoint.identifier.use | required | IdentifierUse |
| Endpoint.status | required | Fixed Value: active |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVS |
| Endpoint.contact.system | required | ContactPointSystem |
| Endpoint.contact.use | required | ContactPointUse |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVS |
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVS |
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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| endpoint-usecase | 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 URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | |||||
| trust-framework | 0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework | |||||
| dynamic-registration | 0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | |||||
| associated-servers | 0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | |||||
| access-control-mechanism | 0..1 | CodeableConcept | 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 | 0..* | CodeableConcept | Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: Endpoint Connection Type Version Value Set (extensible) | |||||
| endpoint-rank | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | |||||
| ihe-specific-connection-type | 0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint HIE Specific Connection Types Value Set (preferred) | |||||
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| verification-status | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| testing-certification | 0..* | (Complex) | Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(NDH Base Organization Profile) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active | ||||
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | ||||
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 0..1 | Reference(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 | |||||
| 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. | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Endpoint.meta.security | extensible | All Security Labels | ||||
| Endpoint.meta.tag | example | CommonTags | ||||
| Endpoint.language | preferred | CommonLanguages
| ||||
| Endpoint.identifier.use | required | IdentifierUse | ||||
| Endpoint.identifier.type | extensible | Identifier Type Codes | ||||
| Endpoint.status | required | Fixed Value: active | ||||
| Endpoint.connectionType | extensible | EndpointConnectionTypeVS | ||||
| Endpoint.contact.system | required | ContactPointSystem | ||||
| Endpoint.contact.use | required | ContactPointUse | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVS |
This structure is derived from NdhEndpoint
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International - Patient Administration Work Group. Package hl7.fhir.us.ndh#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-07-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change