ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: EraAppointmentProvenance
| Official URL: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance | Version: 1.0.0 | |||
| Draft as of 2026-03-24 | Computable Name: EraAppointmentProvenance | |||
Provenance profile used in the ERA interface for appointment booking. Based on the Kanta Services profile AppointmentProvenance.
EraAppointmentProvenance
Usages:
- CapabilityStatements using this Profile: ERA Capability Statement
- This Profile is not used by any profiles in this Specification
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Provenance |
C | 0..* | Provenance | Appointment metadata Constraints: PTA-PROV-1, PTA-PROV-2, PTA-PROV-3, PTA-PROV-4, PTA-PROV-5, PTA-PROV-7, PTA-PROV-8, PTA-PROV-9, PTA-PROV-10, PTA-PROV-11 |
  id |
0..1 | id | Unique identifier of the resource | |
  meta |
0..1 | Meta | Metadata about the resource | |
  profile |
1..1 | canonical(StructureDefinition) | Applied specification Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance (no extensions allowed) | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| language |
1..1 | code | Language of the appointment Binding: CommonLanguages (required) | |
 Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  extension:RegisterSpecifier |
0..1 | Identifier | Register specifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier | |
| extension:ReleaseDateForPatientViewing |
0..1 | date | End date of the delay URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing | |
 extension:ServiceEvent |
1..1 | (Complex) | Service event identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent | |
  url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent" | |
 value[x] |
1..1 | Identifier | Service event identifier | |
 system |
1..1 | uri | Service event namespace Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service event identifier Example General: 123456 | |
| extension:Status |
0..1 | (Complex) | Record status. ERA will overwrite this. URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/Status" | |
| value[x] |
1..1 | Coding | Record status Binding: fipta-vs-recordstatus (required) | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value for the record status | |
| display |
1..1 | string | Name of the record status | |
| extension:RestrictionParent |
0..1 | Coding | Prohibition of disclosure to guardians URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent Binding: fipta-vs-restrictionparent (required) | |
| extension:TableOfContents |
0..1 | (Complex) | View URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents | |
| url |
1..1 | uri | "https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-tableofcontentsprotected (required) | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value of the view | |
| display |
1..1 | string | Representation defined by the system | |
 extension:RegisterType |
1..1 | (Complex) | Register identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-registertype (required) | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
1..1 | string | Representation defined by the system | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 target |
1..1 | Reference(EraAppointmentAppointment) | Appointment | |
| reference |
C | 1..1 | string | Reference to the unique identifier of the Appointment resource |
| display |
0..1 | string | Display name Fixed Value: Ajanvaraus (no extensions allowed) | |
| recorded |
1..1 | instant | Recording time | |
| activity |
0..1 | CodeableConcept | Reason for replacement Binding: fipta-vs-updatereason (required) | |
 coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value for the reason for replacing the appointment | |
| display |
1..1 | string | Reason for replacing the appointment | |
 Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Closed by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 agent:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| agent:Rekisterinpitaja |
1..1 | BackboneElement | Controller | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
 coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Controller identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Controller name | |
