Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveSchedule - Detailed Descriptions

Active as of 2024-04-19

Definitions for the Interweave-Schedule resource profile.

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

1. Schedule
2. Schedule.id
Must Supporttrue
3. Schedule.meta
Control0..?
4. Schedule.meta.versionId
Control0..?
Must Supporttrue
5. Schedule.meta.lastUpdated
Control0..?
Must Supporttrue
6. Schedule.meta.profile
Control0..?
Must Supporttrue
7. Schedule.meta.security
Control0..?
8. Schedule.meta.tag
Control0..?
SlicingThis element introduces a set of slices on Schedule.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
9. Schedule.meta.tag:Source
SliceNameSource
Control0..1
Must Supporttrue
10. Schedule.meta.tag:Source.system
Control1..?
Fixed Valuehttps://yhcr.nhs.uk/Source
11. Schedule.meta.tag:Source.code
Control1..?
Must Supporttrue
12. Schedule.meta.tag:Source.display
Control1..?
Must Supporttrue
13. Schedule.meta.tag:Provenance
SliceNameProvenance
Control0..1
Must Supporttrue
14. Schedule.meta.tag:Provenance.system
Control1..?
Fixed Valuehttps://yhcr.nhs.uk/Provenance
15. Schedule.meta.tag:Provenance.code
Control1..?
Must Supporttrue
16. Schedule.meta.tag:Provenance.display
Control1..?
Must Supporttrue
17. Schedule.implicitRules
18. Schedule.language
19. Schedule.text
20. Schedule.active
Control10..1
Must Supporttrue
21. Schedule.serviceCategory
BindingThe codes SHOULD be taken from Service categoryFor example codes, see ServiceCategory
22. Schedule.serviceType
Control10..*
BindingThe codes SHOULD be taken from Interweave UkCore Care Setting TypeFor example codes, see ServiceType
Must Supporttrue
23. Schedule.serviceType.coding
Control0..?
24. Schedule.serviceType.coding.system
Control1..?
25. Schedule.serviceType.coding.code
Control1..?
26. Schedule.serviceType.coding.display
Control1..?
27. Schedule.specialty
BindingThe codes SHOULD be taken from Care Connect SDS Job Role NameThe codes SHOULD be taken from Practice Setting Code Value Set
Must Supporttrue
28. Schedule.specialty.coding
Control0..?
29. Schedule.specialty.coding.system
Control1..?
30. Schedule.specialty.coding.code
Control1..?
31. Schedule.specialty.coding.display
Control1..?
32. Schedule.actor
Must Supporttrue
33. Schedule.planningHorizon
Control10..1
Must Supporttrue
34. Schedule.planningHorizon.start
Control1..?
Must Supporttrue

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

1. Schedule
Definition

A container for slots of time that may be available for booking appointments.

Control0..*
Alternate NamesAvailability
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).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())
2. Schedule.id
Definition

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

Control0..1
Typeid
Must Supporttrue
Summarytrue
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.

3. Schedule.meta
Definition

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

Control0..1
TypeMeta
Summarytrue
4. Schedule.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

5. Schedule.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Must Supporttrue
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

6. Schedule.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typeuri
Must Supporttrue
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

7. Schedule.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable

Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

8. Schedule.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

SlicingThis element introduces a set of slices on Schedule.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
9. Schedule.meta.tag:Source
SliceNameSource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

10. Schedule.meta.tag:Source.system
Definition

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

Control10..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttps://yhcr.nhs.uk/Source
11. Schedule.meta.tag:Source.code
Definition

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

Control10..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

12. Schedule.meta.tag:Source.display
Definition

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

Control10..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

13. Schedule.meta.tag:Provenance
SliceNameProvenance
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

14. Schedule.meta.tag:Provenance.system
Definition

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

Control10..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttps://yhcr.nhs.uk/Provenance
15. Schedule.meta.tag:Provenance.code
Definition

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

Control10..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

16. Schedule.meta.tag:Provenance.display
Definition

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

Control10..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

17. Schedule.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.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

18. Schedule.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
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).

19. Schedule.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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 in formation is added later.

20. Schedule.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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
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.

21. Schedule.identifier
Definition

External Ids for this item.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
TypeIdentifier
Summarytrue
22. Schedule.active
Definition

Whether this schedule record is in active use, or should not be used (such as was entered in error).

Control10..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Summarytrue
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Default Valuetrue
23. Schedule.serviceCategory
Definition

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

Control0..1
BindingThe codes SHOULD be taken from Service categoryFor example codes, see ServiceCategory
TypeCodeableConcept
Summarytrue
24. Schedule.serviceType
Definition

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

Control10..*
BindingThe codes SHOULD be taken from Interweave UkCore Care Setting TypeFor example codes, see ServiceType
TypeCodeableConcept
Must Supporttrue
Summarytrue
25. Schedule.specialty
Definition

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

