FHIR Artifacts > Interaction:Create Provenance

Interaction: Create Provenance

The Create Provenance interaction creates an instance of the Provenance resources to capture and record metadata about the origin, authorship, and context of a FHIR resource or transaction. Provenance serves as a digital signature of trust that enables consuming systems to understand who generated the data, when, how, and under what authority

Usage

Provenance Create Request

The system responsible for generating Provenence resource generates a request and sends it to the FHIR server. It uses HTTP POST method to submit request to create Provenance resource in the following manner:

POST [base]/Provenance

Content-Type: application/fhir+json

where the HTTP Body contains a Provenance FHIR resource to be created.

Mandatory elements

When creating a Subscription resource, the mandatory elements are marked in the Provenence profile page.

Interaction Sequence Diagram

Example Create Provenance Interaction

Create Provenence Request:

HTTP Method:

POST

Headers:

Content-Type: application/fhir+json

Address:

[base]/Provenance/

Create Provenence Response:

Sample of the Create Provenence response message is provided in Examples section of this document. The example provided is used for HALO SoFa use case.

Expected Behaviour

Case Scenario Description HTTP Status Code Response Payload
1 A valid Provenance is submitted, accepted, and created in the repository HTTP 201 Created
2 The submitted Bundle cannot be validated as it does not conform to the specification HTTP 422 Bad Request. Returns an OperationOutcome resource indicating an issue. The client must fix the request and try again.
3 POST Interactions contains incorrect header value for "Content-Type" - should be "application/fhir+json" HTTP 400 Resource not found. Returns an OperationOutcome resource indicating an issue.
4 API validates the request but cannot return a valid response due to internal issues. HTTP 500 Internal Server Error. Returns an OperationOutcome resource indicating an issue.