Patsiendi elulõpu tahteavaldus, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-pet/ and changes regularly. See the Directory of published versions

PET FHIR API

PET FHIR API

PET FHIR API

This page describes the public FHIR R5 contract of the PET (patient's end-of-life directive) service. It is derived from the current PET CapabilityStatement and the operation definitions maintained by the service. The runtime GET /ahd/fhir/metadata response remains the authoritative list of capabilities deployed in a particular environment.

Base URL and media type

The FHIR endpoint is available below the service context path:

https://{environment-host}/ahd/fhir

Requests and responses use application/fhir+json. Calls are protected by the upTIS security layer and must carry the authorization and X-Road tracing headers required by the environment. Bundle transaction and batch interactions are not supported.

Supported resources and interactions

QuestionnaireResponse (PET)

Profile: AHD content

Method and path	Description	Main business rules
`GET /QuestionnaireResponse/{id}`	Read the current PET version (UC-AHD-052).	The caller must be entitled to access the patient.
`GET /QuestionnaireResponse/{id}/_history/{versionId}`	Read a specific PET version (UC-AHD-052).	Both PET id and version id are mandatory.
`POST /QuestionnaireResponse`	Create a pre-filled PET (UC-AHD-050).	Body must conform to the AHD content profile and the patient/session rules.
`PUT /QuestionnaireResponse/{id}`	Update a pre-filled PET (UC-AHD-050).	Path id and resource id must identify the same PET; only a permitted pre-filled state may be changed.
`DELETE /QuestionnaireResponse/{id}`	Delete a pre-filled PET (UC-AHD-051).	Only the state permitted by the PET business rules can be deleted.
`GET /QuestionnaireResponse`	Search PETs (UC-AHD-052).	At least `patient` or `_id` is required.
`POST /QuestionnaireResponse/$complete`	Confirm a new PET (UC-AHD-055).	Input contains exactly one `bundle` (paper) or `signedBinary` (digital) parameter.
`POST /QuestionnaireResponse/{id}/$complete`	Confirm an existing PET (UC-AHD-055).	Input contains exactly one `bundle` (paper) or `signedBinary` (digital) parameter.
`POST /QuestionnaireResponse/{id}/$cancel`	Cancel a confirmed PET (UC-AHD-056).	No input parameters; creates a new version with `entered-in-error`.

Operations: PET confirmation and PET cancellation.

Search parameters:

Parameter	Cardinality	Description
`patient`	`0..1`	MPI id as `123` or `Patient/123`. Supports chained `patient.identifier`. Required when `_id` is absent.
`status`	`0..*`	`in-progress`, `completed` or `entered-in-error`, subject to caller role. Multiple values are comma-separated.
`_id`	`0..1`	PET logical id, for example `ahd123`. Required when `patient` is absent.
`_count`	`0..1`	Page size; default 20, maximum 200. `_count=0` returns only the total.
`_page`	`0..1`	One-based page number.
`_summary`	`0..1`	`true` or `false`. `true` omits answers and tags the result `SUBSETTED`.
`_sort`	`0..1`	`_lastUpdated` (alias `date`) and `_id`; comma-separated keys are supported and `-` selects descending order.
`_revinclude`	`0..1`	Supported value: `Provenance:target`; includes the PET signature metadata when available.

QuestionnaireResponse does not support filtering by _lastUpdated; that field is available only as a sort key. _profile is not supported.

Unsupported _include, _elements, _contained and _containedType parameters produce an OperationOutcome. Other _revinclude values are rejected.

Observation (counselling decision)

Profile: AHD counselling result

Method and path	Description	Main business rules
`POST /Observation`	Register a counselling decision.	Body must conform to the counselling-result profile and the patient/session rules.
`GET /Observation`	Search counselling decisions (UC-AHD-054).	`patient` is mandatory.

Search parameters:

Parameter	Cardinality	Description
`patient`	`1..1`	MPI id or chained `patient.identifier`.
`_lastUpdated`	`0..1`	Supports `ge` and `gt`, for example `_lastUpdated=ge2026-05-01`.
`last`	`0..1`	Custom parameter. `last=true` returns only the latest valid decision. See AHD counselling last.

Task (trusted-person invitation)

Profile: Trusted-person request Task

Method and path	Description	Main business rules
`POST /Task`	Create a trusted-person invitation (UC-AHD-057).	The invitation must identify its PET/patient and requested performer.
`GET /Task`	Search invitations (UC-AHD-059).	Caller-specific required parameters apply; see below.
`DELETE /Task/{id}`	Delete an invitation (UC-AHD-072).	Only an invitation in a removable state may be deleted.
`POST /Task/{id}/$complete`	Accept an invitation (UC-AHD-060).	Requires one digitally signed `signedBinary`; environments without digital signing return HTTP 501.
`POST /Task/{id}/$reject`	Reject an invitation (UC-AHD-060).	No input parameters.

Operations: Invitation acceptance and Invitation rejection.

Search parameters:

Parameter	Cardinality	Description
`patient`	`0..1`	Required for a patient, representative or healthcare-worker query when `ahd-questionnaire-response-id` is absent.
`status`	`0..*`	`requested`, `completed` or `rejected`; comma-separated values are accepted.
`requestedperformer-reference`	`0..1`	Invitation recipient as `RelatedPerson/{id}` or chained `.identifier`; required when the recipient queries invitations.
`ahd-questionnaire-response-id`	`0..1`	PET id. Custom parameter documented as AHD QuestionnaireResponse id.
`_lastUpdated`	`0..1`	Supports `ge` and `gt`.

RelatedPerson (trusted person)

Profile: AHD trusted person

Method and path	Description	Main business rules
`GET /RelatedPerson/{id}`	Read a trusted person (UC-AHD-061).	Caller must be entitled to the related patient.
`GET /RelatedPerson`	Search trusted persons (UC-AHD-061).	Required parameter depends on caller role.
`DELETE /RelatedPerson/{id}`	Remove a trusted person (UC-AHD-062).	Removal follows PET validity and authorization rules.
`POST /RelatedPerson/$confirm`	Healthcare worker confirms a paper-signed trusted person (UC-AHD-058).	Requires one collection `bundle` containing RelatedPerson and Provenance.

Operation: Trusted-person confirmation.

Search parameters:

Parameter	Cardinality	Description
`patient`	`0..1`	Patient MPI id or chained `patient.identifier`; required for patient/representative/healthcare-worker searches when PET id is absent.
`identifier`	`0..1`	Personal id or `RelatedPerson/{id}`; required when a trusted person searches for themself.
`active`	`0..1`	Healthcare workers may query only active trusted persons (`active=true`).
`ahd-questionnaire-response-id`	`0..1`	PET id custom parameter.
`_revinclude`	`0..1`	Supported value: `Provenance:target`.

Provenance (signature metadata)

Profiles: Trusted-person signature Provenance and PET signature Provenance

Method and path	Description	Main business rules
`GET /Provenance`	Search PET or trusted-person signature metadata (UC-AHD-052 and UC-AHD-061).	At least `target` or `_id` is required.

Search parameters:

Parameter	Cardinality	Description
`target`	`0..1`	Signed `QuestionnaireResponse/{id}` or `RelatedPerson/{id}`. Chained RelatedPerson identifier, patient and active parameters are supported for trusted-person searches.
`_id`	`0..1`	Provenance logical id; required when `target` is absent.
`_include`	`0..*`	`Provenance:entity:Binary` for either target type and `Provenance:target:RelatedPerson` for trusted-person searches.

Patient appears in the CapabilityStatement only to resolve chained patient.identifier searches. PET does not expose Patient resource interactions.

Digital signing stage

Digital completion of a PET and digital acceptance of a trusted-person invitation use an ASiC-E container in the signedBinary parameter. In the packaged stage-1 mock configuration (AHD_STAGE1_MOCK=true), the service parses the container without DigiDoc signature verification and stores it locally instead of DRIT. This mode is for stage-1 development and must not be treated as production signature validation. If the mock is disabled before the stage-2 DigiDoc and DRIT integrations are available, these digital operations fail closed with HTTP 501.

Common behavior and business rules

Every interaction is authorized separately for the patient, representative, healthcare-worker, or trusted-person role. Access to one patient's resource does not grant access to another patient.
Patient references are checked against the caller's session and MPI identity.
PET update and deletion are limited to permitted pre-filled states. Confirmation and cancellation create new history instead of rewriting signed versions.
Counselling decisions must identify the same patient and satisfy the counselling profile and decision rules.
Invitation operations enforce recipient, caller-role, PET-validity, and current status rules. Only the addressed trusted person can accept or reject an invitation.
Paper-signing Bundles contain the matching business resource and Provenance. Digital calls contain an ASiC-E Binary and follow the stage limitation above.
Invalid input and business-rule failures return an OperationOutcome. Successful deletes return HTTP 200 or 204 without a body, depending on the FHIR adapter; successful PET cancellation returns HTTP 200 without a FHIR response body.

Endpoint example coverage

The examples below cover every distinct request and response shape. Interactions that share a FHIR shape intentionally reuse the same example.

Interactions	Example or response shape
QuestionnaireResponse read, version-read, create, and update	Create a pre-filled PET; the response is the stored QuestionnaireResponse with id and version metadata.
QuestionnaireResponse, Task, and RelatedPerson delete	HTTP 200 or 204 with no body after the resource-specific authorization and state checks.
QuestionnaireResponse search	Search PETs, returning a searchset Bundle.
QuestionnaireResponse paper and digital confirmation	The endpoint selects a new or existing PET; exactly one paper `bundle` or digital `signedBinary` selects the signing variant. Digital completion additionally returns a Binary reference.
QuestionnaireResponse cancellation	Cancel a PET, returning HTTP 200 with no body.
Observation create and search	Register a counselling decision; search returns a searchset Bundle containing the same Observation shape.
Task create and search	A profile-conformant request Task is returned with HTTP 201; search returns those Task resources in a searchset Bundle.
Task accept and reject	Search and accept a trusted-person invitation; reject has no input and returns `task` and `trustedPerson` references.
RelatedPerson read and search	The paper-confirmation RelatedPerson shape is returned directly or inside a searchset Bundle.
RelatedPerson paper confirmation	Confirm a paper-signed trusted person, returning `relatedPerson` and `provenance` references.
Provenance search and includes	A searchset Bundle contains matching Provenance entries; requested Binary or RelatedPerson includes use search mode `include`.
All validation and business-rule failures	OperationOutcome, interpreted together with the HTTP status.

Request and response examples

The examples below are trimmed, illustrative excerpts. Production request bodies must conform to the linked profiles, and requests must include the environment-specific authorization and tracing headers.

Search PETs

GET /ahd/fhir/QuestionnaireResponse?patient=Patient/123&status=completed&_count=20&_sort=-_lastUpdated&_revinclude=Provenance:target HTTP/1.1
Accept: application/fhir+json

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [{
    "fullUrl": "https://example.test/ahd/fhir/QuestionnaireResponse/ahd123",
    "resource": {
      "resourceType": "QuestionnaireResponse",
      "id": "ahd123",
      "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-content"] },
      "questionnaire": "https://fhir.ee/qre/Questionnaire-AHD|1.0.0",
      "status": "completed",
      "subject": { "reference": "Patient/123" },
      "author": { "reference": "Patient/123" },
      "language": "et"
    }
  }]
}

Create a pre-filled PET

POST /ahd/fhir/QuestionnaireResponse HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "QuestionnaireResponse",
  "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-content"] },
  "questionnaire": "https://fhir.ee/qre/Questionnaire-AHD|1.0.0",
  "status": "in-progress",
  "subject": { "reference": "Patient/123" },
  "author": { "reference": "Patient/123" },
  "language": "et"
}

HTTP/1.1 201 Created
Content-Type: application/fhir+json
Location: /ahd/fhir/QuestionnaireResponse/ahd123/_history/1

The response body is the stored QuestionnaireResponse with its assigned id, version and update time.

Confirm a digitally signed PET

POST /ahd/fhir/QuestionnaireResponse/ahd123/$complete HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [{
    "name": "signedBinary",
    "resource": {
      "resourceType": "Binary",
      "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-signed-binary"] },
      "contentType": "application/vnd.etsi.asic-e+zip",
      "data": "UEsDBBQAAAAAALR8IV2KIflFHwAAAB8AAAAIAAAAbWltZXR5cGVhcHBsaWNhdGlvbi92bmQuZXRzaS5hc2ljLWUremlwUEsDBBQAAAAIALR8IV2zYavh6wAAAJgBAAAaAAAAcXVlc3Rpb25uYWlyZXJlc3BvbnNlLmpzb26UkDFPwzAUhP/LzW7SwuYN1IGRAlvVwSSXxMi10+dnRBXy35E3kJAQ693pO90tEOZUpOPLdSYsDoVZfYrReeET85xiJgx8Dws39bubWxicqQ52wSxp8IGwR0yqc7ZtO0xeGrJ1U98+q5ROi3DPwUdfuVXfdCkqo+K0GvBDGbNPEfa4oEiA/Rcr+zGy3/R+9OpCuMLg3YXC+5QCXYRVKVxPBpfvy34puQjbH+s3dw/7z12zbbYwyOq0ZFh06TwHKvsqltc3dlqfEA4Uxq6SH516Rm3rV6uBKzol+SMUXByLG6tDxfoFAAD//wMAUEsBAhQAFAAAAAAAtHwhXYoh+UUfAAAAHwAAAAgAAAAAAAAAAAAAAAAAAAAAAG1pbWV0eXBlUEsBAhQAFAAAAAgAtHwhXbNhq+HrAAAAmAEAABoAAAAAAAAAAAAAAAAARQAAAHF1ZXN0aW9ubmFpcmVyZXNwb25zZS5qc29uUEsFBgAAAAACAAIAfgAAAGgBAAAAAA=="
    }
  }]
}

Digital confirmation returns the completed PET, signing Provenance, and stored ASiC-E Binary references:

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "questionnaireResponse", "valueReference": { "reference": "QuestionnaireResponse/ahd123/_history/2" } },
    { "name": "provenance", "valueReference": { "reference": "Provenance/ahd456/_history/1" } },
    { "name": "signedBinary", "valueReference": { "reference": "Binary/ahd789/_history/1" } }
  ]
}

For a new paper-signed PET, call the type-level /QuestionnaireResponse/$complete operation and supply the profile-conformant collection Bundle. Either endpoint accepts exactly one bundle or signedBinary; the endpoint determines whether the PET is new or existing, while the parameter determines the signing variant:

{
  "resourceType": "Parameters",
  "parameter": [{
    "name": "bundle",
    "resource": {
      "resourceType": "Bundle",
      "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-signed-bundle"] },
      "type": "collection",
      "timestamp": "2026-08-31T10:05:00Z",
      "entry": [
        {
          "fullUrl": "urn:uuid:11111111-1111-4111-8111-111111111111",
          "resource": {
            "resourceType": "QuestionnaireResponse",
            "id": "ahd123",
            "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-content"] },
            "questionnaire": "https://fhir.ee/qre/Questionnaire-AHD|1.0.0",
            "status": "completed",
            "subject": { "reference": "Patient/123" },
            "author": { "reference": "Patient/123" },
            "language": "et"
          }
        },
        {
          "fullUrl": "urn:uuid:33333333-3333-4333-8333-333333333333",
          "resource": {
            "resourceType": "Provenance",
            "id": "pet-signature",
            "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-signature-provenance"] },
            "target": [{ "reference": "urn:uuid:11111111-1111-4111-8111-111111111111" }],
            "occurredDateTime": "2026-08-31T10:05:00Z",
            "patient": { "reference": "Patient/123" },
            "agent": [{
              "role": [{ "coding": [{
                "system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
                "code": "datasubject"
              }] }],
              "who": { "reference": "Patient/123" }
            }]
          }
        }
      ]
    }
  }]
}

Paper confirmation returns only the completed PET and signing Provenance references:

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "questionnaireResponse", "valueReference": { "reference": "QuestionnaireResponse/ahd123/_history/1" } },
    { "name": "provenance", "valueReference": { "reference": "Provenance/ahd456/_history/1" } }
  ]
}

Cancel a PET

POST /ahd/fhir/QuestionnaireResponse/ahd123/$cancel HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "Parameters"
}

HTTP/1.1 200 OK

The operation creates a new QuestionnaireResponse version with status entered-in-error and returns an empty body.

Register a counselling decision

POST /ahd/fhir/Observation HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "Observation",
  "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-counseling-result"] },
  "status": "final",
  "code": { "text": "Luba kinnitada PET" },
  "subject": { "reference": "Patient/123" },
  "effectiveInstant": "2026-08-31T10:00:00+03:00",
  "performer": [{ "reference": "PractitionerRole/77" }],
  "valueBoolean": true
}

Successful creation returns HTTP 201 and the stored Observation with its assigned id and version metadata.

Search and accept a trusted-person invitation

GET /ahd/fhir/Task?requestedperformer-reference.identifier=https://fhir.ee/sid/pid/est/ni|{national-id}&status=requested HTTP/1.1
Accept: application/fhir+json

The response is a searchset Bundle of matching Task resources. To accept an invitation:

POST /ahd/fhir/Task/ahd321/$complete HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [{
    "name": "signedBinary",
    "resource": {
      "resourceType": "Binary",
      "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee-signed-binary"] },
      "contentType": "application/vnd.etsi.asic-e+zip",
      "data": "UEsDBBQAAAAAAKtiIV2KIflFHwAAAB8AAAAIAAAAbWltZXR5cGVhcHBsaWNhdGlvbi92bmQuZXRzaS5hc2ljLWUremlwUEsDBBQAAAAIAKtiIV2UrmR9KgEAAFwCAAASAAAAcmVsYXRlZHBlcnNvbi5qc29unZHNTsMwEITfZc8JTsuPVF/LGUrLrcrBiidkpdQO9rqiqvLuyGkLCCEkuHlnteNvdo8UEH0KDZ4PA0jTGr0R2BVC9I4KYkuaTGcXVUUF7SCG9JGG4FvuQXpLncgQtVJtx+EKUKazaiMhNZIC7tGyY2Hvsl5KSFEAqseC8CZwkb0jvT1SCj3pP3m9JsRcOMMBZUAcvIv50SLANaCC9qZPWH8I+kifXU1PXw3W5/lsPZtf0zgW/4E6ByyjGEnxgrD0Nn/Y+N3QQ2BprAsyjfAepCUkFDQYYTj5zrg6yWpCyseAE24ZYVpaPETB7gfEyFYNbBWiKMcXDNJ0s6iqeTWrFne3E0TI12bvYsfDZNl4y+7ld/ccZzM1le+x4zLC56zNKeby8YHGeqzHd1BLAQIUABQAAAAAAKtiIV2KIflFHwAAAB8AAAAIAAAAAAAAAAAAAAAAAAAAAABtaW1ldHlwZVBLAQIUABQAAAAIAKtiIV2UrmR9KgEAAFwCAAASAAAAAAAAAAAAAAAAAEUAAAByZWxhdGVkcGVyc29uLmpzb25QSwUGAAAAAAIAAgB2AAAAnwEAAAAA"
    }
  }]
}

The result contains version-specific references:

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "task", "valueReference": { "reference": "Task/ahd321/_history/2" } },
    { "name": "relatedPerson", "valueReference": { "reference": "RelatedPerson/ahd900/_history/1" } },
    { "name": "provenance", "valueReference": { "reference": "Provenance/ahd901/_history/1" } },
    { "name": "signedBinary", "valueReference": { "reference": "Binary/ahd902/_history/1" } }
  ]
}

Confirm a paper-signed trusted person

POST /ahd/fhir/RelatedPerson/$confirm HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [{
    "name": "bundle",
    "resource": {
      "resourceType": "Bundle",
      "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee-signed-bundle"] },
      "type": "collection",
      "timestamp": "2026-08-31T10:05:00Z",
      "entry": [
        {
          "fullUrl": "urn:uuid:22222222-2222-4222-8222-222222222222",
          "resource": {
            "resourceType": "RelatedPerson",
            "id": "ahd900",
            "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee"] },
            "extension": [
              {
                "url": "https://fhir.ee/ahd/StructureDefinition/ahd-questionnaire-response-reference",
                "valueReference": { "reference": "QuestionnaireResponse/ahd123" }
              },
              {
                "url": "https://fhir.ee/ahd/StructureDefinition/ahd-trustee-status",
                "valueCode": "completed"
              }
            ],
            "identifier": [{ "system": "https://fhir.ee/sid/pid/est/ni", "value": "49002010965" }],
            "active": true,
            "patient": { "reference": "Patient/123" },
            "relationship": [{
              "coding": [{ "system": "https://fhir.ee/CodeSystem/olemi-seos", "code": "CON" }]
            }]
          }
        },
        {
          "fullUrl": "urn:uuid:33333333-3333-4333-8333-333333333333",
          "resource": {
            "resourceType": "Provenance",
            "id": "trustee-signature",
            "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee-signature-provenance"] },
            "target": [{ "reference": "urn:uuid:22222222-2222-4222-8222-222222222222" }],
            "occurredDateTime": "2026-08-31T10:05:00Z",
            "patient": { "reference": "Patient/123" },
            "agent": [{
              "role": [{ "coding": [{
                "system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
                "code": "datasubject"
              }] }],
              "who": { "reference": "urn:uuid:22222222-2222-4222-8222-222222222222" }
            }]
          }
        }
      ]
    }
  }]
}

The result contains version-specific references:

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "relatedPerson", "valueReference": { "reference": "RelatedPerson/ahd900/_history/1" } },
    { "name": "provenance", "valueReference": { "reference": "Provenance/ahd901/_history/1" } }
  ]
}

Create and search trusted-person invitations

POST /ahd/fhir/Task HTTP/1.1
Content-Type: application/fhir+json

{
  "resourceType": "Task",
  "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/trustee-request-task"] },
  "status": "requested",
  "intent": "proposal",
  "code": { "text": "Usaldusisikuks olemise kinnitamine" },
  "focus": { "reference": "RelatedPerson/ahd900" },
  "for": { "reference": "Patient/123" },
  "requester": { "reference": "Patient/123" },
  "requestedPerformer": [{ "reference": { "reference": "RelatedPerson/ahd900" } }]
}

HTTP 201 returns the stored Task with its assigned id. A search such as GET /ahd/fhir/Task?requestedperformer-reference=RelatedPerson/ahd900&status=requested returns those resources in a searchset Bundle. Successful rejection returns:

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "task", "valueReference": { "reference": "Task/ahd321/_history/2" } },
    { "name": "trustedPerson", "valueReference": { "reference": "RelatedPerson/ahd900/_history/1" } }
  ]
}

Search trusted persons and signature metadata

GET /ahd/fhir/RelatedPerson?patient=Patient/123&active=true&_revinclude=Provenance:target HTTP/1.1
Accept: application/fhir+json

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [{
    "resource": {
      "resourceType": "RelatedPerson",
      "id": "ahd900",
      "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee"] },
      "extension": [
        {
          "url": "https://fhir.ee/ahd/StructureDefinition/ahd-questionnaire-response-reference",
          "valueReference": { "reference": "QuestionnaireResponse/ahd123" }
        },
        {
          "url": "https://fhir.ee/ahd/StructureDefinition/ahd-trustee-status",
          "valueCode": "completed"
        }
      ],
      "identifier": [{ "system": "https://fhir.ee/sid/pid/est/ni", "value": "49002010965" }],
      "active": true,
      "patient": { "reference": "Patient/123" },
      "relationship": [{
        "coding": [{ "system": "https://fhir.ee/CodeSystem/olemi-seos", "code": "CON" }]
      }]
    },
    "search": { "mode": "match" }
  }]
}

PET signature metadata can be queried by QuestionnaireResponse target and include its Binary:

GET /ahd/fhir/Provenance?target=QuestionnaireResponse/ahd123&_include=Provenance:entity:Binary HTTP/1.1
Accept: application/fhir+json

Trusted-person signature metadata can additionally include its RelatedPerson target:

GET /ahd/fhir/Provenance?target=RelatedPerson/ahd900&_include=Provenance:entity:Binary&_include=Provenance:target:RelatedPerson HTTP/1.1
Accept: application/fhir+json

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "resource": {
        "resourceType": "Provenance",
        "id": "ahd901",
        "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee-signature-provenance"] },
        "target": [{ "reference": "RelatedPerson/ahd900" }],
        "occurredDateTime": "2026-08-31T10:05:00Z",
        "patient": { "reference": "Patient/123" },
        "agent": [{
          "role": [{ "coding": [{
            "system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
            "code": "datasubject"
          }] }],
          "who": { "reference": "RelatedPerson/ahd900" }
        }],
        "entity": [{ "role": "source", "what": { "reference": "Binary/ahd902" } }]
      },
      "search": { "mode": "match" }
    },
    {
      "resource": {
        "resourceType": "Binary",
        "id": "ahd902",
        "meta": { "profile": ["https://fhir.ee/ahd/StructureDefinition/ahd-trustee-signed-binary"] },
        "contentType": "application/vnd.etsi.asic-e+zip",
        "data": "UEsDBBQAAAAAAKtiIV2KIflFHwAAAB8AAAAIAAAAbWltZXR5cGVhcHBsaWNhdGlvbi92bmQuZXRzaS5hc2ljLWUremlwUEsDBBQAAAAIAKtiIV2UrmR9KgEAAFwCAAASAAAAcmVsYXRlZHBlcnNvbi5qc29unZHNTsMwEITfZc8JTsuPVF/LGUrLrcrBiidkpdQO9rqiqvLuyGkLCCEkuHlnteNvdo8UEH0KDZ4PA0jTGr0R2BVC9I4KYkuaTGcXVUUF7SCG9JGG4FvuQXpLncgQtVJtx+EKUKazaiMhNZIC7tGyY2Hvsl5KSFEAqseC8CZwkb0jvT1SCj3pP3m9JsRcOMMBZUAcvIv50SLANaCC9qZPWH8I+kifXU1PXw3W5/lsPZtf0zgW/4E6ByyjGEnxgrD0Nn/Y+N3QQ2BprAsyjfAepCUkFDQYYTj5zrg6yWpCyseAE24ZYVpaPETB7gfEyFYNbBWiKMcXDNJ0s6iqeTWrFne3E0TI12bvYsfDZNl4y+7ld/ccZzM1le+x4zLC56zNKeby8YHGeqzHd1BLAQIUABQAAAAAAKtiIV2KIflFHwAAAB8AAAAIAAAAAAAAAAAAAAAAAAAAAABtaW1ldHlwZVBLAQIUABQAAAAIAKtiIV2UrmR9KgEAAFwCAAASAAAAAAAAAAAAAAAAAEUAAAByZWxhdGVkcGVyc29uLmpzb25QSwUGAAAAAAIAAgB2AAAAnwEAAAAA"
      },
      "search": { "mode": "include" }
    }
  ]
}

Errors

Validation, authorization and business-rule failures are returned as FHIR OperationOutcome resources. For example:

{
  "resourceType": "OperationOutcome",
  "issue": [{
    "severity": "error",
    "code": "invalid",
    "details": { "text": "The request does not satisfy the PET API contract." }
  }]
}

Clients must use the HTTP status together with OperationOutcome.issue; they must not depend on the example text above.

Contract synchronization

The PET service and this implementation guide publish the same canonical operation and custom search-parameter definitions:

Any change to the service CapabilityStatement, these conformance resources, endpoint rules or examples must be reflected in this page and republished in the IG.