FinnishScheduling R4 Implementation Guide

There are no (further) constraints on this element

Element id

Appointment.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Appointment.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Mappings

rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Appointment.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: N/A

extension

0..*

Element id

Appointment.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Slicing

Unordered, Open, by url(Value)

Mappings

rim: N/A

ServiceEvent

0..1

Element id

Appointment.extension:ServiceEvent

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

22 Palvelutapahtuman tunniste

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/ServiceEventExt

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

TopicId

0..1

Element id

Appointment.extension:TopicId

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

23 Asian tunniste

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/TopicIdExt

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

QueueNo

0..*

Element id

Appointment.extension:QueueNo

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

82 Jonotusnumero

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/QueueNoExt

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

TicketNo

0..*

Element id

Appointment.extension:TicketNo

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

101 Tikettinumero

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/TicketNoExt

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

VisibleToCustodian

0..1

Element id

Appointment.extension:VisibleToCustodian

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

59 Ajanvarauksen tietojen näyttäminen huoltajalle

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

CustomerJourney

0..*

Extension(Complex)

Element id

Appointment.extension:CustomerJourney

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

Comments

20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

Data type

Extension(Complex)

Extension URL

http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

ParentAppointment

0..1

Element id

Appointment.extension:ParentAppointment

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

12 Pääajanvaraus

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/ParentAppointment

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

SelfServiceExtension

0..1

Extension(Complex)

Element id

Appointment.extension:SelfServiceExtension

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

84 AsiointiURL 84.1 Järjestelmä tukee alaikäisen puolesta asiointia 84.2 Järjestelmä tukee puolesta-asiointia valtakirjalla täysi-ikäisen puolesta 84.3 Järjestelmä tukee rekisteripohjaista puolesta-asiointia täysi-ikäisen puolesta

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

ResourceCalendar

0..*

Extension(Complex)

Element id

Appointment.extension:ResourceCalendar

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

74 Resurssin kalenteritunniste 75 Resurssin nimi

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

ResourceCalendarId

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Requirements

74 Resurssin kalenteritunniste

Comments

Data type

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

url

1..1

Fixed Value

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed value

ResourceCalendarId

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Mappings

rim: N/A

valueIdentifier

There are no (further) constraints on this element

Data type

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Mappings

v2: CX.5
rim: Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..0

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarId.value[x].assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

ResourceCalendarName

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarName

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Requirements

75 Resurssin nimi

Comments

Data type

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarName.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarName.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

url

1..1

Fixed Value

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarName.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Fixed value

ResourceCalendarName

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.extension:ResourceCalendarName.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Mappings

rim: N/A

valueString

There are no (further) constraints on this element

Data type

url

1..1

Fixed Value

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Fixed value

http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Appointment.extension:ResourceCalendar.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Mappings

rim: N/A

ReferralId

0..*

Element id

Appointment.extension:ReferralId

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

24 Ajanvaraukseen liittyvän lähetteen tai pyynnön tunniste

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

RequestedService

0..1

Extension(Complex)

Element id

Appointment.extension:RequestedService

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

73 Varaustuote 73.1 Varaustuotteen nimi

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

MiscAppointmentData

0..1

Element id

Appointment.extension:MiscAppointmentData

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

91 Muu sisältö

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

PractitionerGender

0..1

Element id

Appointment.extension:PractitionerGender

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

93 Palvelun toteuttajan sukupuoli

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

NotificationMedium

0..*

Element id

Appointment.extension:NotificationMedium

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

94 Muistutuksen tapa

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

CareGuarantee

0..1

Element id

Appointment.extension:CareGuarantee

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

97 Hoitotakuu

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

AdditionalInformationURL

0..*

Element id

Appointment.extension:AdditionalInformationURL

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

98 Lisätietojen osoite

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

CarePlan

0..*

Element id

Appointment.extension:CarePlan

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

17 Ajanvaraukseen liittyvän suunnitelman tunniste

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

AppointmentMutability

0..1

Extension(Complex)

Element id

Appointment.extension:AppointmentMutability

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

95 Peruttavissa 96 Siirrettävissä 96.1 Peruutuksen tai siirron aikaraja

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

modifierExtension

0..*

There are no (further) constraints on this element

Element id

Appointment.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Mappings

rim: N/A

identifier

1..1

Element id

Appointment.identifier

Short description

External Ids for this item

Definition

hl7fi: 18 Ajanvarauksen tunniste - mandatory, not recurring

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Data type

Mappings

workflow: Request.identifier
w5: FiveWs.identifier
v2: SCH-1, SCH-2, ARQ-1, ARQ-2
rim: .id
ical: UID

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Appointment.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Mappings

v2: CX.5
rim: Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

