provenances

Create Provenance

post
/organizations/{organizationId}/fhir/3/Provenance

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringProvenanceThis is a Provenance resource
target*array(Reference)The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
periodPeriodThe period during which the activity occurred.
recordedstringThe instant of time at which the activity was recorded.
policyarray()Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
locationReferenceWhere the activity occurred, if relevant.
reasonarray(Coding)The reason that the activity was taking place.
activityCodingAn activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
agent*array(Provenance_Agent)An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
entityarray(Provenance_Entity)An entity used in this activity.
signaturearray(Signature)A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

Response

Patch Provenance

patch
/organizations/{organizationId}/fhir/3/Provenance/{resourceId}

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProvenanceThis is a Provenance resource
target*array(Reference)The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
periodPeriodThe period during which the activity occurred.
recordedstringThe instant of time at which the activity was recorded.
policyarray()Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
locationReferenceWhere the activity occurred, if relevant.
reasonarray(Coding)The reason that the activity was taking place.
activityCodingAn activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
agent*array(Provenance_Agent)An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
entityarray(Provenance_Entity)An entity used in this activity.
signaturearray(Signature)A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

Response

Read Provenance

get
/organizations/{organizationId}/fhir/3/Provenance/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Provenance

get
/organizations/{organizationId}/fhir/3/Provenance/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Provenance

get
/organizations/{organizationId}/fhir/3/Provenance/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Provenance

delete
/organizations/{organizationId}/fhir/3/Provenance/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Provenance

get
/organizations/{organizationId}/fhir/3/Provenance

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
agentstring
agent-rolestring
endstring
entity-idstring
entity-refstring
locationstring
patientstring
recordedstring
signature-typestring
startstring
targetstring

Params

organizationId*string|stringid|slug

Response

Search History Provenance

get
/organizations/{organizationId}/fhir/3/Provenance/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Provenance

post
/organizations/{organizationId}/fhir/3/Provenance/_search

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
agentstring
agent-rolestring
endstring
entity-idstring
entity-refstring
locationstring
patientstring
recordedstring
signature-typestring
startstring
targetstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringProvenanceThis is a Provenance resource
target*array(Reference)The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
periodPeriodThe period during which the activity occurred.
recordedstringThe instant of time at which the activity was recorded.
policyarray()Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
locationReferenceWhere the activity occurred, if relevant.
reasonarray(Coding)The reason that the activity was taking place.
activityCodingAn activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
agent*array(Provenance_Agent)An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
entityarray(Provenance_Entity)An entity used in this activity.
signaturearray(Signature)A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

Response

Update Provenance

put
/organizations/{organizationId}/fhir/3/Provenance/{resourceId}

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProvenanceThis is a Provenance resource
target*array(Reference)The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
periodPeriodThe period during which the activity occurred.
recordedstringThe instant of time at which the activity was recorded.
policyarray()Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
locationReferenceWhere the activity occurred, if relevant.
reasonarray(Coding)The reason that the activity was taking place.
activityCodingAn activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
agent*array(Provenance_Agent)An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
entityarray(Provenance_Entity)An entity used in this activity.
signaturearray(Signature)A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

Response