Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1 United States of America flag

This page is part of the Da Vinci Health Record Exchange (v1.1.0: STU 1.1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: Da Vinci .well-known File Definition

Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/HRexWellknownDefinition Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: HRexWellknownDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.19.42.21

Definition of the content of the Da Vinci .well-known endpoint

This logical model defines the allowed content of a JSON file that adheres to the expectations for a .well-known file as defined in the Endpoint Discovery part of this IG.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HRexWellknownDefinition 0..* Base Config value passed to service
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..1 HRexIdentifierNamespaced Payer id
... endpoints 1..* Base Endpoints for this payer
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
.... key 1..1 code The endpoint being defined
Binding: HRex Endpoint Name (extensible)
.... value 1..1 uri The value of the config option
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HRexWellknownDefinition.endpoints.keyextensibleHRexEndPointName
http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. HRexWellknownDefinition 0..* Base Config value passed to service
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..1 HRexIdentifierNamespaced Payer id
... endpoints 1..* Base Endpoints for this payer
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
.... key 1..1 code The endpoint being defined
Binding: HRex Endpoint Name (extensible)
.... value 1..1 uri The value of the config option
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HRexWellknownDefinition.endpoints.keyextensibleHRexEndPointName
http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. HRexWellknownDefinition 0..* Base Config value passed to service
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..1 HRexIdentifierNamespaced Payer id
... endpoints 1..* Base Endpoints for this payer
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
.... key 1..1 code The endpoint being defined
Binding: HRex Endpoint Name (extensible)
.... value 1..1 uri The value of the config option
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HRexWellknownDefinition.endpoints.keyextensibleHRexEndPointName
http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name
from this IG

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HRexWellknownDefinition 0..* Base Config value passed to service
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..1 HRexIdentifierNamespaced Payer id
... endpoints 1..* Base Endpoints for this payer
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
.... key 1..1 code The endpoint being defined
Binding: HRex Endpoint Name (extensible)
.... value 1..1 uri The value of the config option
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HRexWellknownDefinition.endpoints.keyextensibleHRexEndPointName
http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HRexWellknownDefinition 0..* Base Config value passed to service
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..1 HRexIdentifierNamespaced Payer id
... endpoints 1..* Base Endpoints for this payer
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
.... key 1..1 code The endpoint being defined
Binding: HRex Endpoint Name (extensible)
.... value 1..1 uri The value of the config option
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HRexWellknownDefinition.endpoints.keyextensibleHRexEndPointName
http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HRexWellknownDefinition 0..* Base Config value passed to service
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..1 HRexIdentifierNamespaced Payer id
... endpoints 1..* Base Endpoints for this payer
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
.... key 1..1 code The endpoint being defined
Binding: HRex Endpoint Name (extensible)
.... value 1..1 uri The value of the config option
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HRexWellknownDefinition.endpoints.keyextensibleHRexEndPointName
http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name
from this IG

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel