Finnish Base Profiles
1.0.0 - trial-use Finland flag

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

Resource Profile: FI Base InformationCustodian ( Abstract )

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ä).

Scope and Usage

How to communicate Kanta information custodian and register information

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:

Formal Views of Profile Content

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

This structure is derived from FiBaseProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*FiBaseProvenanceThis is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... Slices for agent 1..*BackboneElementAn agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:custodian 1..*BackboneElementActor involved
..... type 1..1CodeableConceptHow the agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CST
..... Slices for role 1..*CodeableConceptWhat the agents role was
Slice: Unordered, Open by value:coding.system
...... role:custodianRole 1..*CodeableConceptWhat the agents role was
....... Slices for coding 1..*CodingA 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..1uriIdentity of the terminology system
........ coding:custodianRoleCoding 1..*CodingCode defined by a terminology system
......... system 0..1uriPublic or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who
...... identifier 1..1IdentifierLogical reference, when literal reference is not known
....... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*FiBaseProvenanceThis is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ1..*Reference(Resource)Target Reference(s) (usually version specific)
... Slices for agent 1..*BackboneElementAn 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
.... agent:custodian 1..*BackboneElementActor involved
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptHow 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CST
..... Slices for role 1..*CodeableConceptWhat 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..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


....... Slices for coding Σ1..*CodingA 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..1uriIdentity of the terminology system
........ coding:custodianRoleCoding Σ1..*CodingCode defined by a terminology system
......... system Σ0..1uriPublic or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
...... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ1..1CodeableConceptDescription 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
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.agent:custodian.typeextensiblePattern: CST
Provenance.agent:custodian.roleexampleSecurityRoleType
Provenance.agent:custodian.role:custodianRoleexampleSecurityRoleType
Provenance.agent:custodian.who.identifier.userequiredIdentifierUse
Provenance.agent:custodian.who.identifier.typeextensiblePattern: PRN

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*FiBaseProvenanceThis is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(FI Base Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... Slices for agent 1..*BackboneElementAn 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
..... onBehalfOf 0..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who the agent is representing
.... agent:custodian 1..*BackboneElementActor involved
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptHow 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CST
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... Slices for role 1..*CodeableConceptWhat 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..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... Slices for coding Σ1..*CodingA 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..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ1..1uriIdentity of the terminology system
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ0..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
........ coding:custodianRoleCoding Σ1..*CodingCode defined by a terminology system
......... id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ0..1uriPublic or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ0..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ1..1CodeableConceptDescription 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
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
....... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ0..1stringThe value that is unique
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
..... onBehalfOf 0..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent:custodian.typeextensiblePattern: CST
Provenance.agent:custodian.roleexampleSecurityRoleType
Provenance.agent:custodian.role:custodianRoleexampleSecurityRoleType
Provenance.agent:custodian.who.typeextensibleResourceType
Provenance.agent:custodian.who.identifier.userequiredIdentifierUse
Provenance.agent:custodian.who.identifier.typeextensiblePattern: PRN
Provenance.entity.rolerequiredProvenanceEntityRole

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element Provenance.agent is sliced based on the value of value:type
  • The element Provenance.agent.role is sliced based on the value of value:coding.system
  • The element Provenance.agent.role.coding is sliced based on the value of value:system

Differential View

This structure is derived from FiBaseProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*FiBaseProvenanceThis is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... Slices for agent 1..*BackboneElementAn agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:custodian 1..*BackboneElementActor involved
..... type 1..1CodeableConceptHow the agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CST
..... Slices for role 1..*CodeableConceptWhat the agents role was
Slice: Unordered, Open by value:coding.system
...... role:custodianRole 1..*CodeableConceptWhat the agents role was
....... Slices for coding 1..*CodingA 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..1uriIdentity of the terminology system
........ coding:custodianRoleCoding 1..*CodingCode defined by a terminology system
......... system 0..1uriPublic or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who
...... identifier 1..1IdentifierLogical reference, when literal reference is not known
....... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*FiBaseProvenanceThis is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ1..*Reference(Resource)Target Reference(s) (usually version specific)
... Slices for agent 1..*BackboneElementAn 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
.... agent:custodian 1..*BackboneElementActor involved
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptHow 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CST
..... Slices for role 1..*CodeableConceptWhat 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..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


....... Slices for coding Σ1..*CodingA 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..1uriIdentity of the terminology system
........ coding:custodianRoleCoding Σ1..*CodingCode defined by a terminology system
......... system Σ0..1uriPublic or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
...... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ1..1CodeableConceptDescription 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
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.agent:custodian.typeextensiblePattern: CST
Provenance.agent:custodian.roleexampleSecurityRoleType
Provenance.agent:custodian.role:custodianRoleexampleSecurityRoleType
Provenance.agent:custodian.who.identifier.userequiredIdentifierUse
Provenance.agent:custodian.who.identifier.typeextensiblePattern: PRN

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*FiBaseProvenanceThis is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(FI Base Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... Slices for agent 1..*BackboneElementAn 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
..... onBehalfOf 0..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who the agent is representing
.... agent:custodian 1..*BackboneElementActor involved
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptHow 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CST
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... Slices for role 1..*CodeableConceptWhat 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..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... Slices for coding Σ1..*CodingA 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..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ1..1uriIdentity of the terminology system
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ0..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
........ coding:custodianRoleCoding Σ1..*CodingCode defined by a terminology system
......... id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ0..1uriPublic or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ0..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
..... who Σ1..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who participated
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ1..1CodeableConceptDescription 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
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
....... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ0..1stringThe value that is unique
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
..... onBehalfOf 0..1Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Patient | RelatedPerson | Device | FI Base Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent:custodian.typeextensiblePattern: CST
Provenance.agent:custodian.roleexampleSecurityRoleType
Provenance.agent:custodian.role:custodianRoleexampleSecurityRoleType
Provenance.agent:custodian.who.typeextensibleResourceType
Provenance.agent:custodian.who.identifier.userequiredIdentifierUse
Provenance.agent:custodian.who.identifier.typeextensiblePattern: PRN
Provenance.entity.rolerequiredProvenanceEntityRole

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element Provenance.agent is sliced based on the value of value:type
  • The element Provenance.agent.role is sliced based on the value of value:coding.system
  • The element Provenance.agent.role.coding is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron