Da Vinci Payer Data Exchange
2.1.0 - STU2 Ballot
Da Vinci Payer Data Exchange
2.1.0 - STU2 Ballot
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
| Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/mtls-endpoint | Version: 2.1.0 | |||
| Standards status: Informative | Computable Name: MtlsEndpoint | |||
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
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
| Path | Conformance | ValueSet | URI |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS | |
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   endpoint-usecase |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| fhir-ig |
0..* | (Complex) | IGs supported URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| trust-framework |
0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| dynamic-registration |
0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| associated-servers |
0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| connection-type-version |
0..* | CodeableConcept | Connection 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 pdex-mtls-signedobject-extension |
S | 1..* | (Complex) | mTLS Signed Object URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
SΣ | 0..* | Identifier | Unique identifier for Payer ele-1: All FHIR elements must have a @value or children |
 Slices for extension |
Content/Rules for all slices | |||
| 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
  assigner |
Σ | 0..1 | Reference(mTLS Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children 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) ele-1: All FHIR elements must have a @value or children |
| name |
SΣ | 0..1 | string | Payer-Payer Exchange ele-1: All FHIR elements must have a @value or children |
| managingOrganization |
SΣ | 0..1 | Reference(mTLS Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children |
| 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) ele-1: All FHIR elements must have a @value or children |
| 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) ele-1: All FHIR elements must have a @value or children |
| address |
Σ | 1..1 | url | The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS | |
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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/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..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) | |||||
| connection-type-version |
0..* | CodeableConcept | Connection 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..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank | |||||
| 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) | |||||
| pdex-mtls-signedobject-extension |
S | 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 |
SΣ | 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 | |||||
| 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 |
?!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 | Payer-Payer Exchange | ||||
| managingOrganization |
SΣ | 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 | |||||
| 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 |
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 |
Σ | 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 | URI | |||
| Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Endpoint.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | ||||
| Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS | ||||
| Endpoint.contact.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Endpoint.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS |
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:
Differential View
This structure is derived from Endpoint
| Path | Conformance | ValueSet | URI |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS | |
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| endpoint-usecase |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| fhir-ig |
0..* | (Complex) | IGs supported URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-fhir-ig ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| secure-exchange-artifacts |
0..* | (Complex) | Secure Exchange Artifacts URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-secureExchangeArtifacts ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| trust-framework |
0..* | (Complex) | Trust Framework URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-trustFramework ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| dynamic-registration |
0..* | (Complex) | Dynamic Registration URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-dynamicRegistration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| associated-servers |
0..* | (Complex) | Associated Servers URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-associatedServers ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| connection-type-version |
0..* | CodeableConcept | Connection 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| pdex-mtls-signedobject-extension |
S | 1..* | (Complex) | mTLS Signed Object URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-mtls-signedobject-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
SΣ | 0..* | Identifier | Unique identifier for Payer ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| 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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| assigner |
Σ | 0..1 | Reference(mTLS Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children 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) ele-1: All FHIR elements must have a @value or children |
| name |
SΣ | 0..1 | string | Payer-Payer Exchange ele-1: All FHIR elements must have a @value or children |
| managingOrganization |
SΣ | 0..1 | Reference(mTLS Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children |
| 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) ele-1: All FHIR elements must have a @value or children |
| 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) ele-1: All FHIR elements must have a @value or children |
| address |
Σ | 1..1 | url | The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS | |
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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/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..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) | |||||
| connection-type-version |
0..* | CodeableConcept | Connection 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..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-endpoint-rank | |||||
| 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) | |||||
| pdex-mtls-signedobject-extension |
S | 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 |
SΣ | 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 | |||||
| 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 |
?!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 | Payer-Payer Exchange | ||||
| managingOrganization |
SΣ | 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 | |||||
| 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 |
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 |
Σ | 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 | URI | |||
| Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Endpoint.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | ||||
| Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS | ||||
| Endpoint.contact.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Endpoint.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS | ||||
| Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS |
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.1.0 based on FHIR 4.0.1. Generated 2024-12-13
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
