Finnish Base Profiles
1.0.0 - trial-use
This page is part of the Finnish Base Profiles (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-information-custodian | Version: 1.0.0 | |||
Active as of 2023-11-10 | Computable Name: FiBaseInformationCustodian |
This is a Finnish abstract base profile for the Provenance resource, used to communicate the custodian of information (rekisterinpitäjä).
The Finnish national healthcare infrastructure uses the concept of the information custodian (rekisterinpitäjä), also known as the data controller or register keeper.
Most of the information in the Kanta system needs to be tagged with information of the information custodian and of the specific register.
For details, please refer to the Kanta CDA R2 Header specification, version 4.66 or later, chapters 2.2.17, 2.4.21, and 2.4.22.
These details are expressed with the Provenance resource conforming to this profile. Information
custodian is the .agent
.
The working group was not able to reach consensus on how to present the details of the register
(the type of register, rekisterin tyyppi and the register specifier, rekisterin tarkenne). One
option is to use extensions to the information custodian .agent
or even to the Provenance
resource instance (see
the ballot version
as one example). Another proposed approach is to
encode this information in .entity
instances (see
version 1.0.0-rc21
for details). See also the
discussion thread
on chat.fhir.org and the GitHub issues
#88,
#135,
#141, and
#163.
Implementer feedback is appreciated on how to continue work on the topic.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FiBaseProvenance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic Who, What, When for a set of resources | |
Slices for agent | 1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type | |
agent:custodian | 1..* | BackboneElement | Actor involved | |
type | 1..1 | CodeableConcept | How the agent participated 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/CodeSystem/v3-ParticipationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system | |
role:custodianRole | 1..* | CodeableConcept | What the agents role was | |
Slices for coding | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system | |
coding:All Slices | Content/Rules for all slices | |||
system | 1..1 | uri | Identity of the terminology system | |
coding:custodianRoleCoding | 1..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Public or private occupational healthcare provider Required Pattern: urn:oid:1.2.246.537.5.40172 | |
who | ||||
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
type | 1..1 | CodeableConcept | Description of identifier 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/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic 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(Resource) | Target Reference(s) (usually version specific) |
recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
Slices for agent | 1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type | |
agent:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
who | Σ | 1..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated |
agent:custodian | 1..* | BackboneElement | Actor involved | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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/CodeSystem/v3-ParticipationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
role:custodianRole | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
Slices for coding | Σ | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system |
coding:All Slices | Content/Rules for all slices | |||
system | Σ | 1..1 | uri | Identity of the terminology system |
coding:custodianRoleCoding | Σ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Public or private occupational healthcare provider Required Pattern: urn:oid:1.2.246.537.5.40172 |
who | Σ | 1..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Provenance.agent:custodian.type | extensible | Pattern: CST |
Provenance.agent:custodian.role | example | SecurityRoleType |
Provenance.agent:custodian.role:custodianRole | example | SecurityRoleType |
Provenance.agent:custodian.who.identifier.use | required | IdentifierUse |
Provenance.agent:custodian.who.identifier.type | extensible | Pattern: PRN |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Provenance | 0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic 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 | ||||
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.
| |||||
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(FI Base Location) | Where the activity occurred, if relevant | |||||
reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
activity | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
Slices for agent | 1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type | |||||
agent: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 | ||||
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(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated | ||||
onBehalfOf | 0..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who the agent is representing | |||||
agent:custodian | 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 | Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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/CodeSystem/v3-ParticipationType | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |||||
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 | |||||
Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
role:custodianRole | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system | ||||
coding: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 Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:custodianRoleCoding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Public or private occupational healthcare provider Required Pattern: urn:oid:1.2.246.537.5.40172 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
who | Σ | 1..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
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 | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
onBehalfOf | 0..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who the agent is representing | |||||
entity | 0..* | 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. | ||||
what | Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
signature | 0..* | Signature | Signature on target | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Provenance.language | preferred | CommonLanguages
| ||||
Provenance.reason | extensible | PurposeOfUse | ||||
Provenance.activity | extensible | ProvenanceActivityType | ||||
Provenance.agent.type | extensible | ProvenanceParticipantType | ||||
Provenance.agent.role | example | SecurityRoleType | ||||
Provenance.agent:custodian.type | extensible | Pattern: CST | ||||
Provenance.agent:custodian.role | example | SecurityRoleType | ||||
Provenance.agent:custodian.role:custodianRole | example | SecurityRoleType | ||||
Provenance.agent:custodian.who.type | extensible | ResourceType | ||||
Provenance.agent:custodian.who.identifier.use | required | IdentifierUse | ||||
Provenance.agent:custodian.who.identifier.type | extensible | Pattern: PRN | ||||
Provenance.entity.role | required | ProvenanceEntityRole |
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 FiBaseProvenance
Summary
Mandatory: 9 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from FiBaseProvenance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic Who, What, When for a set of resources | |
Slices for agent | 1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type | |
agent:custodian | 1..* | BackboneElement | Actor involved | |
type | 1..1 | CodeableConcept | How the agent participated 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/CodeSystem/v3-ParticipationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system | |
role:custodianRole | 1..* | CodeableConcept | What the agents role was | |
Slices for coding | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system | |
coding:All Slices | Content/Rules for all slices | |||
system | 1..1 | uri | Identity of the terminology system | |
coding:custodianRoleCoding | 1..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Public or private occupational healthcare provider Required Pattern: urn:oid:1.2.246.537.5.40172 | |
who | ||||
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
type | 1..1 | CodeableConcept | Description of identifier 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/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic 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(Resource) | Target Reference(s) (usually version specific) |
recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
Slices for agent | 1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type | |
agent:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
who | Σ | 1..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated |
agent:custodian | 1..* | BackboneElement | Actor involved | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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/CodeSystem/v3-ParticipationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
role:custodianRole | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
Slices for coding | Σ | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system |
coding:All Slices | Content/Rules for all slices | |||
system | Σ | 1..1 | uri | Identity of the terminology system |
coding:custodianRoleCoding | Σ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Public or private occupational healthcare provider Required Pattern: urn:oid:1.2.246.537.5.40172 |
who | Σ | 1..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Provenance.agent:custodian.type | extensible | Pattern: CST |
Provenance.agent:custodian.role | example | SecurityRoleType |
Provenance.agent:custodian.role:custodianRole | example | SecurityRoleType |
Provenance.agent:custodian.who.identifier.use | required | IdentifierUse |
Provenance.agent:custodian.who.identifier.type | extensible | Pattern: PRN |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Provenance | 0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic 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 | ||||
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.
| |||||
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(FI Base Location) | Where the activity occurred, if relevant | |||||
reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
activity | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
Slices for agent | 1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type | |||||
agent: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 | ||||
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(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated | ||||
onBehalfOf | 0..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who the agent is representing | |||||
agent:custodian | 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 | Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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/CodeSystem/v3-ParticipationType | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |||||
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 | |||||
Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
role:custodianRole | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system | ||||
coding: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 Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:custodianRoleCoding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Public or private occupational healthcare provider Required Pattern: urn:oid:1.2.246.537.5.40172 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
who | Σ | 1..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who participated | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
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 | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
onBehalfOf | 0..1 | Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization) | Who the agent is representing | |||||
entity | 0..* | 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. | ||||
what | Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
signature | 0..* | Signature | Signature on target | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Provenance.language | preferred | CommonLanguages
| ||||
Provenance.reason | extensible | PurposeOfUse | ||||
Provenance.activity | extensible | ProvenanceActivityType | ||||
Provenance.agent.type | extensible | ProvenanceParticipantType | ||||
Provenance.agent.role | example | SecurityRoleType | ||||
Provenance.agent:custodian.type | extensible | Pattern: CST | ||||
Provenance.agent:custodian.role | example | SecurityRoleType | ||||
Provenance.agent:custodian.role:custodianRole | example | SecurityRoleType | ||||
Provenance.agent:custodian.who.type | extensible | ResourceType | ||||
Provenance.agent:custodian.who.identifier.use | required | IdentifierUse | ||||
Provenance.agent:custodian.who.identifier.type | extensible | Pattern: PRN | ||||
Provenance.entity.role | required | ProvenanceEntityRole |
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 FiBaseProvenance
Summary
Mandatory: 9 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron