For a full list of available versions, see the Directory of published versions

4.3. Interaction: Search Provenance

The Search Provenance interaction allows OH Systems to retrieve a collection of Provenence resources.

4.3.1. Usage

Search Provenance Request

The Search Provenance interaction shall retrieve all Provenance resources from the repository that match search criteria.

GET [base]/Provenance?search_parameter=[PARAMETER_ID]

4.3.1.1. Search Parameter

A subset of standard Provenance search parameters includes the following:

• agent
• agent-type
• entity
• recorded
• target
• include=Provenance:target" for Provenance
• revinclude=Provenance:target" for all other resources

Search Provenance Response

• The server returns a 200 OK HTTP status code.

• The response bodfy contains FHIR Resource Type: Bundle (type = searchset)

• Each entry.resource is a Provenence that matches the provided search parameter(s).

4.3.1.2. Interaction Sequence Diagram

4.3.2.

4.3.2.1. Example Search Provenence Interaction

4.3.3. Search Provenance Request:

Below is an example of Search Provenance request with multiple search parameters

GET [base]/Provenance?
  target=Observation/98765&
  recorded=ge2024-01-01&
  agent=Practitioner/456
Accept: application/fhir+json

Additional Search examles:

• Search Provenance created for a FHIR submission with X-Request-ID = “bd5648e0-3e5c-4414-95a9-fbdad630eddf” (and include FHIR resources)

      GET [base]/Provenance?entity:identifier=urn:ietf:rfc:3986|urn:uuid:bd5648e0-3e5c-4414-95a9-fbdad630eddf&_include=Provenance:target

• Search Provenance created on June 11, 2025 for FHIR submissions by a sender with azp=”98765” (and include FHIR resources)

      GET [base]/Provenance?recorded=2025-06-11&agent:identifier=http://ehealthontario.ca/fhir/NamingSystem/id-oneid-clientid|98765&_include=Provenance:target

• For DQS: Search Task with “error” business status created on June 12, 2025, include OperationOutcome and revinclude Provenance

      GET [base]/Task?authored-on=2025-06-12&business-status=error&_include=Task:reason-reference&_revinclude=Provenance:target

POST method can be used when search parameters are too complex or long for a URL (e.g., long queries or special characters). Parameters are passed in the body as application/x-www-form-urlencoded.

POST [base]/Provenance/_search
Content-Type: application/x-www-form-urlencoded
Accept: application/fhir+json

Search Provenence Response:

Sample of the Search Provenance response is provided in the Examples section.

4.3.4. Error Handling