0.1.0 - draft

NyTimelosingIG - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: HnBasisAppointment - Detailed Descriptions

Draft as of 2024-06-01

Definitions for the hn-basis-appointment resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Appointment
InvariantscancelationReason-inv: Cancelation reason MUST be set when status=cancelled and serviceCategory=27 (that is Specialist Medical) ((status='canceled' and serviceCategory.coding.code='27') implies cancelationReason.exists())
contained-location-must-have-managingorganization: Contained location must have managing organization (Appointment.contained.where($this is Location).empty() or Appointment.contained.where($this is Location).all(managingOrganization.exists()))
2. Appointment.meta
Definition

Information about use of metadata in FHIR resources in helsenorge: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/743014401/Meta+informasjon+som+kan+benyttes+for+alle+FHIR+ressurser. Se list of metadata that is to be used in context of an appointment:https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2052685825/Draft+-+Timenotifikasjon.+Ny+nasjonal+timel+sning#Appointment%3A-Metadata. suppressNotification: Use for suppressing notification reminder: Used to define if reminders is active. hasAppointmentDetail: Tels if there is more information available regarding the appointment. If used Helsenorge will try to get the details from communication part. CommunicationPart must support that the details can be pulled. supportPatientDialog: Patient dialog supported and childParentRestrictons: setting posible restriction if parents are to get information about the appointment or only the child.

ShortInformation about use of metadata in FHIR resources in helsenorge:
4. Appointment.extension:virtualService
Slice NamevirtualService
6. Appointment.extension:virtualService.extension:channelType
Slice NamechannelType
8. Appointment.extension:virtualService.extension:channelType.value[x]
BindingThe codes SHALL be taken from Hn Basis VirtualServiceType Value Set
[x] NoteSee Choice of Data Types for further information about how to use [x]
10. Appointment.extension:recurring
Slice Namerecurring
Control0..1
TypeExtension(hn-basis-recurring) (Extension Type: boolean)
Must Supporttrue
12. Appointment.extension:postponementReason
Slice NamepostponementReason
Control0..1
TypeExtension(hn-basis-postponementreason) (Extension Type: Coding)
14. Appointment.extension:consultationType
Slice NameconsultationType
Control0..1
TypeExtension(hn-basis-consultationType) (Extension Type: Coding)
Must Supporttrue
16. Appointment.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
18. Appointment.identifier.system
Control1..?
20. Appointment.identifier.value
Control1..?
22. Appointment.identifier.assigner
Control1..?
TypeReference(Organization, no-basis-Organization)
24. Appointment.cancelationReason
Definition

Volven 8445 is a preferred code system but other code systems as Volven 9179 can also be used

ShortReason for cancelation
BindingThe codes SHOULD be taken from urn:oid:2.16.578.1.12.4.1.1.8445
26. Appointment.cancelationReason.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
28. Appointment.serviceCategory
Control1..1
BindingThe codes SHALL be taken from hn-appointment-ServiceCategory-code-vs
30. Appointment.serviceCategory.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
32. Appointment.serviceType
34. Appointment.serviceType.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
36. Appointment.specialty
38. Appointment.specialty.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
40. Appointment.appointmentType
Control1..?
42. Appointment.appointmentType.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
44. Appointment.appointmentType.coding:helsenorge
Slice Namehelsenorge
Definition

Codes from value set

ShortCodes from value set
Control0..1
BindingThe codes SHALL be taken from hn-appointment-AppointmentType-code-vs
Must Supporttrue
46. Appointment.reasonCode
48. Appointment.reasonCode.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
50. Appointment.description
Invariantsmust-be-max-100-chars: Length MUST be <=100. ($this.length() <= 100)
52. Appointment.supportingInformation
Definition