| agent:Palveluntuottaja |
1..1 | BackboneElement | Service provider | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service provider Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 13 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Service provider identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service provider identifier Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Tallentajan_palveluyksikko |
0..1 | BackboneElement | Service unit of the person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service unit of the person making the appointment booking action Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 7 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Service unit of the person making the appointment booking action | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service unit identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Isantaorganisaatio |
0..1 | BackboneElement | Host of the tenant | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Host of the tenant Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 8 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Identifier of the tenant host organization | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Host organization identifier (service provider) Binding: fipta-vs-organization (required) Example General: 123456 | |
| agent:Palvelunjarjestaja |
1..1 | BackboneElement | Service organizer | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service organizer Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 10 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Service organizer identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service organizer identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Aktiivi_rekisterinpitaja |
0..1 | BackboneElement | Active controller | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 11 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Text alternative for the resource | |
| agent:Ohjelmisto |
1..1 | BackboneElement | Software that produced the information | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 4 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:Patient |
1..1 | BackboneElement | Patient or customer | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient or customer Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPatient) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPatient |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 12 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerPatient) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerOnBehalfOf |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Proxy who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 5 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerOnBehalfOf) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPractioner |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Professional who stored the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPractitioner) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerDevice |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Software that recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 6 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | required | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.extension:Status.value[x] | Base | required | fipta-vs-recordstatus | 📦1.0.0 | This IG |
| Provenance.extension:TableOfContents.value[x] | Base | required | fipta-vs-tableofcontentsprotected | 📦1.0.0 | This IG |
| Provenance.extension:RegisterType.value[x] | Base | required | fipta-vs-registertype | 📦1.0.0 | This IG |
| Provenance.activity | Base | required | fipta-vs-updatereason | 📦1.0.0 | This IG |
| Provenance.agent:Rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palveluntuottaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Aktiivi_rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Ohjelmisto.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPatient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerOnBehalfOf.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPractioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerDevice.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-PROV-1 | error | Provenance | A register specifier must be provided when occupational healthcare is concerned (register identifier: occupational healthcare). |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists()
|
| PTA-PROV-2 | error | Provenance | The register specifier is used only in connection with the occupational healthcare register. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists().not() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists().not()
|
| PTA-PROV-3 | error | Provenance | The service unit of the person making the appointment booking is mandatory when the person booking the appointment is a professional. |
Provenance.agent.role.coding.where(code='2').exists() implies Provenance.agent.role.coding.where(code='7').exists()
|
| PTA-PROV-4 | error | Provenance | The service unit of the person making the appointment booking is provided only if the booker of the appointment is a professional or a software. |
Provenance.agent.role.coding.where(code='2' or code='6').exists().not() implies Provenance.agent.role.coding.where(code='7').exists().not()
|
| PTA-PROV-5 | error | Provenance | The end date of the delay must be given in the format yyyy-mm-dd. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').value.toString().length()=10
|
| PTA-PROV-7 | error | Provenance | The service event identifier (Provenance.extension.ServiceEvent) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').exists() implies Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').value.value.length() < 125
|
| PTA-PROV-8 | error | Provenance | The register specifier (Provenance.extension.RegisterSpecifier) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists() implies (Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.system.length()+ Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.value.length()) < 125
|
| PTA-PROV-9 | error | Provenance | When the customer has made the appointment booking, the identifiers of the customer and the person making the appointment booking must match. |
agent.where(role.coding.code = '12').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value = agent.where(role.coding.code = '12').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-10 | error | Provenance | When a person has made the appointment booking on behalf of another person, the person's identifier cannot be the same as the customer's identifier. |
agent.where(role.coding.code = '5').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value != agent.where(role.coding.code = '5').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-11 | error | Provenance | Only a professional may use the reason code 3 for appointment replacement. |
Provenance.activity.coding.where(code='3').exists() implies Provenance.agent.role.coding.where(code='2').exists()
|
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Appointment metadata Constraints: PTA-PROV-1, PTA-PROV-2, PTA-PROV-3, PTA-PROV-4, PTA-PROV-5, PTA-PROV-7, PTA-PROV-8, PTA-PROV-9, PTA-PROV-10, PTA-PROV-11 |
| id |
0..1 | id | Unique identifier of the resource | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Applied specification Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance (no extensions allowed) | |
| language |
1..1 | code | Language of the appointment Binding: CommonLanguages (required) | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:RegisterSpecifier |
0..1 | Identifier | Register specifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier | |
| extension:ReleaseDateForPatientViewing |
0..1 | date | End date of the delay URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing | |
| extension:ServiceEvent |
1..1 | (Complex) | Service event identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent | |
| id |
0..0 | Unique id for inter-element referencing | ||
| value[x] |
1..1 | Identifier | Service event identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| extension:Status |
0..1 | (Complex) | Record status. ERA will overwrite this. URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
 value[x] |
1..1 | Coding | Record status Binding: fipta-vs-recordstatus (required) | |
| extension:RestrictionParent |
0..1 | Coding | Prohibition of disclosure to guardians URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent Binding: fipta-vs-restrictionparent (required) | |
| extension:TableOfContents |
0..1 | (Complex) | View URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-tableofcontentsprotected (required) | |
| extension:RegisterType |
1..1 | (Complex) | Register identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-registertype (required) | |
| target |
1..1 | Reference(EraAppointmentAppointment) | Appointment | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Reference to the unique identifier of the Appointment resource | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..1 | string | Display name Fixed Value: Ajanvaraus (no extensions allowed) | |
| occurred[x] |
0..0 | When the activity occurred | ||
| recorded |
1..1 | instant | Recording time | |
| policy |
0..0 | Policy or plan the activity was defined by | ||
| location |
0..0 | Where the activity occurred, if relevant | ||
| reason |
0..0 | Reason the activity is occurring | ||
| activity |
0..1 | CodeableConcept | Reason for replacement Binding: fipta-vs-updatereason (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value for the reason for replacing the appointment | |
| display |
1..1 | string | Reason for replacing the appointment | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Closed by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:Rekisterinpitaja |
1..1 | BackboneElement | Controller | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Reference to the resource to be used | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Controller identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Controller name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Palveluntuottaja |
1..1 | BackboneElement | Service provider | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Service provider Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 13 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Service provider identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service provider identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Organization name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Tallentajan_palveluyksikko |
0..1 | BackboneElement | Service unit of the person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Service unit of the person making the appointment booking action Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 7 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Service unit of the person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service unit identifier Binding: fipta-vs-organization (required) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Organization name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Isantaorganisaatio |
0..1 | BackboneElement | Host of the tenant | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Host of the tenant Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 8 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Identifier of the tenant host organization | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Host organization identifier (service provider) Binding: fipta-vs-organization (required) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Palvelunjarjestaja |
1..1 | BackboneElement | Service organizer | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Service organizer Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 10 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Service organizer identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service organizer identifier Binding: fipta-vs-organization (required) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Organization name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Aktiivi_rekisterinpitaja |
0..1 | BackboneElement | Active controller | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 11 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Reference to the resource to be used | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Text alternative for the resource | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Ohjelmisto |
1..1 | BackboneElement | Software that produced the information | |
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 4 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Patient |
1..1 | BackboneElement | Patient or customer | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Patient or customer Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentPatient) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerPatient |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Patient who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 12 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentBookerPatient) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerOnBehalfOf |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Proxy who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 5 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentBookerOnBehalfOf) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerPractioner |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Professional who stored the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentPractitioner) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerDevice |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Software that recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 6 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| entity |
0..0 | An entity used in this activity | ||
| signature |
0..0 | Electronic signatures | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | required | Not State | Unknown | |
| Provenance.extension:Status.value[x] | Base | required | fipta-vs-recordstatus | 📦1.0.0 | This IG |
| Provenance.extension:TableOfContents.value[x] | Base | required | fipta-vs-tableofcontentsprotected | 📦1.0.0 | This IG |
| Provenance.extension:RegisterType.value[x] | Base | required | fipta-vs-registertype | 📦1.0.0 | This IG |
| Provenance.activity | Base | required | fipta-vs-updatereason | 📦1.0.0 | This IG |
| Provenance.agent:Rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palveluntuottaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Aktiivi_rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Ohjelmisto.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPatient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerOnBehalfOf.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPractioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerDevice.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-PROV-1 | error | Provenance | A register specifier must be provided when occupational healthcare is concerned (register identifier: occupational healthcare). |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists()
|
| PTA-PROV-2 | error | Provenance | The register specifier is used only in connection with the occupational healthcare register. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists().not() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists().not()
|
| PTA-PROV-3 | error | Provenance | The service unit of the person making the appointment booking is mandatory when the person booking the appointment is a professional. |
Provenance.agent.role.coding.where(code='2').exists() implies Provenance.agent.role.coding.where(code='7').exists()
|
| PTA-PROV-4 | error | Provenance | The service unit of the person making the appointment booking is provided only if the booker of the appointment is a professional or a software. |
Provenance.agent.role.coding.where(code='2' or code='6').exists().not() implies Provenance.agent.role.coding.where(code='7').exists().not()
|
| PTA-PROV-5 | error | Provenance | The end date of the delay must be given in the format yyyy-mm-dd. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').value.toString().length()=10
|
| PTA-PROV-7 | error | Provenance | The service event identifier (Provenance.extension.ServiceEvent) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').exists() implies Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').value.value.length() < 125
|
| PTA-PROV-8 | error | Provenance | The register specifier (Provenance.extension.RegisterSpecifier) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists() implies (Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.system.length()+ Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.value.length()) < 125
|
| PTA-PROV-9 | error | Provenance | When the customer has made the appointment booking, the identifiers of the customer and the person making the appointment booking must match. |
agent.where(role.coding.code = '12').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value = agent.where(role.coding.code = '12').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-10 | error | Provenance | When a person has made the appointment booking on behalf of another person, the person's identifier cannot be the same as the customer's identifier. |
agent.where(role.coding.code = '5').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value != agent.where(role.coding.code = '5').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-11 | error | Provenance | Only a professional may use the reason code 3 for appointment replacement. |
Provenance.activity.coding.where(code='3').exists() implies Provenance.agent.role.coding.where(code='2').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Appointment metadata Constraints: PTA-PROV-1, PTA-PROV-2, PTA-PROV-3, PTA-PROV-4, PTA-PROV-5, PTA-PROV-7, PTA-PROV-8, PTA-PROV-9, PTA-PROV-10, PTA-PROV-11 |
| id |
0..1 | id | Unique identifier of the resource | |
| meta |
0..1 | Meta | Metadata about the resource | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
1..1 | canonical(StructureDefinition) | Applied specification Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance (no extensions allowed) | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| language |
1..1 | code | Language of the appointment Binding: CommonLanguages (required) | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:RegisterSpecifier |
0..1 | Identifier | Register specifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier | |
| extension:ReleaseDateForPatientViewing |
0..1 | date | End date of the delay URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing | |
| extension:ServiceEvent |
1..1 | (Complex) | Service event identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent" | |
| value[x] |
1..1 | Identifier | Service event identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Service event namespace Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service event identifier Example General: 123456 | |
| extension:Status |
0..1 | (Complex) | Record status. ERA will overwrite this. URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/Status" | |
| value[x] |
1..1 | Coding | Record status Binding: fipta-vs-recordstatus (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value for the record status | |
| display |
1..1 | string | Name of the record status | |
| extension:RestrictionParent |
0..1 | Coding | Prohibition of disclosure to guardians URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent Binding: fipta-vs-restrictionparent (required) | |
| extension:TableOfContents |
0..1 | (Complex) | View URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-tableofcontentsprotected (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value of the view | |
| display |
1..1 | string | Representation defined by the system | |
| extension:RegisterType |
1..1 | (Complex) | Register identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-registertype (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
1..1 | string | Representation defined by the system | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..1 | Reference(EraAppointmentAppointment) | Appointment | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
C | 1..1 | string | Reference to the unique identifier of the Appointment resource |
| display |
0..1 | string | Display name Fixed Value: Ajanvaraus (no extensions allowed) | |
| recorded |
1..1 | instant | Recording time | |
| activity |
0..1 | CodeableConcept | Reason for replacement Binding: fipta-vs-updatereason (required) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| 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 | |
| code |
1..1 | code | Code value for the reason for replacing the appointment | |
| display |
1..1 | string | Reason for replacing the appointment | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Closed by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
| agent:Rekisterinpitaja |
1..1 | BackboneElement | Controller | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Controller identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Controller name | |
| agent:Palveluntuottaja |
1..1 | BackboneElement | Service provider | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service provider Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 13 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Service provider identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service provider identifier Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Tallentajan_palveluyksikko |
0..1 | BackboneElement | Service unit of the person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service unit of the person making the appointment booking action Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 7 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Service unit of the person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service unit identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Isantaorganisaatio |
0..1 | BackboneElement | Host of the tenant | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Host of the tenant Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 8 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Identifier of the tenant host organization | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Host organization identifier (service provider) Binding: fipta-vs-organization (required) Example General: 123456 | |
| agent:Palvelunjarjestaja |
1..1 | BackboneElement | Service organizer | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service organizer Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 10 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Service organizer identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service organizer identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Aktiivi_rekisterinpitaja |
0..1 | BackboneElement | Active controller | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 11 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Text alternative for the resource | |
| agent:Ohjelmisto |
1..1 | BackboneElement | Software that produced the information | |
| 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 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| 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 Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 4 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:Patient |
1..1 | BackboneElement | Patient or customer | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient or customer Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPatient) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPatient |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 12 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerPatient) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerOnBehalfOf |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Proxy who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 5 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerOnBehalfOf) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPractioner |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Professional who stored the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPractitioner) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerDevice |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Software that recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 6 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | required | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.extension:Status.value[x] | Base | required | fipta-vs-recordstatus | 📦1.0.0 | This IG |
| Provenance.extension:TableOfContents.value[x] | Base | required | fipta-vs-tableofcontentsprotected | 📦1.0.0 | This IG |
| Provenance.extension:RegisterType.value[x] | Base | required | fipta-vs-registertype | 📦1.0.0 | This IG |
| Provenance.activity | Base | required | fipta-vs-updatereason | 📦1.0.0 | This IG |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palveluntuottaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Aktiivi_rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Ohjelmisto.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPatient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerOnBehalfOf.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPractioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerDevice.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-PROV-1 | error | Provenance | A register specifier must be provided when occupational healthcare is concerned (register identifier: occupational healthcare). |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists()
|
| PTA-PROV-2 | error | Provenance | The register specifier is used only in connection with the occupational healthcare register. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists().not() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists().not()
|
| PTA-PROV-3 | error | Provenance | The service unit of the person making the appointment booking is mandatory when the person booking the appointment is a professional. |
Provenance.agent.role.coding.where(code='2').exists() implies Provenance.agent.role.coding.where(code='7').exists()
|
| PTA-PROV-4 | error | Provenance | The service unit of the person making the appointment booking is provided only if the booker of the appointment is a professional or a software. |
Provenance.agent.role.coding.where(code='2' or code='6').exists().not() implies Provenance.agent.role.coding.where(code='7').exists().not()
|
| PTA-PROV-5 | error | Provenance | The end date of the delay must be given in the format yyyy-mm-dd. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').value.toString().length()=10
|
| PTA-PROV-7 | error | Provenance | The service event identifier (Provenance.extension.ServiceEvent) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').exists() implies Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').value.value.length() < 125
|
| PTA-PROV-8 | error | Provenance | The register specifier (Provenance.extension.RegisterSpecifier) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists() implies (Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.system.length()+ Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.value.length()) < 125
|
| PTA-PROV-9 | error | Provenance | When the customer has made the appointment booking, the identifiers of the customer and the person making the appointment booking must match. |
agent.where(role.coding.code = '12').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value = agent.where(role.coding.code = '12').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-10 | error | Provenance | When a person has made the appointment booking on behalf of another person, the person's identifier cannot be the same as the customer's identifier. |
agent.where(role.coding.code = '5').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value != agent.where(role.coding.code = '5').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-11 | error | Provenance | Only a professional may use the reason code 3 for appointment replacement. |
Provenance.activity.coding.where(code='3').exists() implies Provenance.agent.role.coding.where(code='2').exists()
|
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
Summary
Mandatory: 49 elements(55 nested mandatory elements)
Fixed: 32 elements
Prohibited: 178 elements
Structures
This structure refers to these other structures:
- EraAppointmentAppointment (https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentAppointment)
- KantaDevice (https://gen.kanta.fi/fhir/StructureDefinition/KantaDevice)
- AppointmentPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPatient)
- AppointmentBookerPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerPatient)
- AppointmentBookerOnBehalfOf (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf)
- AppointmentPractitioner (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPractitioner)
Extensions
This structure refers to these extensions:
- https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier
- https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing
- https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent
- https://gen.kanta.fi/fhir/StructureDefinition/extension/Status
- https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent
- https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents
- https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Provenance.agent (Closed)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Appointment metadata Constraints: PTA-PROV-1, PTA-PROV-2, PTA-PROV-3, PTA-PROV-4, PTA-PROV-5, PTA-PROV-7, PTA-PROV-8, PTA-PROV-9, PTA-PROV-10, PTA-PROV-11 |
| id |
0..1 | id | Unique identifier of the resource | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Applied specification Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance (no extensions allowed) | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| language |
1..1 | code | Language of the appointment Binding: CommonLanguages (required) | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:RegisterSpecifier |
0..1 | Identifier | Register specifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier | |
| extension:ReleaseDateForPatientViewing |
0..1 | date | End date of the delay URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing | |
| extension:ServiceEvent |
1..1 | (Complex) | Service event identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent" | |
| value[x] |
1..1 | Identifier | Service event identifier | |
| system |
1..1 | uri | Service event namespace Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service event identifier Example General: 123456 | |
| extension:Status |
0..1 | (Complex) | Record status. ERA will overwrite this. URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/Status" | |
| value[x] |
1..1 | Coding | Record status Binding: fipta-vs-recordstatus (required) | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value for the record status | |
| display |
1..1 | string | Name of the record status | |
| extension:RestrictionParent |
0..1 | Coding | Prohibition of disclosure to guardians URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent Binding: fipta-vs-restrictionparent (required) | |
| extension:TableOfContents |
0..1 | (Complex) | View URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents | |
| url |
1..1 | uri | "https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-tableofcontentsprotected (required) | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value of the view | |
| display |
1..1 | string | Representation defined by the system | |
| extension:RegisterType |
1..1 | (Complex) | Register identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-registertype (required) | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
1..1 | string | Representation defined by the system | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..1 | Reference(EraAppointmentAppointment) | Appointment | |
| reference |
C | 1..1 | string | Reference to the unique identifier of the Appointment resource |
| display |
0..1 | string | Display name Fixed Value: Ajanvaraus (no extensions allowed) | |
| recorded |
1..1 | instant | Recording time | |
| activity |
0..1 | CodeableConcept | Reason for replacement Binding: fipta-vs-updatereason (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value for the reason for replacing the appointment | |
| display |
1..1 | string | Reason for replacing the appointment | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Closed by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| agent:Rekisterinpitaja |
1..1 | BackboneElement | Controller | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Controller identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Controller name | |
| agent:Palveluntuottaja |
1..1 | BackboneElement | Service provider | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service provider Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 13 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Service provider identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service provider identifier Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Tallentajan_palveluyksikko |
0..1 | BackboneElement | Service unit of the person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service unit of the person making the appointment booking action Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 7 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Service unit of the person making the appointment booking action | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service unit identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Isantaorganisaatio |
0..1 | BackboneElement | Host of the tenant | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Host of the tenant Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 8 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Identifier of the tenant host organization | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Host organization identifier (service provider) Binding: fipta-vs-organization (required) Example General: 123456 | |
| agent:Palvelunjarjestaja |
1..1 | BackboneElement | Service organizer | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service organizer Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 10 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Service organizer identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service organizer identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Aktiivi_rekisterinpitaja |
0..1 | BackboneElement | Active controller | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 11 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Text alternative for the resource | |
| agent:Ohjelmisto |
1..1 | BackboneElement | Software that produced the information | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 4 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:Patient |
1..1 | BackboneElement | Patient or customer | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient or customer Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPatient) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPatient |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 12 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerPatient) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerOnBehalfOf |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Proxy who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 5 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerOnBehalfOf) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPractioner |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Professional who stored the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPractitioner) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerDevice |
0..1 | BackboneElement | Person making the appointment booking action | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Software that recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 6 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | required | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.extension:Status.value[x] | Base | required | fipta-vs-recordstatus | 📦1.0.0 | This IG |
| Provenance.extension:TableOfContents.value[x] | Base | required | fipta-vs-tableofcontentsprotected | 📦1.0.0 | This IG |
| Provenance.extension:RegisterType.value[x] | Base | required | fipta-vs-registertype | 📦1.0.0 | This IG |
| Provenance.activity | Base | required | fipta-vs-updatereason | 📦1.0.0 | This IG |
| Provenance.agent:Rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palveluntuottaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Aktiivi_rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Ohjelmisto.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPatient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerOnBehalfOf.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPractioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerDevice.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-PROV-1 | error | Provenance | A register specifier must be provided when occupational healthcare is concerned (register identifier: occupational healthcare). |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists()
|
| PTA-PROV-2 | error | Provenance | The register specifier is used only in connection with the occupational healthcare register. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists().not() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists().not()
|
| PTA-PROV-3 | error | Provenance | The service unit of the person making the appointment booking is mandatory when the person booking the appointment is a professional. |
Provenance.agent.role.coding.where(code='2').exists() implies Provenance.agent.role.coding.where(code='7').exists()
|
| PTA-PROV-4 | error | Provenance | The service unit of the person making the appointment booking is provided only if the booker of the appointment is a professional or a software. |
Provenance.agent.role.coding.where(code='2' or code='6').exists().not() implies Provenance.agent.role.coding.where(code='7').exists().not()
|
| PTA-PROV-5 | error | Provenance | The end date of the delay must be given in the format yyyy-mm-dd. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').value.toString().length()=10
|
| PTA-PROV-7 | error | Provenance | The service event identifier (Provenance.extension.ServiceEvent) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').exists() implies Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').value.value.length() < 125
|
| PTA-PROV-8 | error | Provenance | The register specifier (Provenance.extension.RegisterSpecifier) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists() implies (Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.system.length()+ Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.value.length()) < 125
|
| PTA-PROV-9 | error | Provenance | When the customer has made the appointment booking, the identifiers of the customer and the person making the appointment booking must match. |
agent.where(role.coding.code = '12').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value = agent.where(role.coding.code = '12').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-10 | error | Provenance | When a person has made the appointment booking on behalf of another person, the person's identifier cannot be the same as the customer's identifier. |
agent.where(role.coding.code = '5').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value != agent.where(role.coding.code = '5').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-11 | error | Provenance | Only a professional may use the reason code 3 for appointment replacement. |
Provenance.activity.coding.where(code='3').exists() implies Provenance.agent.role.coding.where(code='2').exists()
|
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Appointment metadata Constraints: PTA-PROV-1, PTA-PROV-2, PTA-PROV-3, PTA-PROV-4, PTA-PROV-5, PTA-PROV-7, PTA-PROV-8, PTA-PROV-9, PTA-PROV-10, PTA-PROV-11 |
| id |
0..1 | id | Unique identifier of the resource | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Applied specification Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance (no extensions allowed) | |
| language |
1..1 | code | Language of the appointment Binding: CommonLanguages (required) | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:RegisterSpecifier |
0..1 | Identifier | Register specifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier | |
| extension:ReleaseDateForPatientViewing |
0..1 | date | End date of the delay URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing | |
| extension:ServiceEvent |
1..1 | (Complex) | Service event identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent | |
| id |
0..0 | Unique id for inter-element referencing | ||
| value[x] |
1..1 | Identifier | Service event identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| extension:Status |
0..1 | (Complex) | Record status. ERA will overwrite this. URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| value[x] |
1..1 | Coding | Record status Binding: fipta-vs-recordstatus (required) | |
| extension:RestrictionParent |
0..1 | Coding | Prohibition of disclosure to guardians URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent Binding: fipta-vs-restrictionparent (required) | |
| extension:TableOfContents |
0..1 | (Complex) | View URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-tableofcontentsprotected (required) | |
| extension:RegisterType |
1..1 | (Complex) | Register identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-registertype (required) | |
| target |
1..1 | Reference(EraAppointmentAppointment) | Appointment | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Reference to the unique identifier of the Appointment resource | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..1 | string | Display name Fixed Value: Ajanvaraus (no extensions allowed) | |
| occurred[x] |
0..0 | When the activity occurred | ||
| recorded |
1..1 | instant | Recording time | |
| policy |
0..0 | Policy or plan the activity was defined by | ||
| location |
0..0 | Where the activity occurred, if relevant | ||
| reason |
0..0 | Reason the activity is occurring | ||
| activity |
0..1 | CodeableConcept | Reason for replacement Binding: fipta-vs-updatereason (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value for the reason for replacing the appointment | |
| display |
1..1 | string | Reason for replacing the appointment | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Closed by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:Rekisterinpitaja |
1..1 | BackboneElement | Controller | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Reference to the resource to be used | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Controller identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Controller name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Palveluntuottaja |
1..1 | BackboneElement | Service provider | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Service provider Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 13 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Service provider identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service provider identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Organization name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Tallentajan_palveluyksikko |
0..1 | BackboneElement | Service unit of the person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Service unit of the person making the appointment booking action Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 7 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Service unit of the person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service unit identifier Binding: fipta-vs-organization (required) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Organization name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Isantaorganisaatio |
0..1 | BackboneElement | Host of the tenant | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Host of the tenant Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 8 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Identifier of the tenant host organization | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Host organization identifier (service provider) Binding: fipta-vs-organization (required) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Palvelunjarjestaja |
1..1 | BackboneElement | Service organizer | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Service organizer Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 10 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Service organizer identifier | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service organizer identifier Binding: fipta-vs-organization (required) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Organization name | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Aktiivi_rekisterinpitaja |
0..1 | BackboneElement | Active controller | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 11 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
0..0 | Reference to the resource to be used | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
1..1 | string | Text alternative for the resource | |
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Ohjelmisto |
1..1 | BackboneElement | Software that produced the information | |
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 4 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Patient |
1..1 | BackboneElement | Patient or customer | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Patient or customer Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentPatient) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerPatient |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Patient who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 12 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentBookerPatient) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerOnBehalfOf |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Proxy who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 5 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentBookerOnBehalfOf) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerPractioner |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Professional who stored the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(AppointmentPractitioner) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:AppointmentBookerDevice |
0..1 | BackboneElement | Person making the appointment booking action | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | Software that recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the role Fixed Value: 6 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaDevice) {r} | Who participated | |
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| entity |
0..0 | An entity used in this activity | ||
| signature |
0..0 | Electronic signatures | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | required | Not State | Unknown | |
| Provenance.extension:Status.value[x] | Base | required | fipta-vs-recordstatus | 📦1.0.0 | This IG |
| Provenance.extension:TableOfContents.value[x] | Base | required | fipta-vs-tableofcontentsprotected | 📦1.0.0 | This IG |
| Provenance.extension:RegisterType.value[x] | Base | required | fipta-vs-registertype | 📦1.0.0 | This IG |
| Provenance.activity | Base | required | fipta-vs-updatereason | 📦1.0.0 | This IG |
| Provenance.agent:Rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palveluntuottaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Aktiivi_rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Ohjelmisto.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPatient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerOnBehalfOf.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPractioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerDevice.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-PROV-1 | error | Provenance | A register specifier must be provided when occupational healthcare is concerned (register identifier: occupational healthcare). |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists()
|
| PTA-PROV-2 | error | Provenance | The register specifier is used only in connection with the occupational healthcare register. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists().not() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists().not()
|
| PTA-PROV-3 | error | Provenance | The service unit of the person making the appointment booking is mandatory when the person booking the appointment is a professional. |
Provenance.agent.role.coding.where(code='2').exists() implies Provenance.agent.role.coding.where(code='7').exists()
|
| PTA-PROV-4 | error | Provenance | The service unit of the person making the appointment booking is provided only if the booker of the appointment is a professional or a software. |
Provenance.agent.role.coding.where(code='2' or code='6').exists().not() implies Provenance.agent.role.coding.where(code='7').exists().not()
|
| PTA-PROV-5 | error | Provenance | The end date of the delay must be given in the format yyyy-mm-dd. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').value.toString().length()=10
|
| PTA-PROV-7 | error | Provenance | The service event identifier (Provenance.extension.ServiceEvent) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').exists() implies Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').value.value.length() < 125
|
| PTA-PROV-8 | error | Provenance | The register specifier (Provenance.extension.RegisterSpecifier) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists() implies (Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.system.length()+ Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.value.length()) < 125
|
| PTA-PROV-9 | error | Provenance | When the customer has made the appointment booking, the identifiers of the customer and the person making the appointment booking must match. |
agent.where(role.coding.code = '12').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value = agent.where(role.coding.code = '12').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-10 | error | Provenance | When a person has made the appointment booking on behalf of another person, the person's identifier cannot be the same as the customer's identifier. |
agent.where(role.coding.code = '5').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value != agent.where(role.coding.code = '5').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-11 | error | Provenance | Only a professional may use the reason code 3 for appointment replacement. |
Provenance.activity.coding.where(code='3').exists() implies Provenance.agent.role.coding.where(code='2').exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Appointment metadata Constraints: PTA-PROV-1, PTA-PROV-2, PTA-PROV-3, PTA-PROV-4, PTA-PROV-5, PTA-PROV-7, PTA-PROV-8, PTA-PROV-9, PTA-PROV-10, PTA-PROV-11 |
| id |
0..1 | id | Unique identifier of the resource | |
| meta |
0..1 | Meta | Metadata about the resource | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
1..1 | canonical(StructureDefinition) | Applied specification Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentProvenance (no extensions allowed) | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| language |
1..1 | code | Language of the appointment Binding: CommonLanguages (required) | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:RegisterSpecifier |
0..1 | Identifier | Register specifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier | |
| extension:ReleaseDateForPatientViewing |
0..1 | date | End date of the delay URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing | |
| extension:ServiceEvent |
1..1 | (Complex) | Service event identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent" | |
| value[x] |
1..1 | Identifier | Service event identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Service event namespace Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service event identifier Example General: 123456 | |
| extension:Status |
0..1 | (Complex) | Record status. ERA will overwrite this. URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/Status" | |
| value[x] |
1..1 | Coding | Record status Binding: fipta-vs-recordstatus (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value for the record status | |
| display |
1..1 | string | Name of the record status | |
| extension:RestrictionParent |
0..1 | Coding | Prohibition of disclosure to guardians URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent Binding: fipta-vs-restrictionparent (required) | |
| extension:TableOfContents |
0..1 | (Complex) | View URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-tableofcontentsprotected (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Code value of the view | |
| display |
1..1 | string | Representation defined by the system | |
| extension:RegisterType |
1..1 | (Complex) | Register identifier URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: fipta-vs-registertype (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
1..1 | string | Representation defined by the system | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..1 | Reference(EraAppointmentAppointment) | Appointment | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
C | 1..1 | string | Reference to the unique identifier of the Appointment resource |
| display |
0..1 | string | Display name Fixed Value: Ajanvaraus (no extensions allowed) | |
| recorded |
1..1 | instant | Recording time | |
| activity |
0..1 | CodeableConcept | Reason for replacement Binding: fipta-vs-updatereason (required) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| 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 | |
| code |
1..1 | code | Code value for the reason for replacing the appointment | |
| display |
1..1 | string | Reason for replacing the appointment | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Closed by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
| agent:Rekisterinpitaja |
1..1 | BackboneElement | Controller | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Controller identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Controller name | |
| agent:Palveluntuottaja |
1..1 | BackboneElement | Service provider | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service provider Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 13 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Service provider identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service provider identifier Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Tallentajan_palveluyksikko |
0..1 | BackboneElement | Service unit of the person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service unit of the person making the appointment booking action Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 7 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Service unit of the person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service unit identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Isantaorganisaatio |
0..1 | BackboneElement | Host of the tenant | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Host of the tenant Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 8 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Identifier of the tenant host organization | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Host organization identifier (service provider) Binding: fipta-vs-organization (required) Example General: 123456 | |
| agent:Palvelunjarjestaja |
1..1 | BackboneElement | Service organizer | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Service organizer Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 10 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Service organizer identifier | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Service organizer identifier Binding: fipta-vs-organization (required) Example General: 123456 | |
| display |
1..1 | string | Organization name | |
| agent:Aktiivi_rekisterinpitaja |
0..1 | BackboneElement | Active controller | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Controller Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 11 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 (no extensions allowed) | |
| value |
1..1 | string | Controller identifier Example General: 123456 | |
| display |
1..1 | string | Text alternative for the resource | |
| agent:Ohjelmisto |
1..1 | BackboneElement | Software that produced the information | |
| 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 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| 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 Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 4 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:Patient |
1..1 | BackboneElement | Patient or customer | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient or customer Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPatient) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPatient |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Patient who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 12 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerPatient) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerOnBehalfOf |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Proxy who recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 5 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentBookerOnBehalfOf) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerPractioner |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Professional who stored the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(AppointmentPractitioner) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| agent:AppointmentBookerDevice |
0..1 | BackboneElement | Person making the appointment booking action | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | Software that recorded the appointment Binding: Value Set Kanta Provenance Role Category (required) | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
1..1 | Coding | Kanta Provenance Role Category | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Code value of the role Fixed Value: 6 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaDevice) {r} | 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 | 1..1 | string | Reference to the resource to be used |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | required | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.extension:Status.value[x] | Base | required | fipta-vs-recordstatus | 📦1.0.0 | This IG |
| Provenance.extension:TableOfContents.value[x] | Base | required | fipta-vs-tableofcontentsprotected | 📦1.0.0 | This IG |
| Provenance.extension:RegisterType.value[x] | Base | required | fipta-vs-registertype | 📦1.0.0 | This IG |
| Provenance.activity | Base | required | fipta-vs-updatereason | 📦1.0.0 | This IG |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palveluntuottaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Tallentajan_palveluyksikko.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Isantaorganisaatio.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Palvelunjarjestaja.who.identifier.value | Base | required | fipta-vs-organization | 📦1.0.0 | This IG |
| Provenance.agent:Aktiivi_rekisterinpitaja.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Ohjelmisto.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPatient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerOnBehalfOf.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerPractioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:AppointmentBookerDevice.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-PROV-1 | error | Provenance | A register specifier must be provided when occupational healthcare is concerned (register identifier: occupational healthcare). |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists()
|
| PTA-PROV-2 | error | Provenance | The register specifier is used only in connection with the occupational healthcare register. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType').value.where(code='4').exists().not() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists().not()
|
| PTA-PROV-3 | error | Provenance | The service unit of the person making the appointment booking is mandatory when the person booking the appointment is a professional. |
Provenance.agent.role.coding.where(code='2').exists() implies Provenance.agent.role.coding.where(code='7').exists()
|
| PTA-PROV-4 | error | Provenance | The service unit of the person making the appointment booking is provided only if the booker of the appointment is a professional or a software. |
Provenance.agent.role.coding.where(code='2' or code='6').exists().not() implies Provenance.agent.role.coding.where(code='7').exists().not()
|
| PTA-PROV-5 | error | Provenance | The end date of the delay must be given in the format yyyy-mm-dd. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').exists() implies Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing').value.toString().length()=10
|
| PTA-PROV-7 | error | Provenance | The service event identifier (Provenance.extension.ServiceEvent) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').exists() implies Provenance.extension.where(url='https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent').value.value.length() < 125
|
| PTA-PROV-8 | error | Provenance | The register specifier (Provenance.extension.RegisterSpecifier) exceeds the allowed maximum length. |
Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').exists() implies (Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.system.length()+ Provenance.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier').value.value.length()) < 125
|
| PTA-PROV-9 | error | Provenance | When the customer has made the appointment booking, the identifiers of the customer and the person making the appointment booking must match. |
agent.where(role.coding.code = '12').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value = agent.where(role.coding.code = '12').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-10 | error | Provenance | When a person has made the appointment booking on behalf of another person, the person's identifier cannot be the same as the customer's identifier. |
agent.where(role.coding.code = '5').exists() implies (agent.where(role.coding.code = '3').first().who.resolve().identifier.where(use = 'official').first().value != agent.where(role.coding.code = '5').first().who.resolve().identifier.where(use = 'official').first().value)
|
| PTA-PROV-11 | error | Provenance | Only a professional may use the reason code 3 for appointment replacement. |
Provenance.activity.coding.where(code='3').exists() implies Provenance.agent.role.coding.where(code='2').exists()
|
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
Summary
Mandatory: 49 elements(55 nested mandatory elements)
Fixed: 32 elements
Prohibited: 178 elements
Structures
This structure refers to these other structures:
- EraAppointmentAppointment (https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentAppointment)
- KantaDevice (https://gen.kanta.fi/fhir/StructureDefinition/KantaDevice)
- AppointmentPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPatient)
- AppointmentBookerPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerPatient)
- AppointmentBookerOnBehalfOf (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf)
- AppointmentPractitioner (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPractitioner)
Extensions
This structure refers to these extensions:
- https://pta.kanta.fi/fhir/StructureDefinition/extension/RegisterSpecifier
- https://pta.kanta.fi/fhir/StructureDefinition/extension/ReleaseDateForPatientViewing
- https://gen.kanta.fi/fhir/StructureDefinition/extension/serviceEvent
- https://gen.kanta.fi/fhir/StructureDefinition/extension/Status
- https://pta.kanta.fi/fhir/StructureDefinition/extension/RestrictionParent
- https://pta.kanta.fi/fhir/StructureDefinition/extension/TableOfContents
- https://gen.kanta.fi/fhir/StructureDefinition/extension/RegisterType
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Provenance.agent (Closed)
Other representations of profile: CSV, Excel, Schematron