Da Vinci Payer Data Exchange
2.2.1 - STU 2.2
Da Vinci Payer Data Exchange
2.2.1 - STU 2.2
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.2.1 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
| Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/mtls-endpoint | Version: 2.2.1 | |||
| Standards status: Informative | Computable Name: MtlsEndpoint | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.8.42.26 | ||||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
The mTLS Endpoint is used to assist payers in defining their mTLS endpoints and discovering other Payer's mTLS endpoints
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  Endpoint |
0..* | Endpoint | 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 | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:endpoint-usecase |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase | |||||
| extension:fhir-ig |
0..* | (Complex) | IGs supported URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig | |||||
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts | |||||
| extension:trust-framework |
0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework | |||||
| extension:dynamic-registration |
0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration | |||||
| extension:associated-servers |
0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers | |||||
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access Control Mechanism URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |||||
| extension: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) | |||||
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank | |||||
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
 extension:pdex-mtls-signedobject-extension |
1..* | (Complex) | mTLS Signed Object URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Unique identifier for Payer | |||||
| 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 | |||||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/davinci-pdex/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(mTLS Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |||||
| name |
0..1 | string | Payer-Payer Exchange | |||||
| managingOrganization |
0..1 | Reference(mTLS 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) | |||||
| 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 | |||||
| extension:contactpoint-availabletime |
0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-contactpoint-availabletime | |||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
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 |
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 |
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 |
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 | Status | Usage | ValueSet | Version | Source |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
Summary
Mandatory: 2 elements
Must-Support: 7 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Endpoint
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | 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 | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:endpoint-usecase |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase | |||||
| extension:fhir-ig |
0..* | (Complex) | IGs supported URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig | |||||
| extension:secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts | |||||
| extension:trust-framework |
0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework | |||||
| extension:dynamic-registration |
0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration | |||||
| extension:associated-servers |
0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers | |||||
| extension:access-control-mechanism |
0..1 | CodeableConcept | Access Control Mechanism URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | |||||
| extension: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) | |||||
| extension:endpoint-rank |
0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank | |||||
| extension:verification-status |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| extension:pdex-mtls-signedobject-extension |
1..* | (Complex) | mTLS Signed Object URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Unique identifier for Payer | |||||
| 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 | |||||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/davinci-pdex/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(mTLS Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
| connectionType |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | |||||
| name |
0..1 | string | Payer-Payer Exchange | |||||
| managingOrganization |
0..1 | Reference(mTLS 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) | |||||
| 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 | |||||
| extension:contactpoint-availabletime |
0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-contactpoint-availabletime | |||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
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 |
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 |
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 |
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 | Status | Usage | ValueSet | Version | Source |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Endpoint.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Endpoint.payloadMimeType | Base | required | Endpoint FHIR Mimetype Value Set | 📦1.0.0 | National Directory of Healthcare Providers & Services v1.0 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
Summary
Mandatory: 2 elements
Must-Support: 7 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex#2.2.1 based on FHIR 4.0.1. Generated 2026-11-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