There are no (further) constraints on this element

Element id

Appointment.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..0

There are no (further) constraints on this element

Element id

Appointment.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..0

There are no (further) constraints on this element

Element id

Appointment.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

status

Σ ?!

1..1

codeBinding

Element id

Appointment.status

Short description

Definition

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Requirements

19 Ajanvarauksen tila

Comments

hl7fi: Requires mapping to Ajanvarauksen tila -koodistoon (1.2.246.537.6.881.201501). Other mappings ok apart from "siirretty" (entered-in-error?) ja "suunniteltu".

If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

Data type

Binding

The free/busy status of an appointment.

AppointmentStatus (required)

Mappings

workflow: Request.status
w5: FiveWs.status
v2: SCH-25
rim: .statusCode
ical: STATUS
finnishcodeset: urn:oid:1.2.246.537.6.881.201501

cancelationReason

0..1

Element id

Appointment.cancelationReason

Short description

The coded reason for the appointment being cancelled

Definition

The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

Requirements

19.1 Ajanvarauksen perumisen tai siirtämisen syy

Mandatory, if cancellation status is equivalent to "Siirretty" or "Peruttu"

Data type

AppointmentCancellationReason (example)

Binding

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

system

0..1

uriFixed Value

Element id

Appointment.cancelationReason.coding.system

Short description

THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

Fixed value

urn:oid:1.2.246.537.6.126.2008

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

serviceCategory

0..1

Element id

Appointment.serviceCategory

Short description

A broad categorization of the service that is to be performed during this appointment

Definition

A broad categorization of the service that is to be performed during this appointment.

Requirements

71.1 Palvelun luokka

Data type

Binding

ServiceCategory (example)

Mappings

rim: n/a, might be inferred from the ServiceDeliveryLocation
ical: CATEGORIES

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

system

0..1

uriFixed Value

Element id

Appointment.serviceCategory.coding.system

Short description

AR/YDIN - Palvelutapahtumaluokitus

Definition

hl7fi: koodilla ilmaistu tieto palveluluokasta, johon ajanvaraus kohdistuu Huom. Palveluluokka ilmaistaan THL - Sosiaali- ja terveyspalvelujen luokituksen avulla.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Fixed value

urn:oid:1.2.246.537.6.88.2008

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceCategory.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

serviceType

1..1

Element id

Appointment.serviceType

Short description

The specific service that is to be performed during this appointment

Definition

The specific service that is to be performed during this appointment.

Requirements

71 Palvelun nimi

Comments

For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

Data type

Binding

ServiceType (example)

Mappings

workflow: Request.code
rim: n/a, might be inferred from the ServiceDeliveryLocation

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

system

0..1

uriFixed Value

Element id

Appointment.serviceType.coding.system

Short description

THL - Sosiaali- ja terveysalan palvelunimikkeistö

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

71 Palvelun nimi

Comments

hl7fi: koodilla ilmaistu tieto palvelusta, johon ajanvaraus kohdistuu Huom. Palvelun nimi ilmaistaan THL - Sosiaali- ja terveysalan palvelunimikkeistön avulla.

Data type

Fixed value

urn:oid:1.2.246.537.6.49.201501

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Appointment.serviceType.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.specialty

Short description

The specialty of a practitioner that would be required to perform the service requested in this appointment

Definition

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Data type

PracticeSettingCodeValueSet (preferred)

Binding

Mappings

w5: FiveWs.class
rim: .performer.AssignedPerson.code

appointmentType

0..1

CodeableConceptBinding

Element id

Appointment.appointmentType

Short description

The style of appointment or patient that has been booked in the slot (not service type)

Definition

The style of appointment or patient that has been booked in the slot (not service type).

Requirements

72 Asiointitapa

Data type

Binding

v2.0276 (preferred)

Mappings

v2: ARQ-7
rim: .code
ical: CLASSIFICATION

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

system

0..1

uriFixed Value

Element id

Appointment.appointmentType.coding.system

Short description

hl7fi: asiointitapa

Definition

hl7fi: koodilla ilmaistu tieto ammattihenkilön ja asiakkaan välisen asioinnin tavasta

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Fixed value

1.2.246.537.6.884.2015

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonCode

0..*

CodeableConceptBinding

Element id

Appointment.reasonCode

Short description

Coded reason this appointment is scheduled

Definition

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

Data type

EncounterReasonCodes (preferred)

Slicing

Unordered, Open, by coding(Exists)

Binding

The Reason for the appointment to take place.

Mappings

workflow: Request.reasonCode
v2: AIS-3, SCH-7
rim: .reasonCode

sliceSisaltotarkenne

0..*

CodeableConceptBinding

Element id

Appointment.reasonCode:sliceSisaltotarkenne

Short description

Coded reason this appointment is scheduled

Definition

hl7fi: 85 Varauksen sisältötarkenne, koodilla ilmaistu tarkentava tieto palvelun sisällöstä Huom. Tarkenteeksi voi valita useamman kuin yhden koodin, ja koodit voivat kuvata esimerkiksi sitä, mitä kuvantamis- tai laboratoriotutkimuksia tai toimenpiteitä suoritetaan.

Requirements

85 Varauksen sisältötarkenne

Data type

EncounterReasonCodes (preferred)

Binding

The Reason for the appointment to take place.

Mappings

workflow: Request.reasonCode
v2: AIS-3, SCH-7
rim: .reasonCode

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

1..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

system

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

Appointment.reasonCode:sliceSisaltotarkenne.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

slicePalvelutarve

0..1

CodeableConceptBinding

Element id

Appointment.reasonCode:slicePalvelutarve

Short description

Coded reason this appointment is scheduled

Definition

hl7fi: 76 Palvelutarve vapaamuotoisena tekstinä ilmaistu tieto asiakkaan palvelutarpeesta Huom. Palvelutarve kuvataan tasolla, jolla henkilön palveluiden tarve voidaan kuvata yhteisellä termillä, esim. raskausajan seuranta ja tuki.

Requirements

76 Palvelutarve

Data type

EncounterReasonCodes (preferred)

Binding

The Reason for the appointment to take place.

Mappings

workflow: Request.reasonCode
v2: AIS-3, SCH-7
rim: .reasonCode

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:slicePalvelutarve.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.reasonCode:slicePalvelutarve.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

coding

0..0

There are no (further) constraints on this element

Element id

Appointment.reasonCode:slicePalvelutarve.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

1..1

There are no (further) constraints on this element

Element id

Appointment.reasonCode:slicePalvelutarve.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonReference

0..*

Reference(Condition)

Element id

Appointment.reasonReference

Short description

Reason the appointment is to take place (resource)

Definition

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

Requirements

56 kuvaus oireista/vaivasta ja 57 riskitiedot (Condition/Note)

Data type

Reference(Condition)

Allowed aggregation:contained

Mappings

workflow: Request.reasonReference
rim: .inboundRelationship[@typeCode = 'RSON'].observation

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonReference.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.reasonReference.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.reasonReference.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

Element id

Appointment.reasonReference.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Fixed value

Condition

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Appointment.reasonReference.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Mappings

rim: .identifier

display

0..0

There are no (further) constraints on this element

Element id

Appointment.reasonReference.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Mappings

rim: N/A

priority

0..0

unsignedInt

There are no (further) constraints on this element

Element id

Appointment.priority

Short description

Used to make informed decisions if needing to re-prioritize

Definition

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

Comments

Seeking implementer feedback on this property and how interoperable it is.

Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.

Data type

unsignedInt

Mappings

workflow: Request.priority
w5: FiveWs.class
v2: ARQ-12, SCH-11.6 / TQ1-9
rim: .priorityCode
ical: PRIORITY

description

0..0

There are no (further) constraints on this element

Element id

Appointment.description

Short description

Shown on a subject line in a meeting request, or appointment list

Definition

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

Data type

Mappings

v2: NTE-3
rim: .text
ical: SUMMARY

supportingInformation

0..0

Reference(Resource)

There are no (further) constraints on this element

Element id

Appointment.supportingInformation

Short description

Additional information to support the appointment

Definition

Additional information to support the appointment provided when making the appointment.

Data type

Reference(Resource)

Mappings

workflow: Request.supportingInfo
w5: FiveWs.context
rim: .inboundRelationship[@typeCode = 'SPRT'].observation
ical: ATTACH

start

0..1

Element id

Appointment.start

Short description

When appointment is to take place

Definition

Date/Time that the appointment is to take place.

Requirements

86 Aikaväli

Data type

Mappings

workflow: Request.occurrence[x]
w5: FiveWs.init
v2: ARQ-11.1, SCH-11.4 / TQ1-7
rim: .effectiveTime.low
ical: DTSTART

end

0..1

Element id

Appointment.end

Short description

When appointment is to conclude

Definition

Date/Time that the appointment is to conclude.

Requirements

86 Aikaväli

Data type

Mappings

workflow: Request.occurrence[x]
w5: FiveWs.done[x]
v2: SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
rim: .effectiveTime.high
ical: DTEND

minutesDuration

0..0

positiveInt

There are no (further) constraints on this element

Element id

Appointment.minutesDuration

Short description

Can be less than start/end (e.g. estimate)

Definition

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

Data type

positiveInt

Mappings

workflow: Request.occurrence[x]
rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
ical: DURATION (e.g. PT15M)

slot

0..*

Reference(Slot)

There are no (further) constraints on this element

Element id

Appointment.slot

Short description

The slots that this appointment is filling

Definition

The slots from the participants' schedules that will be filled by the appointment.

Data type

Reference(Slot)

Mappings

rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']

created

0..1

dateTime

Element id

Appointment.created

Short description

The date that this appointment was initially created

Definition

The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

Requirements

38 Merkinnän kirjausaika

Comments

This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.

Data type

dateTime

Mappings

workflow: Request.authoredOn
rim: .author.time
ical: CREATED

comment

0..1

Element id

Appointment.comment

Short description

hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto

Definition

hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto

Requirements

99 Huomautukset

Comments

Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"

Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.

Data type

Mappings

workflow: Request.note
v2: NTE-3
rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
ical: DESCRIPTION (for internal use)

patientInstruction

0..1

Element id

Appointment.patientInstruction

Short description

hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje

Definition

hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje, joka tarjoaa asiakkaalle tietoa esimerkiksi sairaudesta, tutkimuksista, hoidoista, toimenpiteisiin valmistautumisesta, jälkihoidosta, itsehoidosta, toipumisesta, sairauden kulusta ja sairauden ennusteesta Huom. Potilasohje voi olla esim. Käypä hoito -suositus tai yleinen sairaalan antama ohje, joka voi olla myös yksikkökohtainen.

Requirements

100 Potilasohje

Data type

Mappings

v2: NTE-3
rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
ical: DESCRIPTION (for patient use)

0..1

There are no (further) constraints on this element

Element id

Appointment.patientInstruction.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references)

Data type

extension

0..*

Element id

Appointment.patientInstruction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

PatientInstructionURL

0..*

Element id

Appointment.patientInstruction.extension:PatientInstructionURL

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Requirements

100.1 Linkki potilasohjeeseen

Comments

Data type

http://hl7.fi/fhir/StructureDefinition/PatientInstructionURLExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

0..1

There are no (further) constraints on this element

Element id

Appointment.patientInstruction.value

Short description

Primitive value for string

Definition

The actual value

Maximum string length

1048576

basedOn

0..0

Reference(ServiceRequest)

There are no (further) constraints on this element

Element id

Appointment.basedOn

Short description

The service request this appointment is allocated to assess

Alternate names

incomingReferral

Definition

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Data type

Reference(ServiceRequest)

Mappings

workflow: Request.basedOn
rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']

participant

1..*

BackboneElement

There are no (further) constraints on this element

Element id

Appointment.participant

Short description

Participants involved in appointment

Definition

List of participants involved in the appointment.

Data type

BackboneElement

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
app-1: Either the type or actor on the participant SHALL be specified
type.exists() or actor.exists()

Mappings

workflow: Request.performer, Request.subject
v2: PID, AIP, AIG, AIL
rim: performer | reusableDevice | subject | location
ical: ATTENDEE component to be created

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Mappings

rim: n/a

modifierExtension

Σ ?!

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Mappings

rim: N/A

type

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.participant.type

Short description

Role of participant in the appointment

Definition

Role of participant in the appointment.

Comments

The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.

If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.

This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.

Data type

Binding

Role of participant in encounter.

ParticipantType (extensible)

Mappings

v2: AIP-4, AIG-4
rim: (performer | reusableDevice | subject | location).@typeCode
ical: n/a

actor

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor

Short description

Person, Location/HealthcareService or Device

Definition

A Person, Location/HealthcareService or Device that is participating in the appointment.

Data type

Mappings

w5: FiveWs.who
v2: PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
rim: performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
ical: ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"

required

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.participant.required

Short description

required | optional | information-only

Definition

Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

Data type

ParticipantRequired (required)

Binding

Is the Participant required to attend the appointment.

Mappings

rim: (performer | reusableDevice | subject | location).@performInd
ical: ROLE=REQ-PARTICIPANT (roleparam)

status

1..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.participant.status

Short description

accepted | declined | tentative | needs-action

Definition

Participation status of the actor.

Data type

ParticipationStatus (required)

Binding

The Participation status of an appointment.

Mappings

v2: AIP-12, AIG-14
rim: (performer | reusableDevice | subject | location).statusCode
ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)

period

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.period

Short description

Participation period of the actor

Definition

Participation period of the actor.

Data type

Mappings

rim: n/a

requestedPeriod

0..1

Element id

Appointment.requestedPeriod

Short description

Potential date/time interval(s) requested to allocate the appointment within

Definition

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

Requirements

35 Ajankohta, jolloin ajanvaraus ohjeistettu tehtäväksi

Comments

This does not introduce a capacity for recurring appointments.

Data type