v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: SCH - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the SCH logical model.

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

0. SCH
Definition

Scheduling Activity Information

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SCH.placerAppointmentID
Definition

Placer Appointment ID

ShortplacerAppointmentID
Control0..1
TypeEI
4. SCH.fillerAppointmentID
Definition

Filler Appointment ID

ShortfillerAppointmentID
Control0..1
TypeEI
6. SCH.occurrenceNumber
Definition

Occurrence Number

ShortoccurrenceNumber
Control0..1
TypeNM
8. SCH.placerOrderGroupNumber
Definition

Placer Order Group Number

ShortplacerOrderGroupNumber
Control0..1
TypeEI
10. SCH.scheduleID
Definition

Schedule ID

ShortscheduleID
Control0..1
TypeCWE
12. SCH.eventReason
Definition

Event Reason

ShorteventReason
Control1..1
TypeCWE
Must Supporttrue
14. SCH.appointmentReason
Definition

Appointment Reason

ShortappointmentReason
Control0..1
TypeCWE
16. SCH.appointmentType
Definition

Appointment Type

ShortappointmentType
Control0..1
TypeCWE
18. SCH.appointmentDuration
Definition

Appointment Duration

ShortappointmentDuration
Control0..1
TypeNM
20. SCH.appointmentDurationUnits
Definition

Appointment Duration Units

ShortappointmentDurationUnits
Control0..1
TypeCNE
22. SCH.appointmentTimingQuantity
Definition

Appointment Timing Quantity

ShortappointmentTimingQuantity
Control0..1
Type-
24. SCH.placerContactPerson
Definition

Placer Contact Person

ShortplacerContactPerson
Control0..*
TypeXCN
26. SCH.placerContactPhoneNumber
Definition

Placer Contact Phone Number

ShortplacerContactPhoneNumber
Control0..1
TypeXTN
28. SCH.placerContactAddress
Definition

Placer Contact Address

ShortplacerContactAddress
Control0..*
TypeXAD
30. SCH.placerContactLocation
Definition

Placer Contact Location

ShortplacerContactLocation
Control0..1
TypePL
32. SCH.fillerContactPerson
Definition

Filler Contact Person

ShortfillerContactPerson
Control1..*
TypeXCN
Must Supporttrue
34. SCH.fillerContactPhoneNumber
Definition

Filler Contact Phone Number

ShortfillerContactPhoneNumber
Control0..1
TypeXTN
36. SCH.fillerContactAddress
Definition

Filler Contact Address

ShortfillerContactAddress
Control0..*
TypeXAD
38. SCH.fillerContactLocation
Definition

Filler Contact Location

ShortfillerContactLocation
Control0..1
TypePL
40. SCH.enteredByPerson
Definition

Entered By Person

ShortenteredByPerson
Control1..*
TypeXCN
Must Supporttrue
42. SCH.enteredByPhoneNumber
Definition

Entered By Phone Number

ShortenteredByPhoneNumber
Control0..*
TypeXTN
44. SCH.enteredByLocation
Definition

Entered By Location

ShortenteredByLocation
Control0..1
TypePL
46. SCH.parentPlacerAppointmentID
Definition

Parent Placer Appointment ID

ShortparentPlacerAppointmentID
Control0..1
TypeEI
48. SCH.parentFillerAppointmentID
Definition

Parent Filler Appointment ID

ShortparentFillerAppointmentID
Control0..1
TypeEI
50. SCH.fillerStatusCode
Definition

Filler Status Code

ShortfillerStatusCode
Control0..1
TypeCWE
52. SCH.placerOrderNumber
Definition

Placer Order Number

ShortplacerOrderNumber
Control0..*
TypeEI
54. SCH.fillerOrderNumber
Definition

Filler Order Number

ShortfillerOrderNumber
Control0..*
TypeEI
56. SCH.alternatePlacerOrderGroupNumber
Definition

Alternate Placer Order Group Number

ShortalternatePlacerOrderGroupNumber
Control0..1
TypeEIP

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

0. SCH
Definition

Scheduling Activity Information


A resource that includes narrative, extensions, and contained resources.

