Schedule (MY Core)
Defining URL | http://fhir.hie.moh.gov.my/StructureDefinition/Schedule-my-core |
Version | 1.0.0 |
Name | ScheduleMyCore |
Definition | A container for slots of time that may be available for booking appointments. |
Title | Schedule (MY Core) |
Status | Active as of 11-3-2022 |
Publisher | Malaysia MOH - HIE Steering Committee |
Copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
Schedule | |
Definition | A container for slots of time that may be available for booking appointments. |
Cardinality | 0...* |
Alias | Availability |
Invariants |
|
Mappings |
|
Schedule.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Schedule.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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Schedule.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Schedule.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Schedule.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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Schedule.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Schedule.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 manageable, 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. |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.extension:scheduleType | |
Definition | Extension about the type of schedule |
Cardinality | 1...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | Schedule type |
Invariants |
|
Mappings |
|
Schedule.extension:addressState | |
Definition | Extension to store address state in a Codeable Concept |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Schedule.extension:addressDistrict | |
Definition | Extension to store district address in the form of a Codeable Concept |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Schedule.extension:schedulePosition | |
Definition | Extension about the Global Positioning System (GPS) position in a Schedule |
Cardinality | 0...1 |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | The absolute geographic location |
Invariants |
|
Mappings |
|
Schedule.extension:audit | |
Definition | Extension of the individual who recorded and updated the date |
Cardinality | 0...1 |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | Record audit on individual who recorded and updated the data |
Invariants |
|
Mappings |
|
Schedule.extension:serviceProvider | |
Definition | Extension to reference the custodian of this Resource |
Cardinality | 0...1 |
Type | Extension(Reference(Organization)) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Schedule.extension:requireApproval | |
Definition | Whether an appointment booked under this schedule requires approval from the provider side prior booking |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Schedule.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.identifier | |
Definition | External Ids for this item. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
Schedule.active | |
Definition | Whether this schedule record is in active use or should not be used (such as was entered in error). |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory | |
Definition | A broad categorization of the service that is to be performed during this appointment. |
Cardinality | 1...* |
Type | CodeableConcept |
Binding | ValueSetEncounterClassMyCore (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Slicing | Unordered, Open, by coding.system(Value) |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass | |
Definition | A broad categorization of the service that is to be performed during this appointment. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | ValueSetEncounterClassMyCore (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Schedule.serviceCategory:encounterClass.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core |
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:encounterClass.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory | |
Definition | A broad categorization of the service that is to be performed during this appointment. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | ValueSetServiceRequestCategoryMyCore (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core |
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Schedule.serviceCategory:serviceRequestCategory.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Schedule.serviceType | |
Definition | The specific service that is to be performed during this appointment. |
Cardinality | 1...* |
Type | CodeableConcept |
Binding | ValueSetServiceTypeMyCore (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Schedule.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. |
Cardinality | 1...* |
Type | CodeableConcept |
Binding | Additional details about where the content was created (e.g. clinical specialty). |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Schedule.actor | |
Definition | Slots that reference this schedule resource provide the availability details to these referenced resource(s). |
Cardinality | 1...* |
Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
Summary | True |
Comments | The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system. |
Invariants |
|
Mappings |
|
Schedule.actor.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Schedule.actor.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Schedule.actor.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Schedule.actor.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 1...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Schedule.actor.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Schedule.actor.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Schedule.planningHorizon | |
Definition | The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Schedule.comment | |
Definition | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Schedule-my-core" /> <url value="http://fhir.hie.moh.gov.my/StructureDefinition/Schedule-my-core" /> <version value="1.0.0" /> <name value="ScheduleMyCore" /> <title value="Schedule (MY Core)" /> <status value="active" /> <date value="2024-03-13T01:41:41.3395961+00:00" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Schedule" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Schedule" /> <derivation value="constraint" /> <differential> <element id="Schedule.extension"> <path value="Schedule.extension" /> <min value="1" /> </element> <element id="Schedule.extension:scheduleType"> <path value="Schedule.extension" /> <sliceName value="scheduleType" /> <short value="Extension about the type of schedule" /> <definition value="Extension about the type of schedule" /> <min value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.extension:addressState"> <path value="Schedule.extension" /> <sliceName value="addressState" /> <short value="Extension to store address state in a Codeable Concept" /> <definition value="Extension to store address state in a Codeable Concept" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.extension:addressDistrict"> <path value="Schedule.extension" /> <sliceName value="addressDistrict" /> <short value="Extension to store district address in the form of a Codeable Concept" /> <definition value="Extension to store district address in the form of a Codeable Concept" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.extension:schedulePosition"> <path value="Schedule.extension" /> <sliceName value="schedulePosition" /> <short value="Extension about the Global Positioning System (GPS) position in a Schedule" /> <definition value="Extension about the Global Positioning System (GPS) position in a Schedule" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.extension:audit"> <path value="Schedule.extension" /> <sliceName value="audit" /> <short value="Extension of the individual who recorded and updated the date" /> <definition value="Extension of the individual who recorded and updated the date" /> <comment value="Record audit on individual who recorded and updated the data" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.extension:serviceProvider"> <path value="Schedule.extension" /> <sliceName value="serviceProvider" /> <short value="Extension to reference the custodian of this Resource" /> <definition value="Extension to reference the custodian of this Resource" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.extension:requireApproval"> <path value="Schedule.extension" /> <sliceName value="requireApproval" /> <short value="Whether an appointment booked under this schedule requires approval from the provider side prior booking" /> <definition value="Whether an appointment booked under this schedule requires approval from the provider side prior booking" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core" /> </type> <isModifier value="false" /> </element> <element id="Schedule.serviceCategory"> <path value="Schedule.serviceCategory" /> <slicing> <discriminator> <type value="value" /> <path value="coding.system" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <binding> <strength value="example" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" /> </binding> </element> <element id="Schedule.serviceCategory:encounterClass"> <path value="Schedule.serviceCategory" /> <sliceName value="encounterClass" /> <binding> <strength value="example" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" /> </binding> </element> <element id="Schedule.serviceCategory:encounterClass.coding.system"> <path value="Schedule.serviceCategory.coding.system" /> <fixedUri value="http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" /> </element> <element id="Schedule.serviceCategory:serviceRequestCategory"> <path value="Schedule.serviceCategory" /> <sliceName value="serviceRequestCategory" /> <binding> <strength value="example" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core" /> </binding> </element> <element id="Schedule.serviceCategory:serviceRequestCategory.coding.system"> <path value="Schedule.serviceCategory.coding.system" /> <fixedUri value="http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core" /> </element> <element id="Schedule.serviceType"> <path value="Schedule.serviceType" /> <min value="1" /> <binding> <strength value="example" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/service-type-my-core" /> </binding> </element> <element id="Schedule.specialty"> <path value="Schedule.specialty" /> <min value="1" /> <binding> <strength value="preferred" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/specialty-my-core" /> </binding> </element> <element id="Schedule.actor.type"> <path value="Schedule.actor.type" /> <min value="1" /> </element> <element id="Schedule.actor.display"> <path value="Schedule.actor.display" /> <min value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "Schedule-my-core", "url": "http://fhir.hie.moh.gov.my/StructureDefinition/Schedule-my-core", "version": "1.0.0", "name": "ScheduleMyCore", "title": "Schedule (MY Core)", "status": "active", "date": "2024-03-13T01:41:41.3395961+00:00", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Schedule", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Schedule", "derivation": "constraint", "differential": { "element": [ { "id": "Schedule.extension", "path": "Schedule.extension", "min": 1 }, { "id": "Schedule.extension:scheduleType", "path": "Schedule.extension", "sliceName": "scheduleType", "short": "Extension about the type of schedule", "definition": "Extension about the type of schedule", "min": 1, "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core" ] } ], "isModifier": false }, { "id": "Schedule.extension:addressState", "path": "Schedule.extension", "sliceName": "addressState", "short": "Extension to store address state in a Codeable Concept", "definition": "Extension to store address state in a Codeable Concept", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core" ] } ], "isModifier": false }, { "id": "Schedule.extension:addressDistrict", "path": "Schedule.extension", "sliceName": "addressDistrict", "short": "Extension to store district address in the form of a Codeable Concept", "definition": "Extension to store district address in the form of a Codeable Concept", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core" ] } ], "isModifier": false }, { "id": "Schedule.extension:schedulePosition", "path": "Schedule.extension", "sliceName": "schedulePosition", "short": "Extension about the Global Positioning System (GPS) position in a Schedule", "definition": "Extension about the Global Positioning System (GPS) position in a Schedule", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/schedule-position-my-core" ] } ], "isModifier": false }, { "id": "Schedule.extension:audit", "path": "Schedule.extension", "sliceName": "audit", "short": "Extension of the individual who recorded and updated the date", "definition": "Extension of the individual who recorded and updated the date", "comment": "Record audit on individual who recorded and updated the data", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/audit-my-core" ] } ], "isModifier": false }, { "id": "Schedule.extension:serviceProvider", "path": "Schedule.extension", "sliceName": "serviceProvider", "short": "Extension to reference the custodian of this Resource", "definition": "Extension to reference the custodian of this Resource", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/service-provider-my-core" ] } ], "isModifier": false }, { "id": "Schedule.extension:requireApproval", "path": "Schedule.extension", "sliceName": "requireApproval", "short": "Whether an appointment booked under this schedule requires approval from the provider side prior booking", "definition": "Whether an appointment booked under this schedule requires approval from the provider side prior booking", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/require-approval-my-core" ] } ], "isModifier": false }, { "id": "Schedule.serviceCategory", "path": "Schedule.serviceCategory", "slicing": { "discriminator": [ { "type": "value", "path": "coding.system" } ], "rules": "open" }, "min": 1, "binding": { "strength": "example", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" } }, { "id": "Schedule.serviceCategory:encounterClass", "path": "Schedule.serviceCategory", "sliceName": "encounterClass", "binding": { "strength": "example", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" } }, { "id": "Schedule.serviceCategory:encounterClass.coding.system", "path": "Schedule.serviceCategory.coding.system", "fixedUri": "http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" }, { "id": "Schedule.serviceCategory:serviceRequestCategory", "path": "Schedule.serviceCategory", "sliceName": "serviceRequestCategory", "binding": { "strength": "example", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core" } }, { "id": "Schedule.serviceCategory:serviceRequestCategory.coding.system", "path": "Schedule.serviceCategory.coding.system", "fixedUri": "http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core" }, { "id": "Schedule.serviceType", "path": "Schedule.serviceType", "min": 1, "binding": { "strength": "example", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/service-type-my-core" } }, { "id": "Schedule.specialty", "path": "Schedule.specialty", "min": 1, "binding": { "strength": "preferred", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/specialty-my-core" } }, { "id": "Schedule.actor.type", "path": "Schedule.actor.type", "min": 1 }, { "id": "Schedule.actor.display", "path": "Schedule.actor.display", "min": 1 } ] } }
Snapshot
Schedule | I | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 1..* | Extension |
scheduleType | I | 1..1 | Extension(CodeableConcept) |
addressState | I | 0..1 | Extension(CodeableConcept) |
addressDistrict | I | 0..1 | Extension(CodeableConcept) |
schedulePosition | I | 0..1 | Extension(Complex) |
audit | I | 0..1 | Extension(Complex) |
serviceProvider | I | 0..1 | Extension(Reference(Organization)) |
requireApproval | I | 0..1 | Extension(boolean) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
serviceCategory | Σ | 1..* | CodeableConcept |
encounterClass | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
serviceRequestCategory | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
serviceType | Σ | 1..* | CodeableConcept |
specialty | Σ | 1..* | CodeableConceptBinding |
actor | Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 1..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 1..1 | string |
planningHorizon | Σ I | 0..1 | Period |
comment | 0..1 | string |
Diff
Schedule | I | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 1..* | Extension |
scheduleType | I | 1..1 | Extension(CodeableConcept) |
addressState | I | 0..1 | Extension(CodeableConcept) |
addressDistrict | I | 0..1 | Extension(CodeableConcept) |
schedulePosition | I | 0..1 | Extension(Complex) |
audit | I | 0..1 | Extension(Complex) |
serviceProvider | I | 0..1 | Extension(Reference(Organization)) |
requireApproval | I | 0..1 | Extension(boolean) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
serviceCategory | Σ | 1..* | CodeableConcept |
encounterClass | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
serviceRequestCategory | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
serviceType | Σ | 1..* | CodeableConcept |
specialty | Σ | 1..* | CodeableConceptBinding |
actor | Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 1..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 1..1 | string |
planningHorizon | Σ I | 0..1 | Period |
comment | 0..1 | string |
Hybrid
Schedule | I | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 1..* | Extension |
scheduleType | I | 1..1 | Extension(CodeableConcept) |
addressState | I | 0..1 | Extension(CodeableConcept) |
addressDistrict | I | 0..1 | Extension(CodeableConcept) |
schedulePosition | I | 0..1 | Extension(Complex) |
audit | I | 0..1 | Extension(Complex) |
serviceProvider | I | 0..1 | Extension(Reference(Organization)) |
requireApproval | I | 0..1 | Extension(boolean) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
serviceCategory | Σ | 1..* | CodeableConcept |
encounterClass | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
serviceRequestCategory | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
serviceType | Σ | 1..* | CodeableConcept |
specialty | Σ | 1..* | CodeableConceptBinding |
actor | Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 1..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 1..1 | string |
planningHorizon | Σ I | 0..1 | Period |
comment | 0..1 | string |
This profile is derived from the base FHIR Schedule resource.
Requirements
This structure defines these element as mandatory requirement:
- A service category
serviceCategory
- A service type
serviceType
- A specialty/service
specialty
- A facility the schedule is created for
actor
- A schedule type
extension
whereextension.url=http://fhir.hie.moh.gov.my/StructureDefinition/schedule-type-my-core
Extension
- ExtensionScheduleType (MY Core)
- ExtensionAddressState (MY Core)
- ExtensionAddressDistrict (MY Core)
- ExtensionSchedulePosition (MY Core)
- ExtensionAudit (MY Core)
Scheduling Integration
Please refer Scheduling & Appointment for scheduling integration guide