HL7 FHIR Malaysia Core (MY Core) Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: Schedule (MY Core)
| Official URL: http://fhir.hie.moh.gov.my/StructureDefinition/Schedule-my-core | Version: 2.0.0 | |||
| Active as of 2024-02-12 | Computable Name: ScheduleMyCore | |||
A container for slots of time that may be available for booking appointments. For the Malaysian context, please refer to Scheduling & Appointment for the scheduling integration guide.
Usage:
- Refer to this Resource Profile: Slot (MY Core)
- Examples for this Resource Profile: Schedule/example-schedule, Schedule/example-vce-sch-example and Schedule/example-vci-sch-example
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Schedule |
0..* | Schedule | A container for slots of time that may be available for booking appointments dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   scheduleType |
1..* | CodeableConcept | Extension about the type of schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core Binding: ValueSetScheduleType (MY Core) (required): Schedule type for booking ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| addressState |
0..1 | CodeableConcept | Extension to store address state in a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core Binding: ValueSetState (MY Core) (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| addressDistrict |
0..1 | CodeableConcept | Extension to store district address in the form of a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core Binding: ValueSetDistrict (MY Core) (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| schedulePosition |
0..1 | (Complex) | Extension about the Global Positioning System (GPS) position in a Schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| audit |
0..1 | (Complex) | Extension of the individual who recorded and updated the date URL: http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| serviceProvider |
0..1 | Reference(Organization) | Extension to reference the custodian of this Resource URL: http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 requireApproval |
0..1 | boolean | Whether an appointment booked under this schedule requires approval from the provider side prior booking URL: http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use ele-1: All FHIR elements must have a @value or children |
 Slices for serviceCategory |
Σ | 1..* | CodeableConcept | High-level category Slice: Unordered, Open by value:coding.system Binding: ValueSetEncounterClass (MY Core) (example) ele-1: All FHIR elements must have a @value or children |
| serviceCategory:encounterClass |
Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) ele-1: All FHIR elements must have a @value or children |
| serviceCategory:serviceRequestCategory |
Σ | 0..* | CodeableConcept | High-level category Binding: ValueSetServiceRequestCategory( MY Core) (example) ele-1: All FHIR elements must have a @value or children |
 serviceType |
Σ | 1..* | CodeableConcept | Specific service Binding: ValueSetServiceType (MY Core) (example) ele-1: All FHIR elements must have a @value or children |
| specialty |
Σ | 1..* | CodeableConcept | Type of specialty needed Binding: ValueSetSpecialty (MYCore) (preferred) ele-1: All FHIR elements must have a @value or children |
  actor |
Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for ele-1: All FHIR elements must have a @value or children |
 type |
Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children |
 display |
Σ | 1..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Schedule.serviceCategory | example | ValueSetEncounterClassMyCore (a valid code from CodeSystemEncounterClass (MY Core))http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-corefrom this IG | |
| Schedule.serviceCategory:encounterClass | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| Schedule.serviceCategory:serviceRequestCategory | example | ValueSetServiceRequestCategoryMyCore (a valid code from CodeSystemServiceRequestCategory (MY Core))http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-corefrom this IG | |
| Schedule.serviceType | example | ValueSetServiceTypeMyCore (a valid code from CodeSystemServiceType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/service-type-my-corefrom this IG | |
| Schedule.specialty | preferred | ValueSetSpecialtyMyCorehttp://fhir.hie.moh.gov.my/ValueSet/specialty-my-corefrom this IG | |
| Schedule.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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 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-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() | |
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Schedule | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Schedule
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule |
0..* | Schedule | A container for slots of time that may be available for booking appointments | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| scheduleType |
1..* | CodeableConcept | Extension about the type of schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core Binding: ValueSetScheduleType (MY Core) (required): Schedule type for booking | |
| addressState |
0..1 | CodeableConcept | Extension to store address state in a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core Binding: ValueSetState (MY Core) (required) | |
| addressDistrict |
0..1 | CodeableConcept | Extension to store district address in the form of a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core Binding: ValueSetDistrict (MY Core) (required) | |
| schedulePosition |
0..1 | (Complex) | Extension about the Global Positioning System (GPS) position in a Schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core | |
| audit |
0..1 | (Complex) | Extension of the individual who recorded and updated the date URL: http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core | |
| serviceProvider |
0..1 | Reference(Organization) | Extension to reference the custodian of this Resource URL: http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core | |
| requireApproval |
0..1 | boolean | Whether an appointment booked under this schedule requires approval from the provider side prior booking URL: http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core | |
| Slices for serviceCategory |
1..* | CodeableConcept | High-level category Slice: Unordered, Open by value:coding.system Binding: ValueSetEncounterClass (MY Core) (example) | |
 serviceCategory:encounterClass |
0..* | CodeableConcept | High-level category | |
   coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core | |
 serviceCategory:serviceRequestCategory |
0..* | CodeableConcept | High-level category Binding: ValueSetServiceRequestCategory( MY Core) (example) | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core | |
| serviceType |
1..* | CodeableConcept | Specific service Binding: ValueSetServiceType (MY Core) (example) | |
| specialty |
1..* | CodeableConcept | Type of specialty needed Binding: ValueSetSpecialty (MYCore) (preferred) | |
| actor |
||||
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") | |
| display |
1..1 | string | Text alternative for the resource | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Schedule.serviceCategory | example | ValueSetEncounterClassMyCore (a valid code from CodeSystemEncounterClass (MY Core))http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-corefrom this IG | |
| Schedule.serviceCategory:serviceRequestCategory | example | ValueSetServiceRequestCategoryMyCore (a valid code from CodeSystemServiceRequestCategory (MY Core))http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-corefrom this IG | |
| Schedule.serviceType | example | ValueSetServiceTypeMyCore (a valid code from CodeSystemServiceType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/service-type-my-corefrom this IG | |
| Schedule.specialty | preferred | ValueSetSpecialtyMyCorehttp://fhir.hie.moh.gov.my/ValueSet/specialty-my-corefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| scheduleType |
1..* | CodeableConcept | Extension about the type of schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core Binding: ValueSetScheduleType (MY Core) (required): Schedule type for booking | |||||
| addressState |
0..1 | CodeableConcept | Extension to store address state in a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core Binding: ValueSetState (MY Core) (required) | |||||
| addressDistrict |
0..1 | CodeableConcept | Extension to store district address in the form of a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core Binding: ValueSetDistrict (MY Core) (required) | |||||
| schedulePosition |
0..1 | (Complex) | Extension about the Global Positioning System (GPS) position in a Schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core | |||||
| audit |
0..1 | (Complex) | Extension of the individual who recorded and updated the date URL: http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core | |||||
| serviceProvider |
0..1 | Reference(Organization) | Extension to reference the custodian of this Resource URL: http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core | |||||
| requireApproval |
0..1 | boolean | Whether an appointment booked under this schedule requires approval from the provider side prior booking URL: http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||
| Slices for serviceCategory |
Σ | 1..* | CodeableConcept | High-level category Slice: Unordered, Open by value:coding.system Binding: ValueSetEncounterClass (MY Core) (example) | ||||
| serviceCategory:encounterClass |
Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
 text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| serviceCategory:serviceRequestCategory |
Σ | 0..* | CodeableConcept | High-level category Binding: ValueSetServiceRequestCategory( MY Core) (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| serviceType |
Σ | 1..* | CodeableConcept | Specific service Binding: ValueSetServiceType (MY Core) (example) | ||||
| specialty |
Σ | 1..* | CodeableConcept | Type of specialty needed Binding: ValueSetSpecialty (MYCore) (preferred) | ||||
| actor |
Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 1..1 | string | Text alternative for the resource | ||||
| planningHorizon |
Σ | 0..1 | Period | Period of time covered by schedule | ||||
| comment |
0..1 | string | Comments on availability | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Schedule.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Schedule.serviceCategory | example | ValueSetEncounterClassMyCore (a valid code from CodeSystemEncounterClass (MY Core))http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-corefrom this IG | ||||
| Schedule.serviceCategory:encounterClass | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Schedule.serviceCategory:serviceRequestCategory | example | ValueSetServiceRequestCategoryMyCore (a valid code from CodeSystemServiceRequestCategory (MY Core))http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-corefrom this IG | ||||
| Schedule.serviceType | example | ValueSetServiceTypeMyCore (a valid code from CodeSystemServiceType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/service-type-my-corefrom this IG | ||||
| Schedule.specialty | preferred | ValueSetSpecialtyMyCorehttp://fhir.hie.moh.gov.my/ValueSet/specialty-my-corefrom this IG | ||||
| Schedule.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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 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-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() | |
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Schedule | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Schedule
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Fixed: 2 elements
Extensions
This structure refers to these extensions:
- http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Schedule.serviceCategory
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule |
0..* | Schedule | A container for slots of time that may be available for booking appointments dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| scheduleType |
1..* | CodeableConcept | Extension about the type of schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core Binding: ValueSetScheduleType (MY Core) (required): Schedule type for booking ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| addressState |
0..1 | CodeableConcept | Extension to store address state in a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core Binding: ValueSetState (MY Core) (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| addressDistrict |
0..1 | CodeableConcept | Extension to store district address in the form of a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core Binding: ValueSetDistrict (MY Core) (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| schedulePosition |
0..1 | (Complex) | Extension about the Global Positioning System (GPS) position in a Schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| audit |
0..1 | (Complex) | Extension of the individual who recorded and updated the date URL: http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| serviceProvider |
0..1 | Reference(Organization) | Extension to reference the custodian of this Resource URL: http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| requireApproval |
0..1 | boolean | Whether an appointment booked under this schedule requires approval from the provider side prior booking URL: http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use ele-1: All FHIR elements must have a @value or children |
| Slices for serviceCategory |
Σ | 1..* | CodeableConcept | High-level category Slice: Unordered, Open by value:coding.system Binding: ValueSetEncounterClass (MY Core) (example) ele-1: All FHIR elements must have a @value or children |
| serviceCategory:encounterClass |
Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) ele-1: All FHIR elements must have a @value or children |
| serviceCategory:serviceRequestCategory |
Σ | 0..* | CodeableConcept | High-level category Binding: ValueSetServiceRequestCategory( MY Core) (example) ele-1: All FHIR elements must have a @value or children |
| serviceType |
Σ | 1..* | CodeableConcept | Specific service Binding: ValueSetServiceType (MY Core) (example) ele-1: All FHIR elements must have a @value or children |
| specialty |
Σ | 1..* | CodeableConcept | Type of specialty needed Binding: ValueSetSpecialty (MYCore) (preferred) ele-1: All FHIR elements must have a @value or children |
| actor |
Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Schedule.serviceCategory | example | ValueSetEncounterClassMyCore (a valid code from CodeSystemEncounterClass (MY Core))http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-corefrom this IG | |
| Schedule.serviceCategory:encounterClass | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| Schedule.serviceCategory:serviceRequestCategory | example | ValueSetServiceRequestCategoryMyCore (a valid code from CodeSystemServiceRequestCategory (MY Core))http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-corefrom this IG | |
| Schedule.serviceType | example | ValueSetServiceTypeMyCore (a valid code from CodeSystemServiceType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/service-type-my-corefrom this IG | |
| Schedule.specialty | preferred | ValueSetSpecialtyMyCorehttp://fhir.hie.moh.gov.my/ValueSet/specialty-my-corefrom this IG | |
| Schedule.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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 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-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() | |
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Schedule | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Schedule
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule |
0..* | Schedule | A container for slots of time that may be available for booking appointments | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| scheduleType |
1..* | CodeableConcept | Extension about the type of schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core Binding: ValueSetScheduleType (MY Core) (required): Schedule type for booking | |
| addressState |
0..1 | CodeableConcept | Extension to store address state in a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core Binding: ValueSetState (MY Core) (required) | |
| addressDistrict |
0..1 | CodeableConcept | Extension to store district address in the form of a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core Binding: ValueSetDistrict (MY Core) (required) | |
| schedulePosition |
0..1 | (Complex) | Extension about the Global Positioning System (GPS) position in a Schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core | |
| audit |
0..1 | (Complex) | Extension of the individual who recorded and updated the date URL: http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core | |
| serviceProvider |
0..1 | Reference(Organization) | Extension to reference the custodian of this Resource URL: http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core | |
| requireApproval |
0..1 | boolean | Whether an appointment booked under this schedule requires approval from the provider side prior booking URL: http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core | |
| Slices for serviceCategory |
1..* | CodeableConcept | High-level category Slice: Unordered, Open by value:coding.system Binding: ValueSetEncounterClass (MY Core) (example) | |
| serviceCategory:encounterClass |
0..* | CodeableConcept | High-level category | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core | |
| serviceCategory:serviceRequestCategory |
0..* | CodeableConcept | High-level category Binding: ValueSetServiceRequestCategory( MY Core) (example) | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core | |
| serviceType |
1..* | CodeableConcept | Specific service Binding: ValueSetServiceType (MY Core) (example) | |
| specialty |
1..* | CodeableConcept | Type of specialty needed Binding: ValueSetSpecialty (MYCore) (preferred) | |
| actor |
||||
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") | |
| display |
1..1 | string | Text alternative for the resource | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Schedule.serviceCategory | example | ValueSetEncounterClassMyCore (a valid code from CodeSystemEncounterClass (MY Core))http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-corefrom this IG | |
| Schedule.serviceCategory:serviceRequestCategory | example | ValueSetServiceRequestCategoryMyCore (a valid code from CodeSystemServiceRequestCategory (MY Core))http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-corefrom this IG | |
| Schedule.serviceType | example | ValueSetServiceTypeMyCore (a valid code from CodeSystemServiceType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/service-type-my-corefrom this IG | |
| Schedule.specialty | preferred | ValueSetSpecialtyMyCorehttp://fhir.hie.moh.gov.my/ValueSet/specialty-my-corefrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| scheduleType |
1..* | CodeableConcept | Extension about the type of schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core Binding: ValueSetScheduleType (MY Core) (required): Schedule type for booking | |||||
| addressState |
0..1 | CodeableConcept | Extension to store address state in a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core Binding: ValueSetState (MY Core) (required) | |||||
| addressDistrict |
0..1 | CodeableConcept | Extension to store district address in the form of a Codeable Concept URL: http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core Binding: ValueSetDistrict (MY Core) (required) | |||||
| schedulePosition |
0..1 | (Complex) | Extension about the Global Positioning System (GPS) position in a Schedule URL: http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core | |||||
| audit |
0..1 | (Complex) | Extension of the individual who recorded and updated the date URL: http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core | |||||
| serviceProvider |
0..1 | Reference(Organization) | Extension to reference the custodian of this Resource URL: http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core | |||||
| requireApproval |
0..1 | boolean | Whether an appointment booked under this schedule requires approval from the provider side prior booking URL: http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||
| Slices for serviceCategory |
Σ | 1..* | CodeableConcept | High-level category Slice: Unordered, Open by value:coding.system Binding: ValueSetEncounterClass (MY Core) (example) | ||||
| serviceCategory:encounterClass |
Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| serviceCategory:serviceRequestCategory |
Σ | 0..* | CodeableConcept | High-level category Binding: ValueSetServiceRequestCategory( MY Core) (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| serviceType |
Σ | 1..* | CodeableConcept | Specific service Binding: ValueSetServiceType (MY Core) (example) | ||||
| specialty |
Σ | 1..* | CodeableConcept | Type of specialty needed Binding: ValueSetSpecialty (MYCore) (preferred) | ||||
| actor |
Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 1..1 | string | Text alternative for the resource | ||||
| planningHorizon |
Σ | 0..1 | Period | Period of time covered by schedule | ||||
| comment |
0..1 | string | Comments on availability | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Schedule.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Schedule.serviceCategory | example | ValueSetEncounterClassMyCore (a valid code from CodeSystemEncounterClass (MY Core))http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-corefrom this IG | ||||
| Schedule.serviceCategory:encounterClass | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Schedule.serviceCategory:serviceRequestCategory | example | ValueSetServiceRequestCategoryMyCore (a valid code from CodeSystemServiceRequestCategory (MY Core))http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-corefrom this IG | ||||
| Schedule.serviceType | example | ValueSetServiceTypeMyCore (a valid code from CodeSystemServiceType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/service-type-my-corefrom this IG | ||||
| Schedule.specialty | preferred | ValueSetSpecialtyMyCorehttp://fhir.hie.moh.gov.my/ValueSet/specialty-my-corefrom this IG | ||||
| Schedule.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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 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-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() | |
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Schedule | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Schedule
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Fixed: 2 elements
Extensions
This structure refers to these extensions:
- http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core
- http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Schedule.serviceCategory
Other representations of profile: CSV, Excel, Schematron
Notes:
Mandatory Data Elements
This structure defines these elements as mandatory data fields:
| Element | Description |
|---|---|
Schedule.serviceCategory
|
General category of service planned by the Schedule, e.g. outpatient, virtual. |
Schedule.serviceType
|
Type of service planned by the Schedule, e.g. kiosk virtual consultation, specialist outpatient. |
Schedule.specialty
|
The specialty of a Practitioner that would be required to perform the service planned in this Schedule. |
Schedule.actor
|
Provides the availability details to these referenced resources. Can be Location, PractitionerRole, HealthcareService, etc. |
Schedule.extension:scheduleType
|
Type of Schedule made, e.g. internal, affiliated Organization, public. |
Slices
This structure slices the following elements:
| Element | Discriminator Path (Type) | Value |
|---|---|---|
Schedule.serviceCategory
|
:encounterClass.coding.system(Value)
|
http://fhir.hie.moh.gov.my/CodeSystem/encounter-class-my-core |
:serviceRequestCategory.coding.system(Value)
|
http://fhir.hie.moh.gov.my/CodeSystem/servicerequest-category-my-core |