CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: ProvenanceStatusSe

Introduction

The ProvenanceStatusSe profile is used to manipulate the status of other resources. This means that ProvenanceStatusSe does not represent an individual resource in the system.

Intended Use

If the external system is considered the master system of the information, ProvenanceStatusSe can be used to nullify (invalidate) the data in COSMIC if it is nullified (invalidated) in the master system. Intended user of the API is a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment (medarbetaruppdrag) and be connected to the specified unit. The specified unit should also be identified with HSA ID.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Supported Queries

1. POST [baseURL]/Provenance

Error Codes

In the table below, a few error messages specific for Provenance are listed.

Usages:

• Examples for this Profile: Provenance/698
• CapabilityStatements using this Profile: Cambio Open Services

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Provenance		0..*	Provenance	Who, What, When for a set of resources
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(QuestionnaireResponse | Observation)	Target Reference(s), only a QuestionnaireResponse or an Observation can be referred
recorded	Σ	1..1	instant	When the activity was recorded / updated
reason		1..1	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
coding	Σ	0..1	Coding	Only one coding is allowed for the reason
text	Σ	1..1	string	Plain text representation of the concept
activity		1..1	CodeableConcept	Activity that occurred. The profile only supports nullify for now Binding: ProvenanceActivityType (extensible): The activity that took place.
coding	Σ	1..1	Coding	Code defined by a terminology system
agent		1..*	BackboneElement	Actor involved
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Who participated
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type From the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Provenance		0..*	Provenance	Who, What, When for a set of resources
meta
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
target		1..*	Reference(QuestionnaireResponse | Observation)	Target Reference(s), only a QuestionnaireResponse or an Observation can be referred
occurred[x]		0..0
policy		0..0
location		0..0
reason		1..1	CodeableConcept	Reason the activity is occurring
coding		0..1	Coding	Only one coding is allowed for the reason
text		1..1	string	Plain text representation of the concept
activity		1..1	CodeableConcept	Activity that occurred. The profile only supports nullify for now
coding		1..1	Coding	Code defined by a terminology system
agent		1..*	BackboneElement	Actor involved
who		1..1	Reference(Practitioner | PractitionerRole | Organization)	Who participated
onBehalfOf		0..0
entity		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Provenance		0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(QuestionnaireResponse | Observation)	Target Reference(s), only a QuestionnaireResponse or an Observation can be referred
recorded	Σ	1..1	instant	When the activity was recorded / updated
reason		1..1	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Only one coding is allowed for the reason
text	Σ	1..1	string	Plain text representation of the concept
activity		1..1	CodeableConcept	Activity that occurred. The profile only supports nullify for now Binding: ProvenanceActivityType (extensible): The activity that took place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
agent		1..*	BackboneElement	Actor involved
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	CodeableConcept	How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
role		0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
who	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Who participated
signature		0..*	Signature	Signature on target
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Provenance.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Provenance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type From the FHIR Standard
Provenance.agent.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type From the FHIR Standard
Provenance.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 5 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Provenance		0..*	Provenance	Who, What, When for a set of resources
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(QuestionnaireResponse | Observation)	Target Reference(s), only a QuestionnaireResponse or an Observation can be referred
recorded	Σ	1..1	instant	When the activity was recorded / updated
reason		1..1	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
coding	Σ	0..1	Coding	Only one coding is allowed for the reason
text	Σ	1..1	string	Plain text representation of the concept
activity		1..1	CodeableConcept	Activity that occurred. The profile only supports nullify for now Binding: ProvenanceActivityType (extensible): The activity that took place.
coding	Σ	1..1	Coding	Code defined by a terminology system
agent		1..*	BackboneElement	Actor involved
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Who participated
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type From the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Provenance		0..*	Provenance	Who, What, When for a set of resources
meta
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
target		1..*	Reference(QuestionnaireResponse | Observation)	Target Reference(s), only a QuestionnaireResponse or an Observation can be referred
occurred[x]		0..0
policy		0..0
location		0..0
reason		1..1	CodeableConcept	Reason the activity is occurring
coding		0..1	Coding	Only one coding is allowed for the reason
text		1..1	string	Plain text representation of the concept
activity		1..1	CodeableConcept	Activity that occurred. The profile only supports nullify for now
coding		1..1	Coding	Code defined by a terminology system
agent		1..*	BackboneElement	Actor involved
who		1..1	Reference(Practitioner | PractitionerRole | Organization)	Who participated
onBehalfOf		0..0
entity		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Provenance		0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(QuestionnaireResponse | Observation)	Target Reference(s), only a QuestionnaireResponse or an Observation can be referred
recorded	Σ	1..1	instant	When the activity was recorded / updated
reason		1..1	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Only one coding is allowed for the reason
text	Σ	1..1	string	Plain text representation of the concept
activity		1..1	CodeableConcept	Activity that occurred. The profile only supports nullify for now Binding: ProvenanceActivityType (extensible): The activity that took place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
agent		1..*	BackboneElement	Actor involved
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	CodeableConcept	How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
role		0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
who	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Who participated
signature		0..*	Signature	Signature on target
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Provenance.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Provenance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type From the FHIR Standard
Provenance.agent.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type From the FHIR Standard
Provenance.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 5 elements

Other representations of profile: CSV, Excel, Schematron