Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_Schedule_R3

Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-Schedule Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4B_Schedule_R3

This cross-version profile allows R4B Schedule content to be represented via FHIR STU3 Schedule resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean Whether this schedule is in active use
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:actor 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4B: Resource(s) that availability information is being provided for
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-1 error Schedule If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Schedule 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()

This structure is derived from Schedule

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: identifier additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:actor 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4B: Resource(s) that availability information is being provided for
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... planningHorizon
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:planningHorizon 0..1 Period R4B: Period of time covered by schedule additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.planningHorizon

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.meta
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 0..* uri Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.text
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: identifier additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this schedule is in active use
... serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred): Additional details about where the content was created (e.g. clinical specialty)
... actor Σ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:actor 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4B: Resource(s) that availability information is being provided for
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... planningHorizon Σ 0..1 Period The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:planningHorizon 0..1 Period R4B: Period of time covered by schedule additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.planningHorizon
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... comment 0..1 string Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.meta.security Base extensible All Security Labels 📍3.0.2 FHIR Std.
Schedule.meta.tag Base example Common Tags 📍3.0.2 FHIR Std.
Schedule.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Schedule.text.status Base required NarrativeStatus 📍3.0.2 FHIR Std.
Schedule.identifier.​use Base required IdentifierUse 📍3.0.2 FHIR Std.
Schedule.identifier.​type Base extensible Identifier Type Codes 📍3.0.2 FHIR Std.
Schedule.serviceCategory Base example ServiceCategory 📍3.0.2 FHIR Std.
Schedule.serviceType Base example ServiceType 📍3.0.2 FHIR Std.
Schedule.specialty Base preferred Practice Setting Code Value Set 📍20091109 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Schedule If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Schedule 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()
txt-1 error Schedule.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlchecks()
txt-2 error Schedule.text.div The narrative SHALL have some non-whitespace content htmlchecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean Whether this schedule is in active use
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:actor 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4B: Resource(s) that availability information is being provided for
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-1 error Schedule If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Schedule 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()

Differential View

This structure is derived from Schedule

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: identifier additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:actor 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4B: Resource(s) that availability information is being provided for
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... planningHorizon
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:planningHorizon 0..1 Period R4B: Period of time covered by schedule additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.planningHorizon

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.meta
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 0..* uri Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.text
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: identifier additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this schedule is in active use
... serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred): Additional details about where the content was created (e.g. clinical specialty)
... actor Σ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:actor 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4B: Resource(s) that availability information is being provided for
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... planningHorizon Σ 0..1 Period The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:planningHorizon 0..1 Period R4B: Period of time covered by schedule additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Schedule.planningHorizon
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... comment 0..1 string Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.meta.security Base extensible All Security Labels 📍3.0.2 FHIR Std.
Schedule.meta.tag Base example Common Tags 📍3.0.2 FHIR Std.
Schedule.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Schedule.text.status Base required NarrativeStatus 📍3.0.2 FHIR Std.
Schedule.identifier.​use Base required IdentifierUse 📍3.0.2 FHIR Std.
Schedule.identifier.​type Base extensible Identifier Type Codes 📍3.0.2 FHIR Std.
Schedule.serviceCategory Base example ServiceCategory 📍3.0.2 FHIR Std.
Schedule.serviceType Base example ServiceType 📍3.0.2 FHIR Std.
Schedule.specialty Base preferred Practice Setting Code Value Set 📍20091109 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Schedule If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Schedule 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()
txt-1 error Schedule.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlchecks()
txt-2 error Schedule.text.div The narrative SHALL have some non-whitespace content htmlchecks()

 

Other representations of profile: CSV, Excel, Schematron