Verifiable Health Link
0.0.2-current - ci-build

Verifiable Health Link, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.2-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.VHL/ and changes regularly. See the Directory of published versions

## : Test Plan – VHL Receiver - JSON Representation

Active as of 2026-03-12

Raw json | Download

    {
      "resourceType" : "TestPlan",
      "id" : "TestPlan-VHLReceiver",
      "url" : "https://profiles.ihe.net/ITI/VHL/TestPlan/TestPlan-VHLReceiver",
      "version" : "0.0.2-current",
      "name" : "TestPlan_VHLReceiver",
      "title" : "Test Plan – VHL Receiver",
      "status" : "active",
      "date" : "2026-03-12T12:40:14+00:00",
      "publisher" : "IHE IT Infrastructure Technical Committee",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
            }
          ]
        },
        {
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        },
        {
          "name" : "IHE IT Infrastructure Technical Committee",
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        }
      ],
      "description" : "Unit test plan for the **VHL Receiver** actor of the IHE ITI Verifiable Health Links (VHL) profile.\n\nScope: validates all behaviour expected of a VHL Receiver across its four transactions:\nsubmitting its own PKI material (ITI-YY1 initiator), retrieving the trust list (ITI-YY2\ninitiator), decoding and validating a VHL QR code (ITI-YY4 responder), and requesting the\ndocument manifest (ITI-YY5 initiator). Each test suite exercises three atomic feature files.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
              "code" : "001"
            }
          ]
        }
      ],
      "scope" : [
        {
          🔗 "reference" : "ActorDefinition/VHLReceiver"
        }
      ],
      "testCase" : [
        {
          "sequence" : 1,
          "testRun" : [
            {
              "narrative" : "**ITI-YY1 Message Semantics** – Shared message format file.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY1-submit-pki-material-message.feature",
                  "display" : "ITI-YY1 Submit PKI Material – Message Semantics"
                }
              }
            },
            {
              "narrative" : "**ITI-YY1 VHL Receiver Initiator Expected Actions** – The VHL Receiver shares the same\ninitiator requirements as the VHL Sharer: key pair generation, submission pathway, provenance\nmetadata, response handling, and private key retention.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY1-submit-pki-material-initiator.feature",
                  "display" : "ITI-YY1 Submit PKI Material – VHL Receiver Initiator Expected Actions"
                }
              }
            },
            {
              "narrative" : "**ITI-YY1 Security Considerations** – Shared security file.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY1-submit-pki-material-security.feature",
                  "display" : "ITI-YY1 Submit PKI Material – Security Considerations"
                }
              }
            }
          ]
        },
        {
          "sequence" : 2,
          "testRun" : [
            {
              "narrative" : "**ITI-YY2 Message Semantics** – Shared message format file.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY2-retrieve-trust-list-message.feature",
                  "display" : "ITI-YY2 Retrieve Trust List – Message Semantics"
                }
              }
            },
            {
              "narrative" : "**ITI-YY2 VHL Receiver Initiator Expected Actions** – Verifies that the VHL Receiver correctly\nconstructs retrieval requests, validates and caches returned DID Documents, maps public keys to\nintended uses, tracks expiry, handles revocation notifications, and processes error responses.\nSource: sections 2:3.YY2.4.1, 2:3.YY2.4.2.3, and 2:3.YY2.5.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY2-retrieve-trust-list-initiator.feature",
                  "display" : "ITI-YY2 Retrieve Trust List – VHL Receiver Initiator Expected Actions"
                }
              }
            },
            {
              "narrative" : "**ITI-YY2 Security Considerations** – Shared security file.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY2-retrieve-trust-list-security.feature",
                  "display" : "ITI-YY2 Retrieve Trust List – Security Considerations"
                }
              }
            }
          ]
        },
        {
          "sequence" : 3,
          "testRun" : [
            {
              "narrative" : "**ITI-YY4 Message Semantics** – Verifies the VHL QR code message format: ISO/IEC 18004:2015\nAlphanumeric mode, HC1: prefix, Base45 encoding, ZLIB/DEFLATE compression, CWT structure\n(protected header: alg/kid, claims: exp/iat/hcert), and SHL payload fields (url/key/flag/exp).",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY4-provide-vhl-message.feature",
                  "display" : "ITI-YY4 Provide VHL – Message Semantics"
                }
              }
            },
            {
              "narrative" : "**ITI-YY4 VHL Receiver Responder Expected Actions** – Verifies the complete nine-step decode\npipeline: QR scanning (ISO/IEC 18004:2015), HC1: verification, Base45 decoding, ZLIB\ndecompression, CWT parsing (RFC 8392), COSE signature verification (RFC 8152) using the\ntrust list, CWT claims validation (exp/iat), hcert extraction (claim key -260 / 5), and SHL\npayload validation (url/key/flag/exp). Also covers post-decoding actions, all decode failure\nrejections, and optional acknowledgment.\nSource: sections 2:3.YY4.4.1.4 (Receiver Expected Actions) and 2:3.YY4.5 (Security).",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY4-provide-vhl-responder.feature",
                  "display" : "ITI-YY4 Provide VHL – VHL Receiver Responder Expected Actions"
                }
              }
            },
            {
              "narrative" : "**ITI-YY4 Security Considerations** – Verifies signature verification requirements, trust list\nenforcement, expiry enforcement, PHI exclusion from the QR payload, and acknowledgment safety.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY4-provide-vhl-security.feature",
                  "display" : "ITI-YY4 Provide VHL – Security Considerations"
                }
              }
            }
          ]
        },
        {
          "sequence" : 4,
          "testRun" : [
            {
              "narrative" : "**ITI-YY5 Message Semantics** – Shared message format file.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY5-retrieve-manifest-message.feature",
                  "display" : "ITI-YY5 Retrieve Manifest – Message Semantics"
                }
              }
            },
            {
              "narrative" : "**ITI-YY5 VHL Receiver Initiator Expected Actions** – Verifies request construction (HTTP POST\n/List/_search), HTTP Message Signature creation (Content-Digest, Signature-Input with keyid/alg/created,\nSignature), OAuth with FAST Option (client_credentials, private_key_jwt, required scopes, Bearer\nheader, token caching), TLS requirements, and Bundle response processing (match/include search.mode,\nindividual DocumentReference retrieval fallback).\nSource: sections 2:3.YY5.4.1 (Request Message) and 2:3.YY5.5.2 (HTTP Message Signatures).",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY5-retrieve-manifest-initiator.feature",
                  "display" : "ITI-YY5 Retrieve Manifest – VHL Receiver Initiator Expected Actions"
                }
              }
            },
            {
              "narrative" : "**ITI-YY5 Security Considerations** – Shared security file.",
              "script" : {
                "language" : {
                  "coding" : [
                    {
                      "system" : "urn:ietf:bcp:13",
                      "code" : "text/x-gherkin"
                    }
                  ],
                  "text" : "Gherkin"
                },
                "sourceReference" : {
                  "reference" : "https://build.fhir.org/ig/IHE/ITI.VHL/ITI-YY5-retrieve-manifest-security.feature",
                  "display" : "ITI-YY5 Retrieve Manifest – Security Considerations"
                }
              }
            }
          ]
        }
      ]
    }