Spesial instructions for use: Se https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2052685825/Draft+-+Timenotifikasjon.+Ny+nasjonal+timel+sning SuportingInformation MUST at least refer to communication part (herid level 2) using Organization profile kommunikasjonspart-Organization (https://simplifier.net/hl7norwayno-basis/kommunikasjonspart-organization)

ShortSpesial instructions for use.
Control1..?
54. Appointment.patientInstruction
Invariantsmust-be-max-500-chars: Length MUST be <= 500 ($this.length() <= 500)
56. Appointment.participant
Invariantsappointment-participant-actor-patient-reference-identifier: When actor is a Patient logical reference MUST be used (actor.type = 'Patient' implies actor.identifier.exists())
appointment-participant-actor-patient-reference-reference: When actor is a Patient literal reference (relative, internal or absolute) reference MUST not be used ((actor.type = 'Patient') implies actor.reference.exists().not())
58. Appointment.participant.type
60. Appointment.participant.type.coding
Invariantsinv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
62. Appointment.participant.actor
Definition

When actor is a Patient only logical reference MUST be used. In all other cases Logical, Literal reference, Relative, internal or absolute URL can be used

ShortWhen actor is a Patient logical reference MUST be used
Control1..?
TypeReference(no-basis-Patient, no-basis-Practitioner, no-basis-PractitionerRole, no-basis-Location, no-basis-RelatedPerson, Device, no-basis-HealthcareService)

Guidance on how to interpret the contents of this table can be found here

0. Appointment
Definition

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

ShortA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
app-2: Either start and end are specified, or neither (start.exists() = end.exists())
cancelationReason-inv: Cancelation reason MUST be set when status=cancelled and serviceCategory=27 (that is Specialist Medical) ((status='canceled' and serviceCategory.coding.code='27') implies cancelationReason.exists())
contained-location-must-have-managingorganization: Contained location must have managing organization (Appointment.contained.where($this is Location).empty() or Appointment.contained.where($this is Location).all(managingOrganization.exists()))
2. Appointment.meta
Definition

Information about use of metadata in FHIR resources in helsenorge: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/743014401/Meta+informasjon+som+kan+benyttes+for+alle+FHIR+ressurser. Se list of metadata that is to be used in context of an appointment:https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2052685825/Draft+-+Timenotifikasjon.+Ny+nasjonal+timel+sning#Appointment%3A-Metadata. suppressNotification: Use for suppressing notification reminder: Used to define if reminders is active. hasAppointmentDetail: Tels if there is more information available regarding the appointment. If used Helsenorge will try to get the details from communication part. CommunicationPart must support that the details can be pulled. supportPatientDialog: Patient dialog supported and childParentRestrictons: setting posible restriction if parents are to get information about the appointment or only the child.


The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortInformation about use of metadata in FHIR resources in helsenorge:Metadata about the resource
Control0..1
This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Appointment.implicitRules
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.

ShortA set of rules under which this content was created
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.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Appointment.extension:virtualService
Slice NamevirtualService
Definition

The VirtualService structure defines details of a virtual communication capability, such as a web conference call.

ShortVirtual Service
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(no-basis-Virtual-Service) (Complex Extension)
Must Supporttrue
Invariantsele-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())
8. Appointment.extension:virtualService.extension:channelType
Slice NamechannelType
Definition

An Extension

ShortExtensionAdditional content defined by implementations
Control0..1*
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-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())
10. Appointment.extension:virtualService.extension:channelType.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
12. Appointment.extension:virtualService.extension:channelType.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuechannelType
14. Appointment.extension:virtualService.extension:channelType.value[x]
Definition

The valuesett inherits all codes from http://hl7.org/fhir/contact-point-system and http://hl7.org/fhir/virtual-service-type. Virtual-service-type is from R5.


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

ShortValuset for virtual servie.Value of extension
Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see Hn Basis VirtualServiceType Value Set
TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Appointment.extension:virtualService.extension:virtualAddress
Slice NamevirtualAddress
Definition

Address or number needs to be used for a user to connect to the virtual service to join.

ShortContact address/numberAdditional content defined by implementations
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.

