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

FHIR IG Statistics: Basic/RequestVHLDocument

Packageihe.iti.vhl
Resource TypeBasic
IdRequestVHLDocument
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/VHL/https://build.fhir.org/ig/IHE/ITI.VHL/Requirements-RequestVHLDocument.html
URLhttps://profiles.ihe.net/ITI/VHL/Requirements/RequestVHLDocument
Version0.0.2-current
Statusactive
Date2025-06-16T13:14:26+00:00
NameRequestVHLDocument
TitleRequest VHL Document
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 RequestVHLDocument

These requirements apply to the actor VHL Receiver

Retrieve single health documentSHALL

Initiate a request to retrieve a single health document from a VHL Sharer, using a previously received and validated Verified Health Link (VHL)

Verify digital signatureMAY

Verify the digital signature of the returned health document to confirm its authenticity, integrity, and provenance, as defined in the Verify Document Signature requirement

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": "RequestVHLDocument",
  "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/RequestVHLDocument"
    },
    {
      "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": "RequestVHLDocument"
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.title",
      "valueString": "Request VHL Document"
    },
    {
      "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 single health document 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 Receiver MAY verify the digital signature of the returned health document to confirm its authenticity, integrity, and provenance, as defined in the [Verify Document Signature](Requirements-VerifyDocumentSignature.html) requirement.\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-document"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
          "valueString": "Retrieve single health document"
        },
        {
          "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 single health document from a [VHL Sharer](ActorDefinition-VHLSharer.html), using a previously received and validated Verified Health Link (VHL)"
        }
      ],
      "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": "verify-digital-signature"
        },
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
          "valueString": "Verify digital signature"
        },
        {
          "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": "Verify the digital signature of the returned health document to confirm its authenticity, integrity, and provenance, as defined in the [Verify Document Signature](Requirements-VerifyDocumentSignature.html) requirement"
        }
      ],
      "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"
      }
    ]
  }
}