Control0..*
BindingThe codes SHOULD be taken from Care Connect SDS Job Role NameThe codes SHOULD be taken from Practice Setting Code Value Set
TypeCodeableConcept
Must Supporttrue
Summarytrue
26. Schedule.actor
Definition

The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.

Control1..*
TypeReference(Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService|Location)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Comments

The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a pracitioner and a room(location) are always required by a system.

27. Schedule.planningHorizon
Definition

The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.

Control10..1
TypePeriod
Must Supporttrue
Summarytrue
28. Schedule.planningHorizon.start
Definition

The start of the period. The boundary is inclusive.

Control10..1 This element is affected by the following invariants: per-1
TypedateTime
Must Supporttrue
Summarytrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

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

1. Schedule
Definition

A container for slots of time that may be available for booking appointments.

Control0..*
Alternate NamesAvailability
2. Schedule.id
Definition

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

Control0..1
Typeid
Must Supporttrue
Summarytrue
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.

3. Schedule.meta
Definition

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

Control0..1
TypeMeta
Summarytrue
4. Schedule.meta.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
5. Schedule.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Schedule.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

7. Schedule.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Must Supporttrue
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

8. Schedule.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typeuri
Must Supporttrue
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

9. Schedule.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

10. Schedule.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

SlicingThis element introduces a set of slices on Schedule.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
11. Schedule.meta.tag:Source
SliceNameSource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

12. Schedule.meta.tag:Source.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Schedule.meta.tag:Source.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. Schedule.meta.tag:Source.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttps://yhcr.nhs.uk/Source
15. Schedule.meta.tag:Source.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

16. Schedule.meta.tag:Source.code
Definition

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

Control1..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

17. Schedule.meta.tag:Source.display
Definition

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

Control1..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

18. Schedule.meta.tag:Source.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

19. Schedule.meta.tag:Provenance
SliceNameProvenance
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

20. Schedule.meta.tag:Provenance.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Schedule.meta.tag:Provenance.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. Schedule.meta.tag:Provenance.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttps://yhcr.nhs.uk/Provenance
23. Schedule.meta.tag:Provenance.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

24. Schedule.meta.tag:Provenance.code
Definition

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

Control1..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

25. Schedule.meta.tag:Provenance.display
Definition

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

Control1..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

26. Schedule.meta.tag:Provenance.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

27. Schedule.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.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

28. Schedule.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
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).

29. Schedule.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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 in formation is added later.

30. Schedule.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.

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

31. Schedule.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

32. Schedule.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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
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.

33. Schedule.identifier
Definition

External Ids for this item.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Summarytrue
34. Schedule.active
Definition

Whether this schedule record is in active use, or should not be used (such as was entered in error).

Control1..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Summarytrue
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Default Valuetrue
35. Schedule.serviceCategory
Definition

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

Control0..1
BindingThe codes SHOULD be taken from Service category
TypeCodeableConcept
Summarytrue
36. Schedule.serviceType
Definition

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

Control1..*
BindingThe codes SHOULD be taken from Interweave UkCore Care Setting Type
TypeCodeableConcept
Must Supporttrue
Summarytrue
37. Schedule.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
38. Schedule.serviceType.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.serviceType.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
39. Schedule.serviceType.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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.

40. Schedule.serviceType.coding.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
41. Schedule.serviceType.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.serviceType.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. Schedule.serviceType.coding.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

43. Schedule.serviceType.coding.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

44. Schedule.serviceType.coding.code
Definition

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

45. Schedule.serviceType.coding.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

46. Schedule.serviceType.coding.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

47. Schedule.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.

Control0..1
Typestring
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.

Comments

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

48. Schedule.specialty
Definition

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

Control0..*
BindingThe codes SHOULD be taken from Care Connect SDS Job Role Name
TypeCodeableConcept
Must Supporttrue
Summarytrue
49. Schedule.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
50. Schedule.specialty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.specialty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
51. Schedule.specialty.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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.

52. Schedule.specialty.coding.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
53. Schedule.specialty.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.specialty.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. Schedule.specialty.coding.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

55. Schedule.specialty.coding.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

56. Schedule.specialty.coding.code
Definition

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

57. Schedule.specialty.coding.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

58. Schedule.specialty.coding.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

59. Schedule.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.

Control0..1
Typestring
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.

Comments

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

60. Schedule.actor
Definition

The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.

Control1..*
TypeReference(Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService|Location)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Comments

The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a pracitioner and a room(location) are always required by a system.

61. Schedule.planningHorizon
Definition

The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.

Control1..1
TypePeriod
Must Supporttrue
Summarytrue
62. Schedule.planningHorizon.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
63. Schedule.planningHorizon.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

SlicingThis element introduces a set of slices on Schedule.planningHorizon.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. Schedule.planningHorizon.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 This element is affected by the following invariants: per-1
TypedateTime
Must Supporttrue
Summarytrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

65. Schedule.planningHorizon.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Summarytrue
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
66. Schedule.comment
Definition

Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Control0..1
Typestring