FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: Basic/RequestVHLDocuments

Packageihe.iti.vhl
Resource TypeBasic
IdRequestVHLDocuments
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/VHL/https://build.fhir.org/ig/IHE/ITI.VHL/Requirements-RequestVHLDocuments.html
URLhttps://profiles.ihe.net/ITI/VHL/Requirements/RequestVHLDocuments
Version0.0.2-current
Statusactive
Date2025-06-16T13:14:26+00:00
NameRequestVHLDocuments
TitleRequest VHL Documents
Realmuv
Authorityihe

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: Requirements RequestVHLDocuments

These requirements apply to the actor VHL Receiver

Retrieve health documentsSHALL

Initiate a request to retrieve a set of health documents

Initiate mTLS connectionSHALL

Initiate mTLS connection and validate participation in the trust network using PKI material published by the trust anchor.

Record audit eventMAY

Record an audit event documenting the access request by the Receiver, in accordance with the Audit Event – Received Health Data requirement


Source

{
  "resourceType": "Basic",
  "id": "RequestVHLDocuments",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.url",
      "valueUri": "https://profiles.ihe.net/ITI/VHL/Requirements/RequestVHLDocuments"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.version",
      "valueString": "0.0.2-current"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.name",
      "valueString": "RequestVHLDocuments"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.title",
      "valueString": "Request VHL Documents"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.status",
      "valueCode": "active"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.date",
      "valueDateTime": "2025-06-16T13:14:26+00:00"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.publisher",
      "valueString": "IHE IT Infrastructure Technical Committee"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact",
      "valueContactDetail": {
        "telecom": [
          {
            "system": "url",
            "value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact",
      "valueContactDetail": {
        "telecom": [
          {
            "system": "email",
            "value": "iti@ihe.net"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact",
      "valueContactDetail": {
        "name": "IHE IT Infrastructure Technical Committee",
        "telecom": [
          {
            "system": "email",
            "value": "iti@ihe.net"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.description",
      "valueMarkdown": "The [VHL Receiver](ActorDefinition-VHLReceiver.html) SHALL initiate a request to retrieve a set of health documents from a [VHL Sharer](ActorDefinition-VHLSharer.html), using a previously received and validated Verified Health Link (VHL).\n\nThis transaction SHALL be conducted over a mutually authenticated TLS (mTLS) channel. Both the Receiver and Sharer SHALL validate each other's participation in the trust network using PKI material published by the [Trust Anchor](ActorDefinition-TrustAnchor.html).\n\n**Optional behaviors:**\n* The VHL Sharer MAY record an audit event documenting the access request by the Receiver, in accordance with the [Audit Event – Received Health Data](Requirements-AuditEventReceived.html) requirement."
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.jurisdiction",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
            "code": "001"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.actor",
      "valueCanonical": "https://profiles.ihe.net/ITI/VHL/ActorDefinition/VHLReceiver"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
          "valueId": "retrieve-health-documents"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
          "valueString": "Retrieve health documents"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
          "valueCode": "SHALL"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
          "valueMarkdown": "Initiate a request to retrieve a set of health documents"
        }
      ],
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
          "valueId": "initiate-mTLS-connection"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
          "valueString": "Initiate mTLS connection"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
          "valueCode": "SHALL"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
          "valueMarkdown": "Initiate mTLS connection and validate participation in the trust network using PKI material published by the trust anchor."
        }
      ],
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
          "valueId": "record-audit-event"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
          "valueString": "Record audit event"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
          "valueCode": "MAY"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
          "valueMarkdown": "Record an audit event documenting the access request by the Receiver, in accordance with the [Audit Event – Received Health Data](Requirements-AuditEventReceived.html) requirement"
        }
      ],
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/fhir-types",
        "code": "Requirements"
      }
    ]
  }
}