National Healthcare Directory Exchange
1.0.0-ballot - ballot
National Healthcare Directory Exchange
1.0.0-ballot - ballot
National Healthcare Directory Exchange, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-exchange/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Endpoint | Version: 1.0.0-ballot | |||
| Active as of 2022-12-08 | Computable Name: NatlDirExEndPoint | |||
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 NatlDirEndpointQryEndpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | 0..* | NatlDirEndpointQryEndpoint | The technical details of an endpoint that can be used for electronic services | |
  extension:associated-servers | S | 0..* | AssociatedServers | Associated Servers |
| extension:secured-endpoint | S | 0..1 | SecureEndpoint | Secure Endpoint |
  identifier | ||||
  assigner | S | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | NatlDirEndpointQryEndpoint | 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| endpoint-usecase | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-usecase | |||||
| ig-supported | S | 0..* | (Complex) | IGs Supported URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported | ||||
| endpoint-type | S | 1..1 | (Complex) | Endpoint Type URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType | ||||
| secure-exchange-artifacts | 0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureExchangeArtifacts | |||||
| trust-framework | 0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/trustFramework | |||||
| dynamic-registration | 0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/dynamicRegistration | |||||
| associated-servers | S | 0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers | ||||
| secured-endpoint | S | 0..1 | boolean | Secure Endpoint URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureEndpoint | ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
  identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
 assigner | SΣ | 0..1 | Reference(Organization) | 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)
| ||||
| managingOrganization | SΣ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| payloadType | Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | ||||
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| address | Σ | 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.payloadType | extensible | EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | NatlDirEndpointQryEndpoint | 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| endpoint-usecase | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-usecase | |||||
| ig-supported | S | 0..* | (Complex) | IGs Supported URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported | ||||
| endpoint-type | S | 1..1 | (Complex) | Endpoint Type URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType | ||||
| secure-exchange-artifacts | 0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureExchangeArtifacts | |||||
| trust-framework | 0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/trustFramework | |||||
| dynamic-registration | 0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/dynamicRegistration | |||||
| associated-servers | S | 0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers | ||||
| secured-endpoint | S | 0..1 | boolean | Secure Endpoint URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureEndpoint | ||||
| 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 | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | SΣ | 0..1 | Reference(Organization) | 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 | Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
| payloadType | Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | ||||
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| address | Σ | 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.payloadType | extensible | EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from NatlDirEndpointQryEndpoint
Differential View
This structure is derived from NatlDirEndpointQryEndpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | NatlDirEndpointQryEndpoint | The technical details of an endpoint that can be used for electronic services | |
| extension:associated-servers | S | 0..* | AssociatedServers | Associated Servers |
| extension:secured-endpoint | S | 0..1 | SecureEndpoint | Secure Endpoint |
| identifier | ||||
| assigner | S | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | NatlDirEndpointQryEndpoint | 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| endpoint-usecase | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-usecase | |||||
| ig-supported | S | 0..* | (Complex) | IGs Supported URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported | ||||
| endpoint-type | S | 1..1 | (Complex) | Endpoint Type URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType | ||||
| secure-exchange-artifacts | 0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureExchangeArtifacts | |||||
| trust-framework | 0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/trustFramework | |||||
| dynamic-registration | 0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/dynamicRegistration | |||||
| associated-servers | S | 0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers | ||||
| secured-endpoint | S | 0..1 | boolean | Secure Endpoint URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureEndpoint | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| assigner | SΣ | 0..1 | Reference(Organization) | 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)
| ||||
| managingOrganization | SΣ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| payloadType | Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | ||||
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| address | Σ | 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.payloadType | extensible | EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | NatlDirEndpointQryEndpoint | 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| endpoint-usecase | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-usecase | |||||
| ig-supported | S | 0..* | (Complex) | IGs Supported URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported | ||||
| endpoint-type | S | 1..1 | (Complex) | Endpoint Type URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType | ||||
| secure-exchange-artifacts | 0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureExchangeArtifacts | |||||
| trust-framework | 0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/trustFramework | |||||
| dynamic-registration | 0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/dynamicRegistration | |||||
| associated-servers | S | 0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers | ||||
| secured-endpoint | S | 0..1 | boolean | Secure Endpoint URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureEndpoint | ||||
| 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 | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | SΣ | 0..1 | Reference(Organization) | 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 | Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
| payloadType | Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | ||||
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| address | Σ | 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.payloadType | extensible | EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from NatlDirEndpointQryEndpoint
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 Patient Administration Working Group. Package hl7.fhir.us.directory-exchange#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-12-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change