ShortA resource with narrative, extensions, and contained resources
Control10..1*
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. SCH.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. SCH.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

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

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. SCH.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

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

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SCH.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
8. SCH.placerAppointmentID
Definition

Placer Appointment ID

ShortplacerAppointmentID
Control0..1
TypeEI
10. SCH.fillerAppointmentID
Definition

Filler Appointment ID

ShortfillerAppointmentID
Control0..1
TypeEI
12. SCH.occurrenceNumber
Definition

Occurrence Number

ShortoccurrenceNumber
Control0..1
TypeNM
14. SCH.placerOrderGroupNumber
Definition

Placer Order Group Number

ShortplacerOrderGroupNumber
Control0..1
TypeEI
16. SCH.scheduleID
Definition

Schedule ID

ShortscheduleID
Control0..1
TypeCWE
18. SCH.eventReason
Definition

Event Reason

ShorteventReason
Control1..1
TypeCWE
Must Supporttrue
20. SCH.appointmentReason
Definition

Appointment Reason

ShortappointmentReason
Control0..1
TypeCWE
22. SCH.appointmentType
Definition

Appointment Type

ShortappointmentType
Control0..1
TypeCWE
24. SCH.appointmentDuration
Definition

Appointment Duration

ShortappointmentDuration
Control0..1
TypeNM
26. SCH.appointmentDurationUnits
Definition

Appointment Duration Units

ShortappointmentDurationUnits
Control0..1
TypeCNE
28. SCH.appointmentTimingQuantity
Definition

Appointment Timing Quantity

ShortappointmentTimingQuantity
Control0..1
Type-
30. SCH.placerContactPerson
Definition

Placer Contact Person

ShortplacerContactPerson
Control0..*
TypeXCN
32. SCH.placerContactPhoneNumber
Definition

Placer Contact Phone Number

ShortplacerContactPhoneNumber
Control0..1
TypeXTN
34. SCH.placerContactAddress
Definition

Placer Contact Address

ShortplacerContactAddress
Control0..*
TypeXAD
36. SCH.placerContactLocation
Definition

Placer Contact Location

ShortplacerContactLocation
Control0..1
TypePL
38. SCH.fillerContactPerson
Definition

Filler Contact Person

ShortfillerContactPerson
Control1..*
TypeXCN
Must Supporttrue
40. SCH.fillerContactPhoneNumber
Definition

Filler Contact Phone Number

ShortfillerContactPhoneNumber
Control0..1
TypeXTN
42. SCH.fillerContactAddress
Definition

Filler Contact Address

ShortfillerContactAddress
Control0..*
TypeXAD
44. SCH.fillerContactLocation
Definition

Filler Contact Location

ShortfillerContactLocation
Control0..1
TypePL
46. SCH.enteredByPerson
Definition

Entered By Person

ShortenteredByPerson
Control1..*
TypeXCN
Must Supporttrue
48. SCH.enteredByPhoneNumber
Definition

Entered By Phone Number

ShortenteredByPhoneNumber
Control0..*
TypeXTN
50. SCH.enteredByLocation
Definition

Entered By Location

ShortenteredByLocation
Control0..1
TypePL
52. SCH.parentPlacerAppointmentID
Definition

Parent Placer Appointment ID

ShortparentPlacerAppointmentID
Control0..1
TypeEI
54. SCH.parentFillerAppointmentID
Definition

Parent Filler Appointment ID

ShortparentFillerAppointmentID
Control0..1
TypeEI
56. SCH.fillerStatusCode
Definition

Filler Status Code

ShortfillerStatusCode
Control0..1
TypeCWE
58. SCH.placerOrderNumber
Definition

Placer Order Number

ShortplacerOrderNumber
Control0..*
TypeEI
60. SCH.fillerOrderNumber
Definition

Filler Order Number

ShortfillerOrderNumber
Control0..*
TypeEI
62. SCH.alternatePlacerOrderGroupNumber
Definition

Alternate Placer Order Group Number

ShortalternatePlacerOrderGroupNumber
Control0..1
TypeEIP

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

0. SCH
Definition

Scheduling Activity Information

ShortA resource with narrative, extensions, and contained resources
Control1..1
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. SCH.id
Definition

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

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. SCH.meta
Definition

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

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. SCH.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. SCH.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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

