Packages

ISO/HL7 FHIR Application Server

Current section

Files

Jump to
hl7 schema Provenance.schema.json
Raw

schema/Provenance.schema.json

{
"$schema": "http://json-schema.org/draft-07/schema#",
"id": "https://hl7.erp.uno/schema/Provenance.schema.json",
"$ref": "#/definitions/Provenance",
"description": "see https://hl7.org/fhir/json.html for information about the FHIR Json Schemas",
"definitions": {
"Provenance": {
"allOf": [
{
"$ref": "DomainResource.schema.json#/definitions/DomainResource"
},
{
"description": "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.",
"properties": {
"resourceType": {
"description": "This is a Provenance resource",
"type": "string",
"enum": [
"Provenance"
]
},
"target": {
"description": "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.",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"period": {
"description": "The period during which the activity occurred.",
"$ref": "Period.schema.json#/definitions/Period"
},
"recorded": {
"description": "The instant of time at which the activity was recorded.",
"type": "string"
},
"_recorded": {
"description": "Extensions for recorded",
"$ref": "Element.schema.json#/definitions/Element"
},
"policy": {
"description": "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.",
"type": "array",
"items": {
"type": "string"
}
},
"_policy": {
"description": "Extensions for policy",
"type": "array",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
}
},
"location": {
"description": "Where the activity occurred, if relevant.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"reason": {
"description": "The reason that the activity was taking place.",
"type": "array",
"items": {
"$ref": "Coding.schema.json#/definitions/Coding"
}
},
"activity": {
"description": "An 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.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"agent": {
"description": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.",
"type": "array",
"items": {
"$ref": "#/definitions/Provenance_Agent"
}
},
"entity": {
"description": "An entity used in this activity.",
"type": "array",
"items": {
"$ref": "#/definitions/Provenance_Entity"
}
},
"signature": {
"description": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.",
"type": "array",
"items": {
"$ref": "Signature.schema.json#/definitions/Signature"
}
}
},
"required": [
"agent",
"resourceType",
"target"
]
}
]
},
"Provenance_Agent": {
"allOf": [
{
"$ref": "BackboneElement.schema.json#/definitions/BackboneElement"
},
{
"description": "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.",
"properties": {
"role": {
"description": "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.",
"type": "array",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"whoUri": {
"description": "The individual, device or organization that participated in the event.",
"type": "string"
},
"_whoUri": {
"description": "Extensions for whoUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"whoReference": {
"description": "The individual, device or organization that participated in the event.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"onBehalfOfUri": {
"description": "The individual, device, or organization for whom the change was made.",
"type": "string"
},
"_onBehalfOfUri": {
"description": "Extensions for onBehalfOfUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"onBehalfOfReference": {
"description": "The individual, device, or organization for whom the change was made.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"relatedAgentType": {
"description": "The type of relationship between agents.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
}
}
]
},
"Provenance_Entity": {
"allOf": [
{
"$ref": "BackboneElement.schema.json#/definitions/BackboneElement"
},
{
"description": "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.",
"properties": {
"role": {
"description": "How the entity was used during the activity.",
"enum": [
"derivation",
"revision",
"quotation",
"source",
"removal"
],
"type": "string"
},
"_role": {
"description": "Extensions for role",
"$ref": "Element.schema.json#/definitions/Element"
},
"whatUri": {
"description": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"type": "string"
},
"_whatUri": {
"description": "Extensions for whatUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"whatReference": {
"description": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"whatIdentifier": {
"description": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"agent": {
"description": "The entity is attributed to an agent to express the agent\u0027s responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.",
"type": "array",
"items": {
"$ref": "#/definitions/Provenance_Agent"
}
}
}
}
]
}
}
}