Control0..1*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
18. Appointment.extension:virtualService.extension:virtualAddress.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
20. Appointment.extension:virtualService.extension:virtualAddress.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuevirtualAddress
22. Appointment.extension:virtualService.extension:additionalInfo
Slice NameadditionalInfo
Definition

Address to see alternative connection details.

ShortAddress to see alternative connection detailsAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
24. Appointment.extension:virtualService.extension:additionalInfo.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
26. Appointment.extension:virtualService.extension:additionalInfo.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueadditionalInfo
28. Appointment.extension:virtualService.extension:maxParticipants
Slice NamemaxParticipants
Definition

Maximum number of participants supported by the virtual service.

ShortMaximum number of participants supported by the virtual service.Additional content defined by implementations
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.

Control0..1*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
30. Appointment.extension:virtualService.extension:maxParticipants.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
32. Appointment.extension:virtualService.extension:maxParticipants.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuemaxParticipants
34. Appointment.extension:virtualService.extension:sessionKey
Slice NamesessionKey
Definition

Session Key required by the virtual service.

ShortSession Key required by the virtual serviceAdditional content defined by implementations
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.

Control0..1*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
36. Appointment.extension:virtualService.extension:sessionKey.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
38. Appointment.extension:virtualService.extension:sessionKey.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuesessionKey
40. Appointment.extension:virtualService.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Valuehttp://hl7.no/fhir/StructureDefinition/no-basis-virtual-service
42. Appointment.extension:virtualService.value[x]
Definition

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

ShortValue of extension
Control0..01
This element is affected by the following invariants: ele-1
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Appointment.extension:group
Slice Namegroup
Definition

The appointment is a group session.

Shortno-basis-group
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(no-basis-group) (Extension Type: boolean)
Must Supporttrue
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
46. Appointment.extension:partOf
Slice NamepartOf
Definition

This basis extension mirrors the Encounter.partOF-attribute. The partOf-attribute enables booking of a set of related appointments with a set of sub-appointments being linked to the main appointment in the same way as encounters are being linked. A larger appointment of which this particular appointment is a component or step.

Shortno-basis-partof
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(no-basis-partof) (Extension Type: Reference(no-basis-Appointment))
Must Supporttrue
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
48. Appointment.extension:recurring
Slice Namerecurring
Definition

Indicates that this appointment is of recurrence type. In R5 this is handled by own structure.

Shortno-basis-recurring
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(hn-basis-recurring) (Extension Type: boolean)
Must Supporttrue
Invariantsele-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())
50. Appointment.extension:postponementReason
Slice NamepostponementReason
Definition

The reason code for the postponement.

Shorthn-basis-postponementreason
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(hn-basis-postponementreason) (Extension Type: Coding)
Invariantsele-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())
52. Appointment.extension:consultationType
Slice NameconsultationType
Definition

Type of consultation.

Shorthn-basis-consultationType
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(hn-basis-consultationType) (Extension Type: Coding)
Must Supporttrue
Invariantsele-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())
54. Appointment.modifierExtension
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).

ShortExtensions that cannot be ignored
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standards StatusNormative (from Trial Use)
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.

Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
56. Appointment.identifier
Definition

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

ShortExternal Ids for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
This element is affected by the following invariants: ele-1
TypeIdentifier
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Appointment.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Appointment.identifier.system
Definition

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

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
This element is affected by the following invariants: ele-1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Appointment.identifier.value
Definition

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

ShortThe value that is unique
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.

Control10..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Appointment.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
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.

Control10..1
This element is affected by the following invariants: ele-1
TypeReference(Organization, no-basis-Organization)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
66. Appointment.status
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.

Shortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Comments

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.

Control1..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1

The free/busy status of an appointment.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Appointment.cancelationReason
Definition

Volven 8445 is a preferred code system but other code systems as Volven 9179 can also be used


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.

