Da Vinci Payer Data Exchange
2.1.0 - STU2 United States of America flag

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

Resource Profile: mTLS Endpoint

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/mtls-endpoint Version: 2.1.0
Active as of 2024-02-23 Computable Name: MtlsEndpoint

The mTLS Endpoint is used to assist payers in defining their mTLS endpoints and discovering other Payer’s mTLS endpoints

Usage:

Formal Views of Profile Content

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

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... pdex-mtls-signedobject-extension S1..*(Complex)mTLS Signed Object
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension
... identifier S0..*IdentifierUnique identifier for Payer
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(mTLS Organization)Organization that issued id (may be just text)
... status S1..1codeactive | suspended | error | off | entered-in-error | test
Fixed Value: active
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name S0..1stringPayer-Payer Exchange
... managingOrganization S0..1Reference(mTLS Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-contactpoint-availabletime
... payloadType 1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType S0..*codeMimetype 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... pdex-mtls-signedobject-extension S1..*(Complex)mTLS Signed Object
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier for Payer
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(mTLS Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringPayer-Payer Exchange
... managingOrganization SΣ0..1Reference(mTLS Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType Σ1..1CodeableConceptThe 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..*codeMimetype 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 Σ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... pdex-mtls-signedobject-extension S1..*(Complex)mTLS Signed Object
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier for Payer
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(mTLS Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringPayer-Payer Exchange
... managingOrganization SΣ0..1Reference(mTLS Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-contactpoint-availabletime
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType Σ1..1CodeableConceptThe 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..*codeMimetype 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 Σ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS
from this IG

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... pdex-mtls-signedobject-extension S1..*(Complex)mTLS Signed Object
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension
... identifier S0..*IdentifierUnique identifier for Payer
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(mTLS Organization)Organization that issued id (may be just text)
... status S1..1codeactive | suspended | error | off | entered-in-error | test
Fixed Value: active
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name S0..1stringPayer-Payer Exchange
... managingOrganization S0..1Reference(mTLS Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-contactpoint-availabletime
... payloadType 1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType S0..*codeMimetype 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... pdex-mtls-signedobject-extension S1..*(Complex)mTLS Signed Object
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier for Payer
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(mTLS Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringPayer-Payer Exchange
... managingOrganization SΣ0..1Reference(mTLS Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType Σ1..1CodeableConceptThe 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..*codeMimetype 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 Σ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... pdex-mtls-signedobject-extension S1..*(Complex)mTLS Signed Object
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier for Payer
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(mTLS Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringPayer-Payer Exchange
... managingOrganization SΣ0..1Reference(mTLS Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-contactpoint-availabletime
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType Σ1..1CodeableConceptThe 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..*codeMimetype 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 Σ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS
from this IG

 

Other representations of profile: CSV, Excel, Schematron