Control0..1
BindingThe codes SHALL be taken from AllLanguages: IETF language tag for a human language
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. SCH.text
Definition

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

ShortText summary of the resource, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. SCH.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

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

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. SCH.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SCH.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. SCH.modifierExtension
Definition

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

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

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SCH.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. SCH.placerAppointmentID
Definition

Placer Appointment ID

ShortplacerAppointmentID
Control0..1
TypeEI
20. SCH.fillerAppointmentID
Definition

Filler Appointment ID

ShortfillerAppointmentID
Control0..1
TypeEI
22. SCH.occurrenceNumber
Definition

Occurrence Number

ShortoccurrenceNumber
Control0..1
TypeNM
24. SCH.placerOrderGroupNumber
Definition

Placer Order Group Number

ShortplacerOrderGroupNumber
Control0..1
TypeEI
26. SCH.scheduleID
Definition

Schedule ID

ShortscheduleID
Control0..1
TypeCWE
28. SCH.eventReason
Definition

Event Reason

ShorteventReason
Control1..1
TypeCWE
Must Supporttrue
30. SCH.appointmentReason
Definition

Appointment Reason

ShortappointmentReason
Control0..1
TypeCWE
32. SCH.appointmentType
Definition

Appointment Type

ShortappointmentType
Control0..1
TypeCWE
34. SCH.appointmentDuration
Definition

Appointment Duration

ShortappointmentDuration
Control0..1
TypeNM
36. SCH.appointmentDurationUnits
Definition

Appointment Duration Units

ShortappointmentDurationUnits
Control0..1
TypeCNE
38. SCH.appointmentTimingQuantity
Definition

Appointment Timing Quantity

ShortappointmentTimingQuantity
Control0..1
Type-
40. SCH.placerContactPerson
Definition

Placer Contact Person

ShortplacerContactPerson
Control0..*
TypeXCN
42. SCH.placerContactPhoneNumber
Definition

Placer Contact Phone Number

ShortplacerContactPhoneNumber
Control0..1
TypeXTN
44. SCH.placerContactAddress
Definition

Placer Contact Address

ShortplacerContactAddress
Control0..*
TypeXAD
46. SCH.placerContactLocation
Definition

Placer Contact Location

ShortplacerContactLocation
Control0..1
TypePL
48. SCH.fillerContactPerson
Definition

Filler Contact Person

ShortfillerContactPerson
Control1..*
TypeXCN
Must Supporttrue
50. SCH.fillerContactPhoneNumber
Definition

Filler Contact Phone Number

ShortfillerContactPhoneNumber
Control0..1
TypeXTN
52. SCH.fillerContactAddress
Definition

Filler Contact Address

ShortfillerContactAddress
Control0..*
TypeXAD
54. SCH.fillerContactLocation
Definition

Filler Contact Location

ShortfillerContactLocation
Control0..1
TypePL
56. SCH.enteredByPerson
Definition

Entered By Person

ShortenteredByPerson
Control1..*
TypeXCN
Must Supporttrue
58. SCH.enteredByPhoneNumber
Definition

Entered By Phone Number

ShortenteredByPhoneNumber
Control0..*
TypeXTN
60. SCH.enteredByLocation
Definition

Entered By Location

ShortenteredByLocation
Control0..1
TypePL
62. SCH.parentPlacerAppointmentID
Definition

Parent Placer Appointment ID

ShortparentPlacerAppointmentID
Control0..1
TypeEI
64. SCH.parentFillerAppointmentID
Definition

Parent Filler Appointment ID

ShortparentFillerAppointmentID
Control0..1
TypeEI
66. SCH.fillerStatusCode
Definition

Filler Status Code

ShortfillerStatusCode
Control0..1
TypeCWE
68. SCH.placerOrderNumber
Definition

Placer Order Number

ShortplacerOrderNumber
Control0..*
TypeEI
70. SCH.fillerOrderNumber
Definition

Filler Order Number

ShortfillerOrderNumber
Control0..*
TypeEI
72. SCH.alternatePlacerOrderGroupNumber
Definition

Alternate Placer Order Group Number

ShortalternatePlacerOrderGroupNumber
Control0..1
TypeEIP