ShortReason for cancelationThe coded reason for the appointment being cancelled
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from For example codes, see urn:oid:2.16.578.1.12.4.1.1.8445http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
TypeCodeableConcept
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Appointment.cancelationReason.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
72. Appointment.serviceCategory
Definition

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

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

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control10..1*
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For example codes, see hn-appointment-ServiceCategory-code-vshttp://hl7.org/fhir/ValueSet/service-category
TypeCodeableConcept
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Appointment.serviceCategory.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
76. Appointment.appointmentType
Definition

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

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

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control10..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276
TypeCodeableConcept
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Appointment.appointmentType.coding
Definition

Recomended code systems for no-basis-Appointment. The recomended code systems might not be suficient for defining appointment type and in an implemented profile - some other coding might be needed.


A reference to a code defined by a terminology system.

ShortRecomended code systems for no-basis-Appointment.Code defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
SlicingThis element introduces a set of slices on Appointment.appointmentType.coding. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ $this
80. Appointment.appointmentType.coding:omsorgsNiva
Slice NameomsorgsNiva
Definition

Omsorgsnivå (OID=8406).


A reference to a code defined by a terminology system.

ShortVolven 8406Code defined by a terminology system
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.

Control0..1*
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see urn:oid:2.16.578.1.12.4.1.1.8406: Volven
TypeCoding
Must Supportfalse
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Appointment.appointmentType.coding:kontaktType
Slice NamekontaktType
Definition

Kontakttype (OID=8432)


A reference to a code defined by a terminology system.

ShortVolven 8432Code defined by a terminology system
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.

Control0..1*
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see urn:oid:2.16.578.1.12.4.1.1.8432: Volven
TypeCoding
Must Supportfalse
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Appointment.appointmentType.coding:innbygger
Slice Nameinnbygger
Definition

Timetype innbyggerportal (OID=7617)


A reference to a code defined by a terminology system.

ShortVolven 7617Code defined by a terminology system
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.

Control0..1*
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see urn:oid:2.16.578.1.12.4.1.1.7617: Volven
TypeCoding
Must Supportfalse
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Appointment.appointmentType.coding:helsenorge
Slice Namehelsenorge
Definition

Codes from value set


A reference to a code defined by a terminology system.

ShortCodes from value setCode defined by a terminology system
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.

Control0..1*
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see hn-appointment-AppointmentType-code-vs
TypeCoding
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Appointment.description
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.

ShortShown on a subject line in a meeting request, or appointment list
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
must-be-max-100-chars: Length MUST be <=100. ($this.length() <= 100)
90. Appointment.supportingInformation
Definition

Spesial instructions for use: Se https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2052685825/Draft+-+Timenotifikasjon.+Ny+nasjonal+timel+sning SuportingInformation MUST at least refer to communication part (herid level 2) using Organization profile kommunikasjonspart-Organization (https://simplifier.net/hl7norwayno-basis/kommunikasjonspart-organization)


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

ShortSpesial instructions for use.Additional information to support the appointment
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control10..*
This element is affected by the following invariants: ele-1
TypeReference(Resource)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
92. Appointment.patientInstruction
Definition

While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

ShortDetailed information and instructions for the patient
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
must-be-max-500-chars: Length MUST be <= 500 ($this.length() <= 500)
94. Appointment.participant
Definition

List of participants involved in the appointment.

ShortParticipants involved in appointment
Control1..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Invariantsele-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())
appointment-participant-actor-patient-reference-identifier: When actor is a Patient logical reference MUST be used (actor.type = 'Patient' implies actor.identifier.exists())
appointment-participant-actor-patient-reference-reference: When actor is a Patient literal reference (relative, internal or absolute) reference MUST not be used ((actor.type = 'Patient') implies actor.reference.exists().not())
96. Appointment.participant.modifierExtension
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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
98. Appointment.participant.actor
Definition

When actor is a Patient only logical reference MUST be used. In all other cases Logical, Literal reference, Relative, internal or absolute URL can be used


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

ShortWhen actor is a Patient logical reference MUST be usedPerson, Location/HealthcareService or Device
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control10..1
This element is affected by the following invariants: ele-1
TypeReference(no-basis-Patient, no-basis-Practitioner, no-basis-PractitionerRole, no-basis-Location, no-basis-RelatedPerson, Device, no-basis-HealthcareService, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService, Location)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
100. Appointment.participant.status
Definition

Participation status of the actor.

Shortaccepted | declined | tentative | needs-action
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1

The Participation status of an appointment.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Appointment
Definition

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

ShortA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
app-2: Either start and end are specified, or neither (start.exists() = end.exists())
cancelationReason-inv: Cancelation reason MUST be set when status=cancelled and serviceCategory=27 (that is Specialist Medical) ((status='canceled' and serviceCategory.coding.code='27') implies cancelationReason.exists())
contained-location-must-have-managingorganization: Contained location must have managing organization (Appointment.contained.where($this is Location).empty() or Appointment.contained.where($this is Location).all(managingOrganization.exists()))
2. Appointment.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Summarytrue
4. Appointment.meta
Definition

Information about use of metadata in FHIR resources in helsenorge: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/743014401/Meta+informasjon+som+kan+benyttes+for+alle+FHIR+ressurser. Se list of metadata that is to be used in context of an appointment:https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2052685825/Draft+-+Timenotifikasjon.+Ny+nasjonal+timel+sning#Appointment%3A-Metadata. suppressNotification: Use for suppressing notification reminder: Used to define if reminders is active. hasAppointmentDetail: Tels if there is more information available regarding the appointment. If used Helsenorge will try to get the details from communication part. CommunicationPart must support that the details can be pulled. supportPatientDialog: Patient dialog supported and childParentRestrictons: setting posible restriction if parents are to get information about the appointment or only the child.

ShortInformation about use of metadata in FHIR resources in helsenorge:
Control0..1
This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Appointment.implicitRules
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.

ShortA set of rules under which this content was created
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.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Appointment.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from CommonLanguages: A human language.
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Appointment.text
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.

ShortText summary of the resource, for human interpretation
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeNarrative
Standards StatusNormative (from Trial Use)
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Appointment.contained
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.

ShortContained, inline Resources
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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
14. Appointment.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. Appointment.extension:virtualService
Slice NamevirtualService
Definition

The VirtualService structure defines details of a virtual communication capability, such as a web conference call.

ShortVirtual Service
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(no-basis-Virtual-Service) (Complex Extension)
Must Supporttrue
Invariantsele-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())
18. Appointment.extension:virtualService.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
20. Appointment.extension:virtualService.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
22. Appointment.extension:virtualService.extension:channelType
Slice NamechannelType
Definition

An Extension

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-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())
24. Appointment.extension:virtualService.extension:channelType.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
26. Appointment.extension:virtualService.extension:channelType.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
28. Appointment.extension:virtualService.extension:channelType.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuechannelType
30. Appointment.extension:virtualService.extension:channelType.value[x]
Definition

The valuesett inherits all codes from http://hl7.org/fhir/contact-point-system and http://hl7.org/fhir/virtual-service-type. Virtual-service-type is from R5.

ShortValuset for virtual servie.
Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Hn Basis VirtualServiceType Value Set
TypeCoding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Appointment.extension:virtualService.extension:virtualAddress
Slice NamevirtualAddress
Definition

Address or number needs to be used for a user to connect to the virtual service to join.

ShortContact address/number
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
34. Appointment.extension:virtualService.extension:virtualAddress.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
36. Appointment.extension:virtualService.extension:virtualAddress.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
38. Appointment.extension:virtualService.extension:virtualAddress.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuevirtualAddress
40. Appointment.extension:virtualService.extension:virtualAddress.value[x]
Definition

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

ShortValue of extension
Control0..1
This element is affected by the following invariants: ele-1
TypeChoice of: string, url, ContactPoint
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Appointment.extension:virtualService.extension:additionalInfo
Slice NameadditionalInfo
Definition

Address to see alternative connection details.

ShortAddress to see alternative connection details
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
44. Appointment.extension:virtualService.extension:additionalInfo.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
46. Appointment.extension:virtualService.extension:additionalInfo.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
48. Appointment.extension:virtualService.extension:additionalInfo.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueadditionalInfo
50. Appointment.extension:virtualService.extension:additionalInfo.value[x]
Definition

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

ShortValue of extension
Control0..1
This element is affected by the following invariants: ele-1
Typeurl
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Appointment.extension:virtualService.extension:maxParticipants
Slice NamemaxParticipants
Definition

Maximum number of participants supported by the virtual service.

ShortMaximum number of participants supported by the virtual service.
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
54. Appointment.extension:virtualService.extension:maxParticipants.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
56. Appointment.extension:virtualService.extension:maxParticipants.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
58. Appointment.extension:virtualService.extension:maxParticipants.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuemaxParticipants
60. Appointment.extension:virtualService.extension:maxParticipants.value[x]
Definition

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

ShortValue of extension
Control0..1
This element is affected by the following invariants: ele-1
TypepositiveInt
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Appointment.extension:virtualService.extension:sessionKey
Slice NamesessionKey
Definition

Session Key required by the virtual service.

ShortSession Key required by the virtual service
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
64. Appointment.extension:virtualService.extension:sessionKey.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
66. Appointment.extension:virtualService.extension:sessionKey.extension
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.

ShortAdditional content defined by implementations
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.

Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
68. Appointment.extension:virtualService.extension:sessionKey.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuesessionKey
70. Appointment.extension:virtualService.extension:sessionKey.value[x]
Definition

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

ShortValue of extension
Control0..1
This element is affected by the following invariants: ele-1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Appointment.extension:virtualService.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Valuehttp://hl7.no/fhir/StructureDefinition/no-basis-virtual-service
74. Appointment.extension:virtualService.value[x]
Definition

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

ShortValue of extension
Control0..0
This element is affected by the following invariants: ele-1
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Appointment.extension:group
Slice Namegroup
Definition

The appointment is a group session.

Shortno-basis-group
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(no-basis-group) (Extension Type: boolean)
Must Supporttrue
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
78. Appointment.extension:partOf
Slice NamepartOf
Definition

This basis extension mirrors the Encounter.partOF-attribute. The partOf-attribute enables booking of a set of related appointments with a set of sub-appointments being linked to the main appointment in the same way as encounters are being linked. A larger appointment of which this particular appointment is a component or step.

Shortno-basis-partof
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(no-basis-partof) (Extension Type: Reference(no-basis-Appointment))
Must Supporttrue
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
80. Appointment.extension:recurring
Slice Namerecurring
Definition

Indicates that this appointment is of recurrence type. In R5 this is handled by own structure.

Shortno-basis-recurring
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(hn-basis-recurring) (Extension Type: boolean)
Must Supporttrue
Invariantsele-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())
82. Appointment.extension:postponementReason
Slice NamepostponementReason
Definition

The reason code for the postponement.

Shorthn-basis-postponementreason
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(hn-basis-postponementreason) (Extension Type: Coding)
Invariantsele-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())
84. Appointment.extension:consultationType
Slice NameconsultationType
Definition

Type of consultation.

Shorthn-basis-consultationType
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(hn-basis-consultationType) (Extension Type: Coding)
Must Supporttrue
Invariantsele-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())
86. Appointment.modifierExtension
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.

ShortExtensions that cannot be ignored
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standards StatusNormative (from Trial Use)
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.

Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
88. Appointment.identifier
Definition

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

ShortExternal Ids for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
This element is affected by the following invariants: ele-1
TypeIdentifier
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Appointment.identifier.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
92. Appointment.identifier.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
94. Appointment.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse: Identifies the purpose for this identifier, if known .
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Appointment.identifier.type
Definition

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

ShortDescription of identifier
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.

Control0..1
This element is affected by the following invariants: ele-1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Appointment.identifier.system
Definition

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

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
This element is affected by the following invariants: ele-1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Appointment.identifier.value
Definition

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

ShortThe value that is unique
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.

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Appointment.identifier.period
Definition

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

ShortTime period when id is/was valid for use
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Control0..1
This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
104. Appointment.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
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.

Control1..1
This element is affected by the following invariants: ele-1
TypeReference(Organization, no-basis-Organization)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
106. Appointment.status
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.

Shortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Comments

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.

Control1..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from AppointmentStatus: The free/busy status of an appointment.
Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Appointment.cancelationReason
Definition

Volven 8445 is a preferred code system but other code systems as Volven 9179 can also be used

ShortReason for cancelation
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from urn:oid:2.16.578.1.12.4.1.1.8445
TypeCodeableConcept
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Appointment.cancelationReason.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
112. Appointment.cancelationReason.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.cancelationReason.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
114. Appointment.cancelationReason.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
116. Appointment.cancelationReason.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Appointment.serviceCategory
Definition

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

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

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control1..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from hn-appointment-ServiceCategory-code-vs
TypeCodeableConcept
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Appointment.serviceCategory.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
122. Appointment.serviceCategory.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.serviceCategory.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
124. Appointment.serviceCategory.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
126. Appointment.serviceCategory.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. Appointment.serviceType
Definition

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

ShortThe specific service that is to be performed during this appointment
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.

Control0..*
This element is affected by the following invariants: ele-1
BindingFor example codes, see ServiceType
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. Appointment.serviceType.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
132. Appointment.serviceType.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.serviceType.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
134. Appointment.serviceType.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
136. Appointment.serviceType.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Appointment.specialty
Definition

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

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

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control0..*
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Appointment.specialty.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
142. Appointment.specialty.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.specialty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
144. Appointment.specialty.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
146. Appointment.specialty.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. Appointment.appointmentType
Definition

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

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

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control1..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodes
TypeCodeableConcept
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. Appointment.appointmentType.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
152. Appointment.appointmentType.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.appointmentType.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
154. Appointment.appointmentType.coding
Definition

Recomended code systems for no-basis-Appointment. The recomended code systems might not be suficient for defining appointment type and in an implemented profile - some other coding might be needed.

ShortRecomended code systems for no-basis-Appointment.
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
SlicingThis element introduces a set of slices on Appointment.appointmentType.coding. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ $this
156. Appointment.appointmentType.coding:omsorgsNiva
Slice NameomsorgsNiva
Definition

Omsorgsnivå (OID=8406).

ShortVolven 8406
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.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.8406: Volven
TypeCoding
Must Supportfalse
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. Appointment.appointmentType.coding:kontaktType
Slice NamekontaktType
Definition

Kontakttype (OID=8432)

ShortVolven 8432
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.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.8432: Volven
TypeCoding
Must Supportfalse
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. Appointment.appointmentType.coding:innbygger
Slice Nameinnbygger
Definition

Timetype innbyggerportal (OID=7617)

ShortVolven 7617
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.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.7617: Volven
TypeCoding
Must Supportfalse
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. Appointment.appointmentType.coding:helsenorge
Slice Namehelsenorge
Definition

Codes from value set

ShortCodes from value set
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.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from hn-appointment-AppointmentType-code-vs
TypeCoding
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. Appointment.appointmentType.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Appointment.reasonCode
Definition

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

ShortCoded reason this appointment is scheduled
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control0..*
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from EncounterReasonCodes: The Reason for the appointment to take place.
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. Appointment.reasonCode.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
170. Appointment.reasonCode.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.reasonCode.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
172. Appointment.reasonCode.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
174. Appointment.reasonCode.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. Appointment.reasonReference
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.

ShortReason the appointment is to take place (resource)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control0..*
This element is affected by the following invariants: ele-1
TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
178. Appointment.priority
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).

ShortUsed to make informed decisions if needing to re-prioritize
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Appointment.description
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.

ShortShown on a subject line in a meeting request, or appointment list
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
must-be-max-100-chars: Length MUST be <=100. ($this.length() <= 100)
182. Appointment.supportingInformation
Definition

