UK Core Implementation Guide 0.5.0

StructureDefinition-UKCore-Schedule

Defines the UK Core constraints and extensions on the Schedule resource for the minimal set of data to query and retrieve schedule information.

Profile Purpose

This profile allows exchange of details of a container for slots of time that may be available for booking appointments.

Snapshot View

Schedule	I		Schedule	There are no (further) constraints on this element Element Id Schedule Short description A container for slots of time that may be available for booking appointments Alternate names Availability Definition A container for slots of time that may be available for booking appointments. Data Type Schedule Constraints dom-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()` Mappings rim:Entity. Role, or Act rim:n/a ical:BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Schedule.identifier Short description External Ids for this item Definition External Ids for this item. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier ical:UID
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Schedule.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Schedule.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Schedule.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Schedule.active Short description Whether this schedule is in active use Definition Whether this schedule record is in active use or should not be used (such as was entered in error). Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Schedule.serviceCategory Short description High-level category Definition A 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. Data Type CodeableConcept Binding ServiceCategory (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Schedule.serviceType Short description Specific service Definition The specific 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. Data Type CodeableConcept Binding ServiceType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class ical:n/a
specialty	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.specialty Short description Type of specialty needed Definition The 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. Data Type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). PracticeSettingCodeValueSet (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
actor	Σ I	1..*	Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson)	Element Id Schedule.actor Short description Resource(s) that availability information is being provided for Definition Slots that reference this schedule resource provide the availability details to these referenced resource(s). 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 practitioner and a room (Location) are always required by a system. Data Type Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:FiveWs.subject[x] ical:ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource w5:FiveWs.subject
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Schedule.actor.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Schedule.actor.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Schedule.actor.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.actor.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Schedule.actor.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.actor.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Schedule.actor.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
planningHorizon	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.planningHorizon Short description Period of time covered by schedule Definition The period of time that the slots that reference 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.planned ical:DTSTART:20131201T003000Z DTEND:2014030101T003000Z
comment		0..1	string	There are no (further) constraints on this element Element Id Schedule.comment Short description Comments on availability Definition Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a ical:COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry

Differential View

Schedule	I		Schedule	There are no (further) constraints on this element Element Id Schedule Short description A container for slots of time that may be available for booking appointments Alternate names Availability Definition A container for slots of time that may be available for booking appointments. Data Type Schedule Constraints dom-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()` Mappings rim:Entity. Role, or Act rim:n/a ical:BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Schedule.identifier Short description External Ids for this item Definition External Ids for this item. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier ical:UID
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Schedule.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Schedule.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Schedule.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Schedule.active Short description Whether this schedule is in active use Definition Whether this schedule record is in active use or should not be used (such as was entered in error). Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Schedule.serviceCategory Short description High-level category Definition A 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. Data Type CodeableConcept Binding ServiceCategory (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Schedule.serviceType Short description Specific service Definition The specific 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. Data Type CodeableConcept Binding ServiceType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class ical:n/a
specialty	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.specialty Short description Type of specialty needed Definition The 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. Data Type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). PracticeSettingCodeValueSet (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
actor	Σ I	1..*	Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson)	Element Id Schedule.actor Short description Resource(s) that availability information is being provided for Definition Slots that reference this schedule resource provide the availability details to these referenced resource(s). 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 practitioner and a room (Location) are always required by a system. Data Type Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:FiveWs.subject[x] ical:ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource w5:FiveWs.subject
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Schedule.actor.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Schedule.actor.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Schedule.actor.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.actor.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Schedule.actor.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.actor.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Schedule.actor.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
planningHorizon	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.planningHorizon Short description Period of time covered by schedule Definition The period of time that the slots that reference 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.planned ical:DTSTART:20131201T003000Z DTEND:2014030101T003000Z
comment		0..1	string	There are no (further) constraints on this element Element Id Schedule.comment Short description Comments on availability Definition Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a ical:COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry

Hybrid View

