WHO.CR.COVID19\WhoCompositionProvenance

WHO Case Reporting for COVID-19 Surveillance - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: WhoCompositionProvenance

Defining URL:

http://openhie.github.io/covid-19/StructureDefinition/WhoCompositionProvenance

Version:

0.1.0

Name:

WhoCompositionProvenance

Status:

Active as of 2021-02-11T17:12:53+00:00

Definition:

TODO

Publisher:

OpenHIE

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://openhie.github.io/covid-19/StructureDefinition/WhoCompositionProvenance

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Provenance

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

http://openhie.github.io/covid-19/StructureDefinition/WhoCrQuestionnaireResponseCovid19Surveillance

Slices

This structure defines the following Slices:

The element Provenance.reason is sliced based on the value of pattern:role
The element Provenance.entity is sliced based on the value of pattern:role

This structure is derived from Provenance

Name	Card.	Type	Description & Constraints
Provenance	0..*	Provenance	Who, What, When for a set of resources
reason	1..*	(Slice Definition)	Reason the activity is occurring Slice: Unordered, Open by pattern:role
reason:reasonPubHealth	1..*	CodeableConcept	Reason the activity is occurring Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
code	1..1	code	Symbol in syntax defined by the system Fixed Value: PUBHLTH
entity	1..*	(Slice Definition)	An entity used in this activity Slice: Unordered, Open by pattern:role
entity:sourceQuestionnaireResponse	1..*	BackboneElement	An entity used in this activity
role	1..1	code	derivation \| revision \| quotation \| source \| removal Required Pattern: source
what	1..1	Reference(Who Case Reporting QuestionnaireResponse)	Identity of entity
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
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(Resource)	Target Reference(s) (usually version specific)
occurred[x]		0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	Σ	1..1	instant	When the activity was recorded / updated
policy		0..*	uri	Policy or plan the activity was defined by
location		0..1	Reference(Location)	Where the activity occurred, if relevant
reason		1..*	(Slice Definition)	Reason the activity is occurring Slice: Unordered, Open by pattern:role Binding: PurposeOfUse (extensible): The reason the activity took place.
reason:reasonPubHealth		1..*	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PUBHLTH
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
activity		0..1	CodeableConcept	Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
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 \| RelatedPerson \| Patient \| Device \| Organization)	Who participated
onBehalfOf		0..1	Reference(Practitioner \| PractitionerRole \| RelatedPerson \| Patient \| Device \| Organization)	Who the agent is representing
entity		1..*	(Slice Definition)	An entity used in this activity Slice: Unordered, Open by pattern:role
entity:All Slices				Content/Rules for all slices
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
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
what	Σ	1..1	Reference(Resource)	Identity of entity
agent		0..*	See agent (Provenance)	Entity is attributed to this agent
entity:sourceQuestionnaireResponse		1..*	BackboneElement	An entity used in this activity
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
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: source
what	Σ	1..1	Reference(Who Case Reporting QuestionnaireResponse)	Identity of entity
agent		0..*	See agent (Provenance)	Entity is attributed to this agent
signature		0..*	Signature	Signature on target
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
Documentation for this format

This structure is derived from Provenance

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

http://openhie.github.io/covid-19/StructureDefinition/WhoCrQuestionnaireResponseCovid19Surveillance

Slices

This structure defines the following Slices:

The element Provenance.reason is sliced based on the value of pattern:role
The element Provenance.entity is sliced based on the value of pattern:role

Differential View

This structure is derived from Provenance

Name	Card.	Type	Description & Constraints
Provenance	0..*	Provenance	Who, What, When for a set of resources
reason	1..*	(Slice Definition)	Reason the activity is occurring Slice: Unordered, Open by pattern:role
reason:reasonPubHealth	1..*	CodeableConcept	Reason the activity is occurring Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
code	1..1	code	Symbol in syntax defined by the system Fixed Value: PUBHLTH
entity	1..*	(Slice Definition)	An entity used in this activity Slice: Unordered, Open by pattern:role
entity:sourceQuestionnaireResponse	1..*	BackboneElement	An entity used in this activity
role	1..1	code	derivation \| revision \| quotation \| source \| removal Required Pattern: source
what	1..1	Reference(Who Case Reporting QuestionnaireResponse)	Identity of entity
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
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(Resource)	Target Reference(s) (usually version specific)
occurred[x]		0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	Σ	1..1	instant	When the activity was recorded / updated
policy		0..*	uri	Policy or plan the activity was defined by
location		0..1	Reference(Location)	Where the activity occurred, if relevant
reason		1..*	(Slice Definition)	Reason the activity is occurring Slice: Unordered, Open by pattern:role Binding: PurposeOfUse (extensible): The reason the activity took place.
reason:reasonPubHealth		1..*	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PUBHLTH
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
activity		0..1	CodeableConcept	Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
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 \| RelatedPerson \| Patient \| Device \| Organization)	Who participated
onBehalfOf		0..1	Reference(Practitioner \| PractitionerRole \| RelatedPerson \| Patient \| Device \| Organization)	Who the agent is representing
entity		1..*	(Slice Definition)	An entity used in this activity Slice: Unordered, Open by pattern:role
entity:All Slices				Content/Rules for all slices
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
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
what	Σ	1..1	Reference(Resource)	Identity of entity
agent		0..*	See agent (Provenance)	Entity is attributed to this agent
entity:sourceQuestionnaireResponse		1..*	BackboneElement	An entity used in this activity
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
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: source
what	Σ	1..1	Reference(Who Case Reporting QuestionnaireResponse)	Identity of entity
agent		0..*	See agent (Provenance)	Entity is attributed to this agent
signature		0..*	Signature	Signature on target
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Provenance.language	preferred	CommonLanguages Max Binding: AllLanguages
Provenance.reason	extensible	PurposeOfUse
Provenance.reason:reasonPubHealth	extensible	Pattern: PUBHLTH
Provenance.activity	extensible	ProvenanceActivityType
Provenance.agent.type	extensible	ProvenanceParticipantType
Provenance.agent.role	example	SecurityRoleType
Provenance.entity.role	required	ProvenanceEntityRole
Provenance.entity:sourceQuestionnaireResponse.role	required	Pattern: source

Constraints

Id	Path	Details	Requirements
dom-2	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	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	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	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Provenance.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.target	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.occurred[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.recorded	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.policy	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.reason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.reason:reasonPubHealth	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.activity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.agent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.agent.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.agent.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.agent.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.agent.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.agent.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.agent.role	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.agent.who	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.agent.onBehalfOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.entity.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.entity.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.entity.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.entity.role	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity.what	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity.agent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity:sourceQuestionnaireResponse	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity:sourceQuestionnaireResponse.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.entity:sourceQuestionnaireResponse.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.entity:sourceQuestionnaireResponse.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Provenance.entity:sourceQuestionnaireResponse.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Provenance.entity:sourceQuestionnaireResponse.role	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity:sourceQuestionnaireResponse.what	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.entity:sourceQuestionnaireResponse.agent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Provenance.signature	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())