Spesial instructions for use: Se https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2052685825/Draft+-+Timenotifikasjon.+Ny+nasjonal+timel+sning SuportingInformation MUST at least refer to communication part (herid level 2) using Organization profile kommunikasjonspart-Organization (https://simplifier.net/hl7norwayno-basis/kommunikasjonspart-organization)

ShortSpesial instructions for use.
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control1..*
This element is affected by the following invariants: ele-1
TypeReference(Resource)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
184. Appointment.start
Definition

Date/Time that the appointment is to take place.

ShortWhen appointment is to take place
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Control0..1
This element is affected by the following invariants: ele-1
Typeinstant
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. Appointment.end
Definition

Date/Time that the appointment is to conclude.

ShortWhen appointment is to conclude
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Control0..1
This element is affected by the following invariants: ele-1
Typeinstant
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. Appointment.minutesDuration
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.

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

32 bit number; for values larger than this, use decimal

Control0..1
This element is affected by the following invariants: ele-1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. Appointment.slot
Definition

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

ShortThe slots that this appointment is filling
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control0..*
This element is affected by the following invariants: ele-1
TypeReference(Slot)
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
192. Appointment.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.

ShortThe date that this appointment was initially created
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.

Control0..1
This element is affected by the following invariants: ele-1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Appointment.comment
Definition

Additional comments about the appointment.

ShortAdditional comments
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. Appointment.patientInstruction
Definition

While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

ShortDetailed information and instructions for the patient
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
must-be-max-500-chars: Length MUST be <= 500 ($this.length() <= 500)
198. Appointment.basedOn
Definition

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

ShortThe service request this appointment is allocated to assess
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control0..*
This element is affected by the following invariants: ele-1
TypeReference(ServiceRequest)
Standards StatusNormative (from Trial Use)
Alternate NamesincomingReferral
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
200. Appointment.participant
Definition

List of participants involved in the appointment.

ShortParticipants involved in appointment
Control1..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Invariantsele-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())
appointment-participant-actor-patient-reference-identifier: When actor is a Patient logical reference MUST be used (actor.type = 'Patient' implies actor.identifier.exists())
appointment-participant-actor-patient-reference-reference: When actor is a Patient literal reference (relative, internal or absolute) reference MUST not be used ((actor.type = 'Patient') implies actor.reference.exists().not())
202. Appointment.participant.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
204. Appointment.participant.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.participant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
206. Appointment.participant.modifierExtension
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.

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
208. Appointment.participant.type
Definition

Role of participant in the appointment.

ShortRole 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.

Control0..*
This element is affected by the following invariants: ele-1
BindingUnless not suitable, these codes SHALL be taken from ParticipantType: Role of participant in encounter.
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. Appointment.participant.type.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
212. Appointment.participant.type.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Appointment.participant.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
214. Appointment.participant.type.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-4: If code is used in a codable consept the system must be used (code > '' implies (system > '' ))
216. Appointment.participant.type.text
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.

ShortPlain text representation of the concept
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. Appointment.participant.actor
Definition

When actor is a Patient only logical reference MUST be used. In all other cases Logical, Literal reference, Relative, internal or absolute URL can be used

ShortWhen actor is a Patient logical reference MUST be used
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control1..1
This element is affected by the following invariants: ele-1
TypeReference(no-basis-Patient, no-basis-Practitioner, no-basis-PractitionerRole, no-basis-Location, no-basis-RelatedPerson, Device, no-basis-HealthcareService)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
220. Appointment.participant.required
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.

Shortrequired | optional | information-only
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ParticipantRequired: Is the Participant required to attend the appointment.
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. Appointment.participant.status
Definition

Participation status of the actor.

Shortaccepted | declined | tentative | needs-action
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ParticipationStatus: The Participation status of an appointment.
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Standards StatusNormative (from Trial Use)
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. Appointment.participant.period
Definition

Participation period of the actor.

ShortParticipation period of the actor
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Control0..1
This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
226. Appointment.requestedPeriod
Definition

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

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

This does not introduce a capacity for recurring appointments.

Control0..*
This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))