Schedule	I		Schedule	There are no (further) constraints on this element Element Id Schedule Short description A container for slots of time that may be available for booking appointments Alternate names Availability Definition A container for slots of time that may be available for booking appointments. Data Type Schedule Constraints dom-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()` Mappings rim:Entity. Role, or Act rim:n/a ical:BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Schedule.identifier Short description External Ids for this item Definition External Ids for this item. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier ical:UID
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Schedule.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Schedule.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Schedule.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Schedule.active Short description Whether this schedule is in active use Definition Whether this schedule record is in active use or should not be used (such as was entered in error). Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Schedule.serviceCategory Short description High-level category Definition A 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. Data Type CodeableConcept Binding ServiceCategory (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Schedule.serviceType Short description Specific service Definition The specific 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. Data Type CodeableConcept Binding ServiceType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class ical:n/a
specialty	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.specialty Short description Type of specialty needed Definition The 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. Data Type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). PracticeSettingCodeValueSet (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
actor	Σ I	1..*	Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson)	Element Id Schedule.actor Short description Resource(s) that availability information is being provided for Definition Slots that reference this schedule resource provide the availability details to these referenced resource(s). 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 practitioner and a room (Location) are always required by a system. Data Type Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:FiveWs.subject[x] ical:ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource w5:FiveWs.subject
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Schedule.actor.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Schedule.actor.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Schedule.actor.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Schedule.actor.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Schedule.actor.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.actor.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Schedule.actor.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Schedule.actor.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
planningHorizon	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Schedule.planningHorizon Short description Period of time covered by schedule Definition The period of time that the slots that reference 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.planned ical:DTSTART:20131201T003000Z DTEND:2014030101T003000Z
comment		0..1	string	There are no (further) constraints on this element Element Id Schedule.comment Short description Comments on availability Definition Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a ical:COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry

Table View

Schedule		..
Schedule.identifier		..
Schedule.identifier.assigner	Reference(UK Core Organization)	..
Schedule.actor	Reference(UK Core Device \| UK Core HealthcareService \| UK Core Location \| UK Core Patient \| UK Core Practitioner \| UK Core PractitionerRole \| UK Core RelatedPerson)	..
Schedule.actor.identifier		..
Schedule.actor.identifier.assigner	Reference(UK Core Organization)	..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Schedule" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule" />
    <version value="1.1.0" />
    <name value="UKCoreSchedule" />
    <title value="UK Core Schedule" />
    <status value="active" />
    <date value="2022-05-20" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints on the Schedule resource to describe a container for slots of time that may be available for booking appointments." />
    <purpose value="Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\n\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="ical" />
        <uri value="http://ietf.org/rfc/2445" />
        <name value="iCalendar" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Schedule" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Schedule" />
    <derivation value="constraint" />
    <differential>
        <element id="Schedule.identifier.assigner">
            <path value="Schedule.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Schedule.actor">
            <path value="Schedule.actor" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
        </element>
        <element id="Schedule.actor.identifier.assigner">
            <path value="Schedule.actor.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Schedule",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule",
    "version": "1.1.0",
    "name": "UKCoreSchedule",
    "title": "UK Core Schedule",
    "status": "active",
    "date": "2022-05-20",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints on the Schedule resource to describe a container for slots of time that may be available for booking appointments.",
    "purpose": "Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\n\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "ical",
            "uri": "http://ietf.org/rfc/2445",
            "name": "iCalendar"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Schedule",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Schedule",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Schedule.identifier.assigner",
                "path": "Schedule.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Schedule.actor",
                "path": "Schedule.actor",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    }
                ]
            },
            {
                "id": "Schedule.actor.identifier.assigner",
                "path": "Schedule.actor.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Example UKCore-Schedule-Immunization

Example Usage Scenarios

The following are example usage scenarios for the UK Core Schedule profile:

Query for details of a schedule
Exchange schedule information within a FHIR document or message.

Profile specific implementation guidance:

`identifier`

External identifiers for this item.

Provider Systems

It is recommended that the identifier value is a Universally Unique Identifier (UUID) as there is no nationally recognised business identifier for an instance of a recorded Schedule.

Consumer Systems

Consumer systems MUST consume this data.

`active`

This flag is used to mark the record to not be used. Assumed to be active if no value is provided for the active element.

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

`serviceCategory`

Identifies the broad category of service.

This element currently uses the FHIR example ValueSet shown below as no UK Core ValueSet has been defined:

HTML View

This code system http://terminology.hl7.org/CodeSystem/service-category defines many codes, of which the following are some examples:

Code	Display	Definition
1	Adoption	Adoption
2	Aged Care	Aged Care
34	Allied Health	Allied Health
3	Alternative/Complementary Therapies	Alternative & Complementary Therapies
4	Child Care /Kindergarten	Child Care and/or Kindergarten
5	Child Development	Child Development
6	Child Protection & Family Services	Child Protection & Family Services
7	Community Health Care	Community Health Care
8	Counselling	Counselling
36	Crisis Line (GPAH use only)	Crisis Line (GPAH use only)
9	Death Services	Death Services
10	Dental	Dental
11	Disability Support	Disability Support
12	Drug/Alcohol	Drug/Alcohol
13	Education & Learning	Education & Learning
14	Emergency Department	Emergency Department
15	Employment	Employment
16	Financial & Material Aid	Financial & Material aid
17	General Practice	General Practice/GP (doctor)
35	Hospital	Hospital
18	Housing/Homelessness	Housing/Homelessness
19	Interpreting	Interpreting
20	Justice	Justice
21	Legal	Legal
22	Mental Health	Mental Health
38	NDIA	NDIA
23	Physical Activity & Recreation	Physical Activity & Recreation
24	Regulation	Regulation
25	Respite/Carer Support	Respite/Carer Support
26	Specialist Clinical Pathology	Specialist Clinical Pathology - requires referral
27	Specialist Medical	Specialist Medical - requires referral
28	Specialist Obstetrics & Gynecology	Specialist Obstetrics & Gynecology - requires referral
29	Specialist Paediatric	Specialist Paediatric - requires referral
30	Specialist Radiology/Imaging	Specialist Radiology/Imaging - requires referral
31	Specialist Surgical	Specialist Surgical - requires referral
32	Support Group/s	Support group/s
37	Test Message (HSD admin)	Test Message (HSD admin use only)
33	Transport	Transport

Table View

CodeSystem.id[0]	service-category
CodeSystem.meta[0].lastUpdated[0]	2019-11-01T09:29:23.356+11:00
CodeSystem.meta[0].profile[0]	http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]	pa
CodeSystem.extension[1].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]	draft
CodeSystem.extension[2].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]	1
CodeSystem.url[0]	http://terminology.hl7.org/CodeSystem/service-category
CodeSystem.identifier[0].system[0]	urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]	urn:oid:2.16.840.1.113883.4.642.4.1144
CodeSystem.version[0]	4.0.1
CodeSystem.name[0]	ServiceCategory
CodeSystem.title[0]	Service category
CodeSystem.status[0]	draft
CodeSystem.experimental[0]	False
CodeSystem.publisher[0]	FHIR Project team
CodeSystem.contact[0].telecom[0].system[0]	url
CodeSystem.contact[0].telecom[0].value[0]	http://hl7.org/fhir
CodeSystem.description[0]	This value set defines an example set of codes that can be used to classify groupings of service-types/specialties.
CodeSystem.caseSensitive[0]	True
CodeSystem.valueSet[0]	http://hl7.org/fhir/ValueSet/service-category
CodeSystem.content[0]	example
CodeSystem.concept[0].code[0]	1
CodeSystem.concept[0].display[0]	Adoption
CodeSystem.concept[0].definition[0]	Adoption
CodeSystem.concept[1].code[0]	2
CodeSystem.concept[1].display[0]	Aged Care
CodeSystem.concept[1].definition[0]	Aged Care
CodeSystem.concept[2].code[0]	34
CodeSystem.concept[2].display[0]	Allied Health
CodeSystem.concept[2].definition[0]	Allied Health
CodeSystem.concept[3].code[0]	3
CodeSystem.concept[3].display[0]	Alternative/Complementary Therapies
CodeSystem.concept[3].definition[0]	Alternative & Complementary Therapies
CodeSystem.concept[4].code[0]	4
CodeSystem.concept[4].display[0]	Child Care /Kindergarten
CodeSystem.concept[4].definition[0]	Child Care and/or Kindergarten
CodeSystem.concept[5].code[0]	5
CodeSystem.concept[5].display[0]	Child Development
CodeSystem.concept[5].definition[0]	Child Development
CodeSystem.concept[6].code[0]	6
CodeSystem.concept[6].display[0]	Child Protection & Family Services
CodeSystem.concept[6].definition[0]	Child Protection & Family Services
CodeSystem.concept[7].code[0]	7
CodeSystem.concept[7].display[0]	Community Health Care
CodeSystem.concept[7].definition[0]	Community Health Care
CodeSystem.concept[8].code[0]	8
CodeSystem.concept[8].display[0]	Counselling
CodeSystem.concept[8].definition[0]	Counselling
CodeSystem.concept[9].code[0]	36
CodeSystem.concept[9].display[0]	Crisis Line (GPAH use only)
CodeSystem.concept[9].definition[0]	Crisis Line (GPAH use only)
CodeSystem.concept[10].code[0]	9
CodeSystem.concept[10].display[0]	Death Services
CodeSystem.concept[10].definition[0]	Death Services
CodeSystem.concept[11].code[0]	10
CodeSystem.concept[11].display[0]	Dental
CodeSystem.concept[11].definition[0]	Dental
CodeSystem.concept[12].code[0]	11
CodeSystem.concept[12].display[0]	Disability Support
CodeSystem.concept[12].definition[0]	Disability Support
CodeSystem.concept[13].code[0]	12
CodeSystem.concept[13].display[0]	Drug/Alcohol
CodeSystem.concept[13].definition[0]	Drug/Alcohol
CodeSystem.concept[14].code[0]	13
CodeSystem.concept[14].display[0]	Education & Learning
CodeSystem.concept[14].definition[0]	Education & Learning
CodeSystem.concept[15].code[0]	14
CodeSystem.concept[15].display[0]	Emergency Department
CodeSystem.concept[15].definition[0]	Emergency Department
CodeSystem.concept[16].code[0]	15
CodeSystem.concept[16].display[0]	Employment
CodeSystem.concept[16].definition[0]	Employment
CodeSystem.concept[17].code[0]	16
CodeSystem.concept[17].display[0]	Financial & Material Aid
CodeSystem.concept[17].definition[0]	Financial & Material aid
CodeSystem.concept[18].code[0]	17
CodeSystem.concept[18].display[0]	General Practice
CodeSystem.concept[18].definition[0]	General Practice/GP (doctor)
CodeSystem.concept[19].code[0]	35
CodeSystem.concept[19].display[0]	Hospital
CodeSystem.concept[19].definition[0]	Hospital
CodeSystem.concept[20].code[0]	18
CodeSystem.concept[20].display[0]	Housing/Homelessness
CodeSystem.concept[20].definition[0]	Housing/Homelessness
CodeSystem.concept[21].code[0]	19
CodeSystem.concept[21].display[0]	Interpreting
CodeSystem.concept[21].definition[0]	Interpreting
CodeSystem.concept[22].code[0]	20
CodeSystem.concept[22].display[0]	Justice
CodeSystem.concept[22].definition[0]	Justice
CodeSystem.concept[23].code[0]	21
CodeSystem.concept[23].display[0]	Legal
CodeSystem.concept[23].definition[0]	Legal
CodeSystem.concept[24].code[0]	22
CodeSystem.concept[24].display[0]	Mental Health
CodeSystem.concept[24].definition[0]	Mental Health
CodeSystem.concept[25].code[0]	38
CodeSystem.concept[25].display[0]	NDIA
CodeSystem.concept[25].definition[0]	NDIA
CodeSystem.concept[26].code[0]	23
CodeSystem.concept[26].display[0]	Physical Activity & Recreation
CodeSystem.concept[26].definition[0]	Physical Activity & Recreation
CodeSystem.concept[27].code[0]	24
CodeSystem.concept[27].display[0]	Regulation
CodeSystem.concept[27].definition[0]	Regulation
CodeSystem.concept[28].code[0]	25
CodeSystem.concept[28].display[0]	Respite/Carer Support
CodeSystem.concept[28].definition[0]	Respite/Carer Support
CodeSystem.concept[29].code[0]	26
CodeSystem.concept[29].display[0]	Specialist Clinical Pathology
CodeSystem.concept[29].definition[0]	Specialist Clinical Pathology - requires referral
CodeSystem.concept[30].code[0]	27
CodeSystem.concept[30].display[0]	Specialist Medical
CodeSystem.concept[30].definition[0]	Specialist Medical - requires referral
CodeSystem.concept[31].code[0]	28
CodeSystem.concept[31].display[0]	Specialist Obstetrics & Gynecology
CodeSystem.concept[31].definition[0]	Specialist Obstetrics & Gynecology - requires referral
CodeSystem.concept[32].code[0]	29
CodeSystem.concept[32].display[0]	Specialist Paediatric
CodeSystem.concept[32].definition[0]	Specialist Paediatric - requires referral
CodeSystem.concept[33].code[0]	30
CodeSystem.concept[33].display[0]	Specialist Radiology/Imaging
CodeSystem.concept[33].definition[0]	Specialist Radiology/Imaging - requires referral
CodeSystem.concept[34].code[0]	31
CodeSystem.concept[34].display[0]	Specialist Surgical
CodeSystem.concept[34].definition[0]	Specialist Surgical - requires referral
CodeSystem.concept[35].code[0]	32
CodeSystem.concept[35].display[0]	Support Group/s
CodeSystem.concept[35].definition[0]	Support group/s
CodeSystem.concept[36].code[0]	37
CodeSystem.concept[36].display[0]	Test Message (HSD admin)
CodeSystem.concept[36].definition[0]	Test Message (HSD admin use only)
CodeSystem.concept[37].code[0]	33
CodeSystem.concept[37].display[0]	Transport
CodeSystem.concept[37].definition[0]	Transport

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="service-category" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="draft" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/service-category" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1144" />
    </identifier>
    <version value="4.0.1" />
    <name value="ServiceCategory" />
    <title value="Service category" />
    <status value="draft" />
    <experimental value="false" />
    <publisher value="FHIR Project team" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <description value="This value set defines an example set of codes that can be used to classify groupings of service-types/specialties." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/service-category" />
    <content value="example" />
    <concept>
        <code value="1" />
        <display value="Adoption" />
        <definition value="Adoption" />
    </concept>
    <concept>
        <code value="2" />
        <display value="Aged Care" />
        <definition value="Aged Care" />
    </concept>
    <concept>
        <code value="34" />
        <display value="Allied Health" />
        <definition value="Allied Health" />
    </concept>
    <concept>
        <code value="3" />
        <display value="Alternative/Complementary Therapies" />
        <definition value="Alternative &amp; Complementary Therapies" />
    </concept>
    <concept>
        <code value="4" />
        <display value="Child Care /Kindergarten" />
        <definition value="Child Care and/or Kindergarten" />
    </concept>
    <concept>
        <code value="5" />
        <display value="Child Development" />
        <definition value="Child Development" />
    </concept>
    <concept>
        <code value="6" />
        <display value="Child Protection &amp; Family Services" />
        <definition value="Child Protection &amp; Family Services" />
    </concept>
    <concept>
        <code value="7" />
        <display value="Community Health Care" />
        <definition value="Community Health Care" />
    </concept>
    <concept>
        <code value="8" />
        <display value="Counselling" />
        <definition value="Counselling" />
    </concept>
    <concept>
        <code value="36" />
        <display value="Crisis Line (GPAH use only)" />
        <definition value="Crisis Line (GPAH use only)" />
    </concept>
    <concept>
        <code value="9" />
        <display value="Death Services" />
        <definition value="Death Services" />
    </concept>
    <concept>
        <code value="10" />
        <display value="Dental" />
        <definition value="Dental" />
    </concept>
    <concept>
        <code value="11" />
        <display value="Disability Support" />
        <definition value="Disability Support" />
    </concept>
    <concept>
        <code value="12" />
        <display value="Drug/Alcohol" />
        <definition value="Drug/Alcohol" />
    </concept>
    <concept>
        <code value="13" />
        <display value="Education &amp; Learning" />
        <definition value="Education &amp; Learning" />
    </concept>
    <concept>
        <code value="14" />
        <display value="Emergency Department" />
        <definition value="Emergency Department" />
    </concept>
    <concept>
        <code value="15" />
        <display value="Employment" />
        <definition value="Employment" />
    </concept>
    <concept>
        <code value="16" />
        <display value="Financial &amp; Material Aid" />
        <definition value="Financial &amp; Material aid" />
    </concept>
    <concept>
        <code value="17" />
        <display value="General Practice" />
        <definition value="General Practice/GP (doctor)" />
    </concept>
    <concept>
        <code value="35" />
        <display value="Hospital" />
        <definition value="Hospital" />
    </concept>
    <concept>
        <code value="18" />
        <display value="Housing/Homelessness" />
        <definition value="Housing/Homelessness" />
    </concept>
    <concept>
        <code value="19" />
        <display value="Interpreting" />
        <definition value="Interpreting" />
    </concept>
    <concept>
        <code value="20" />
        <display value="Justice" />
        <definition value="Justice" />
    </concept>
    <concept>
        <code value="21" />
        <display value="Legal" />
        <definition value="Legal" />
    </concept>
    <concept>
        <code value="22" />
        <display value="Mental Health" />
        <definition value="Mental Health" />
    </concept>
    <concept>
        <code value="38" />
        <display value="NDIA" />
        <definition value="NDIA" />
    </concept>
    <concept>
        <code value="23" />
        <display value="Physical Activity &amp; Recreation" />
        <definition value="Physical Activity &amp; Recreation" />
    </concept>
    <concept>
        <code value="24" />
        <display value="Regulation" />
        <definition value="Regulation" />
    </concept>
    <concept>
        <code value="25" />
        <display value="Respite/Carer Support" />
        <definition value="Respite/Carer Support" />
    </concept>
    <concept>
        <code value="26" />
        <display value="Specialist Clinical Pathology" />
        <definition value="Specialist Clinical Pathology - requires referral" />
    </concept>
    <concept>
        <code value="27" />
        <display value="Specialist Medical" />
        <definition value="Specialist Medical - requires referral" />
    </concept>
    <concept>
        <code value="28" />
        <display value="Specialist Obstetrics &amp; Gynecology" />
        <definition value="Specialist Obstetrics &amp; Gynecology - requires referral" />
    </concept>
    <concept>
        <code value="29" />
        <display value="Specialist Paediatric" />
        <definition value="Specialist Paediatric - requires referral" />
    </concept>
    <concept>
        <code value="30" />
        <display value="Specialist Radiology/Imaging" />
        <definition value="Specialist Radiology/Imaging - requires referral" />
    </concept>
    <concept>
        <code value="31" />
        <display value="Specialist Surgical" />
        <definition value="Specialist Surgical - requires referral" />
    </concept>
    <concept>
        <code value="32" />
        <display value="Support Group/s" />
        <definition value="Support group/s" />
    </concept>
    <concept>
        <code value="37" />
        <display value="Test Message (HSD admin)" />
        <definition value="Test Message (HSD admin use only)" />
    </concept>
    <concept>
        <code value="33" />
        <display value="Transport" />
        <definition value="Transport" />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "service-category",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00",
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "draft"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/service-category",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1144"
        }
    ],
    "version": "4.0.1",
    "name": "ServiceCategory",
    "title": "Service category",
    "status": "draft",
    "experimental": false,
    "publisher": "FHIR Project team",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        }
    ],
    "description": "This value set defines an example set of codes that can be used to classify groupings of service-types/specialties.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/service-category",
    "content": "example",
    "concept":  [
        {
            "code": "1",
            "display": "Adoption",
            "definition": "Adoption"
        },
        {
            "code": "2",
            "display": "Aged Care",
            "definition": "Aged Care"
        },
        {
            "code": "34",
            "display": "Allied Health",
            "definition": "Allied Health"
        },
        {
            "code": "3",
            "display": "Alternative/Complementary Therapies",
            "definition": "Alternative & Complementary Therapies"
        },
        {
            "code": "4",
            "display": "Child Care /Kindergarten",
            "definition": "Child Care and/or Kindergarten"
        },
        {
            "code": "5",
            "display": "Child Development",
            "definition": "Child Development"
        },
        {
            "code": "6",
            "display": "Child Protection & Family Services",
            "definition": "Child Protection & Family Services"
        },
        {
            "code": "7",
            "display": "Community Health Care",
            "definition": "Community Health Care"
        },
        {
            "code": "8",
            "display": "Counselling",
            "definition": "Counselling"
        },
        {
            "code": "36",
            "display": "Crisis Line (GPAH use only)",
            "definition": "Crisis Line (GPAH use only)"
        },
        {
            "code": "9",
            "display": "Death Services",
            "definition": "Death Services"
        },
        {
            "code": "10",
            "display": "Dental",
            "definition": "Dental"
        },
        {
            "code": "11",
            "display": "Disability Support",
            "definition": "Disability Support"
        },
        {
            "code": "12",
            "display": "Drug/Alcohol",
            "definition": "Drug/Alcohol"
        },
        {
            "code": "13",
            "display": "Education & Learning",
            "definition": "Education & Learning"
        },
        {
            "code": "14",
            "display": "Emergency Department",
            "definition": "Emergency Department"
        },
        {
            "code": "15",
            "display": "Employment",
            "definition": "Employment"
        },
        {
            "code": "16",
            "display": "Financial & Material Aid",
            "definition": "Financial & Material aid"
        },
        {
            "code": "17",
            "display": "General Practice",
            "definition": "General Practice/GP (doctor)"
        },
        {
            "code": "35",
            "display": "Hospital",
            "definition": "Hospital"
        },
        {
            "code": "18",
            "display": "Housing/Homelessness",
            "definition": "Housing/Homelessness"
        },
        {
            "code": "19",
            "display": "Interpreting",
            "definition": "Interpreting"
        },
        {
            "code": "20",
            "display": "Justice",
            "definition": "Justice"
        },
        {
            "code": "21",
            "display": "Legal",
            "definition": "Legal"
        },
        {
            "code": "22",
            "display": "Mental Health",
            "definition": "Mental Health"
        },
        {
            "code": "38",
            "display": "NDIA",
            "definition": "NDIA"
        },
        {
            "code": "23",
            "display": "Physical Activity & Recreation",
            "definition": "Physical Activity & Recreation"
        },
        {
            "code": "24",
            "display": "Regulation",
            "definition": "Regulation"
        },
        {
            "code": "25",
            "display": "Respite/Carer Support",
            "definition": "Respite/Carer Support"
        },
        {
            "code": "26",
            "display": "Specialist Clinical Pathology",
            "definition": "Specialist Clinical Pathology - requires referral"
        },
        {
            "code": "27",
            "display": "Specialist Medical",
            "definition": "Specialist Medical - requires referral"
        },
        {
            "code": "28",
            "display": "Specialist Obstetrics & Gynecology",
            "definition": "Specialist Obstetrics & Gynecology - requires referral"
        },
        {
            "code": "29",
            "display": "Specialist Paediatric",
            "definition": "Specialist Paediatric - requires referral"
        },
        {
            "code": "30",
            "display": "Specialist Radiology/Imaging",
            "definition": "Specialist Radiology/Imaging - requires referral"
        },
        {
            "code": "31",
            "display": "Specialist Surgical",
            "definition": "Specialist Surgical - requires referral"
        },
        {
            "code": "32",
            "display": "Support Group/s",
            "definition": "Support group/s"
        },
        {
            "code": "37",
            "display": "Test Message (HSD admin)",
            "definition": "Test Message (HSD admin use only)"
        },
        {
            "code": "33",
            "display": "Transport",
            "definition": "Transport"
        }
    ]
}

`serviceType`

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

This element currently uses the FHIR example Service Type ValueSet as no UK Core ValueSet has been defined. The ValueSet is not listed below due to its size.

`specialty`

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

This element currently uses the FHIR preferred Practice Setting Code Value Set consisting of 117 selected SNOMED concepts, as no UK Core ValueSet has been defined. The ValueSet is not listed below due to its size.

`actor`

Slots that reference this schedule resource provide the availability details to these referenced resource(s).

The resource being referenced should conform to one of the following:

`planningHorizon`

The period of time that the slots that reference this Schedule resource cover.

`comment`

Comments on the availability to describe any extended information.