Da Vinci Health Record Exchange (HRex)
1.2.0-cibuild - STU 1.1

Da Vinci Health Record Exchange (HRex), published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 1.2.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

## Logical Model: HRexWellknownDefinition - JSON Profile

Page standards status: Trial-use | Maturity Level: 3

JSON representation of the HRexWellknownDefinition logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "HRexWellknownDefinition",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition HRexWellknownDefinition</b></p><a name=\"HRexWellknownDefinition\"> </a><a name=\"hcHRexWellknownDefinition\"> </a><a name=\"HRexWellknownDefinition-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HRexWellknownDefinition-definitions.html#HRexWellknownDefinition\" title=\"A configuration parameter passed to the CRD decision support service\">HRexWellknownDefinition</a><a name=\"HRexWellknownDefinition\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/types.html#Base\">Base</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Config value passed to service<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HRexWellknownDefinition-definitions.html#HRexWellknownDefinition.identifier\" title=\"A unique identifier for the payer associated with this set of endpoints\">identifier</a><a name=\"HRexWellknownDefinition.identifier\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-hrex-identifier-namespaced.html\" title=\"Identifier\">HRexIdentifierNamespaced</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Payer id</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HRexWellknownDefinition-definitions.html#HRexWellknownDefinition.endpoints\" title=\"The set of endpoints to be used for this payer (possibly for a particular coverage type or set of types)\">endpoints</a><a name=\"HRexWellknownDefinition.endpoints\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Base</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Endpoints for this payer<br/>JSON: Represented as a single JSON Object with named properties using the value of the key child as the key<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HRexWellknownDefinition-definitions.html#HRexWellknownDefinition.endpoints.key\" title=\"A code that indicates the name of the endpoint.\">key</a><a name=\"HRexWellknownDefinition.endpoints.key\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The endpoint being defined<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-hrex-endpoint-name.html\" title=\"http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name\">HRex Endpoint Name</a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#extensible\" title=\"To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated.  If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.\">extensible</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HRexWellknownDefinition-definitions.html#HRexWellknownDefinition.endpoints.value\" title=\"The value of the config option\">value</a><a name=\"HRexWellknownDefinition.endpoints.value\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The value of the config option<br/>JSON: The type of this element is inferred from the JSON type in the instance</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "cic"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 3,
          "_valueInteger" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/davinci-hrex"
              }
            ]
          }
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "trial-use",
          "_valueCode" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/davinci-hrex"
              }
            ]
          }
        }
      ],
      "url" : "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/HRexWellknownDefinition",
      "identifier" : [
        {
          "system" : "urn:ietf:rfc:3986",
          "value" : "urn:oid:2.16.840.1.113883.4.642.40.19.42.21"
        }
      ],
      "version" : "1.2.0-cibuild",
      "name" : "HRexWellknownDefinition",
      "title" : "Da Vinci .well-known File Definition",
      "status" : "active",
      "experimental" : false,
      "date" : "2025-04-17T04:19:54+00:00",
      "publisher" : "HL7 International / Clinical Interoperability Council",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/cic"
            }
          ]
        }
      ],
      "description" : "Definition of the content of the Da Vinci .well-known endpoint",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "kind" : "logical",
      "abstract" : false,
      "type" : "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/HRexWellknownDefinition",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
      "derivation" : "specialization",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "4.0.1"
          }
        ],
        "element" : [
          {
            "id" : "HRexWellknownDefinition",
            "path" : "HRexWellknownDefinition",
            "short" : "Config value passed to service",
            "definition" : "A configuration parameter passed to the CRD decision support service",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Base",
              "min" : 0,
              "max" : "*"
            },
            "isModifier" : false
          },
          {
            "id" : "HRexWellknownDefinition.identifier",
            "path" : "HRexWellknownDefinition.identifier",
            "short" : "Payer id",
            "definition" : "A unique identifier for the payer associated with this set of endpoints",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "HRexWellknownDefinition.identifier",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Identifier",
                "profile" : [
                  🔗 "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-identifier-namespaced"
                ]
              }
            ]
          },
          {
            "id" : "HRexWellknownDefinition.endpoints",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
                "valueCode" : "key"
              }
            ],
            "path" : "HRexWellknownDefinition.endpoints",
            "short" : "Endpoints for this payer",
            "definition" : "The set of endpoints to be used for this payer (possibly for a particular coverage type or set of types)",
            "min" : 1,
            "max" : "*",
            "base" : {
              "path" : "HRexWellknownDefinition.endpoints",
              "min" : 1,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Base"
              }
            ]
          },
          {
            "id" : "HRexWellknownDefinition.endpoints.key",
            "path" : "HRexWellknownDefinition.endpoints.key",
            "short" : "The endpoint being defined",
            "definition" : "A code that indicates the name of the endpoint.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "HRexWellknownDefinition.endpoints.key",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "binding" : {
              "strength" : "extensible",
              "valueSet" : "http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name"
            }
          },
          {
            "id" : "HRexWellknownDefinition.endpoints.value",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice",
                "valueBoolean" : true
              }
            ],
            "path" : "HRexWellknownDefinition.endpoints.value",
            "short" : "The value of the config option",
            "definition" : "The value of the config option",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "HRexWellknownDefinition.endpoints.value",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "uri"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "HRexWellknownDefinition",
            "path" : "HRexWellknownDefinition",
            "short" : "Config value passed to service",
            "definition" : "A configuration parameter passed to the CRD decision support service",
            "min" : 0,
            "max" : "*"
          },
          {
            "id" : "HRexWellknownDefinition.identifier",
            "path" : "HRexWellknownDefinition.identifier",
            "short" : "Payer id",
            "definition" : "A unique identifier for the payer associated with this set of endpoints",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "Identifier",
                "profile" : [
                  🔗 "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-identifier-namespaced"
                ]
              }
            ]
          },
          {
            "id" : "HRexWellknownDefinition.endpoints",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
                "valueCode" : "key"
              }
            ],
            "path" : "HRexWellknownDefinition.endpoints",
            "short" : "Endpoints for this payer",
            "definition" : "The set of endpoints to be used for this payer (possibly for a particular coverage type or set of types)",
            "min" : 1,
            "max" : "*",
            "type" : [
              {
                "code" : "Base"
              }
            ]
          },
          {
            "id" : "HRexWellknownDefinition.endpoints.key",
            "path" : "HRexWellknownDefinition.endpoints.key",
            "short" : "The endpoint being defined",
            "definition" : "A code that indicates the name of the endpoint.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "code"
              }
            ],
            "binding" : {
              "strength" : "extensible",
              "valueSet" : "http://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-endpoint-name"
            }
          },
          {
            "id" : "HRexWellknownDefinition.endpoints.value",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice",
                "valueBoolean" : true
              }
            ],
            "path" : "HRexWellknownDefinition.endpoints.value",
            "short" : "The value of the config option",
            "definition" : "The value of the config option",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "uri"
              }
            ]
          }
        ]
      }
    }