Slot (MY Core)

Defining URL http://fhir.hie.moh.gov.my/StructureDefinition/Slot-my-core
Version 1.0.0
Name SlotMyCore
Definition A slot of time on a schedule that may be available for booking appointments.
Title Slot (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

Slot
DefinitionA slot of time on a schedule that may be available for booking appointments.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: n/a
  • ical: (refer to the Availability resource for the header mapping details)
Slot.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
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.

Slot.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Slot.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Slot.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Slot.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Slot.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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
  • rim: Entity. Role, or Act
  • rim: N/A
Slot.extension
DefinitionMay 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.
Cardinality1...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.extension:slotQuota
DefinitionExtension about the maximum quota allocated for a slot
Cardinality1...1
TypeExtension(Complex)
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.identifier
DefinitionExternal Ids for this item.
Cardinality0...*
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
Slot.serviceCategory
DefinitionA broad categorization of the service that is to be performed during this appointment.
Cardinality1...*
TypeCodeableConcept
BindingValueSetEncounterClassMyCore (example)
SummaryTrue
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.

SlicingUnordered, Open, by coding.system(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
Slot.serviceCategory:encounterClass
DefinitionA broad categorization of the service that is to be performed during this appointment.
Cardinality0...*
TypeCodeableConcept
BindingValueSetEncounterClassMyCore (example)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
Slot.serviceCategory:encounterClass.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Slot.serviceCategory:encounterClass.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.serviceCategory:encounterClass.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Slot.serviceCategory:encounterClass.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Slot.serviceCategory:encounterClass.coding.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.serviceCategory:encounterClass.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Slot.serviceCategory:encounterClass.coding.version
DefinitionThe 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Slot.serviceCategory:encounterClass.coding.code
DefinitionA 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).
Cardinality0...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Slot.serviceCategory:encounterClass.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Slot.serviceCategory:encounterClass.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Slot.serviceCategory:encounterClass.text
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Slot.serviceCategory:serviceRequestCategory
DefinitionA broad categorization of the service that is to be performed during this appointment.
Cardinality0...*
TypeCodeableConcept
BindingValueSetServiceRequestCategoryMyCore (example)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
Slot.serviceCategory:serviceRequestCategory.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Slot.serviceCategory:serviceRequestCategory.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.serviceCategory:serviceRequestCategory.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Slot.serviceCategory:serviceRequestCategory.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Slot.serviceCategory:serviceRequestCategory.coding.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Slot.serviceCategory:serviceRequestCategory.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Slot.serviceCategory:serviceRequestCategory.coding.version
DefinitionThe 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Slot.serviceCategory:serviceRequestCategory.coding.code
DefinitionA 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).
Cardinality0...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Slot.serviceCategory:serviceRequestCategory.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Slot.serviceCategory:serviceRequestCategory.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Slot.serviceCategory:serviceRequestCategory.text
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Slot.serviceType
DefinitionThe type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
Cardinality1...*
TypeCodeableConcept
BindingValueSetServiceTypeMyCore (extensible)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
Slot.specialty
DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment.
Cardinality1...*
TypeCodeableConcept
Binding

Additional details about where the content was created (e.g. clinical specialty).

ValueSetSpecialtyMyCore (preferred)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
Slot.appointmentType
DefinitionThe style of appointment or patient that may be booked in the slot (not service type).
Cardinality1...1
TypeCodeableConcept
BindingValueSetScheduleTypeMyCore (required)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
Slot.schedule
DefinitionThe schedule resource that this slot defines an interval of status information.
Cardinality1...1
TypeReference(Schedule (MY Core))
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Slot.status
Definitionbusy | free | busy-unavailable | busy-tentative | entered-in-error.
Cardinality1...1
Typecode
Binding

The free/busy status of the slot.

SlotStatus (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • ical: FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
Slot.start
DefinitionDate/Time that the slot is to begin.
Cardinality1...1
Typeinstant
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.planned
  • ical: FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
Slot.end
DefinitionDate/Time that the slot is to conclude.
Cardinality1...1
Typeinstant
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.planned
  • ical: FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)
Slot.overbooked
DefinitionThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
Cardinality0...1
Typeboolean
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Slot.comment
DefinitionComments on the slot to describe any extended information. Such as custom constraints on the slot.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a

example-slot

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Slot-my-core" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2024-03-06T08:52:26.7088495+00:00" />
    </meta>
    <url value="http://fhir.hie.moh.gov.my/StructureDefinition/Slot-my-core" />
    <version value="1.0.1" />
    <name value="SlotMyCore" />
    <title value="Slot (MY Core)" />
    <status value="active" />
    <date value="2024-03-13T01:41:41.3395961+00:00" />
    <publisher value="Malaysia MOH - HIE Steering Committee" />
    <description value="A slot of time on a schedule that may be available for booking appointments." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Slot" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Slot" />
    <derivation value="constraint" />
    <differential>
        <element id="Slot.extension">
            <path value="Slot.extension" />
            <min value="1" />
        </element>
        <element id="Slot.extension:slotQuota">
            <path value="Slot.extension" />
            <sliceName value="slotQuota" />
            <short value="Extension about the maximum quota allocated for a slot" />
            <definition value="Extension about the maximum quota allocated for a slot" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/slot-quota-my-core" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Slot.serviceCategory">
            <path value="Slot.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="Slot.serviceCategory:encounterClass">
            <path value="Slot.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="Slot.serviceCategory:encounterClass.coding.system">
            <path value="Slot.serviceCategory.coding.system" />
            <fixedUri value="http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core" />
        </element>
        <element id="Slot.serviceCategory:serviceRequestCategory">
            <path value="Slot.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="Slot.serviceCategory:serviceRequestCategory.coding.system">
            <path value="Slot.serviceCategory.coding.system" />
            <fixedUri value="http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core" />
        </element>
        <element id="Slot.serviceType">
            <path value="Slot.serviceType" />
            <min value="1" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/service-type-my-core" />
            </binding>
        </element>
        <element id="Slot.specialty">
            <path value="Slot.specialty" />
            <min value="1" />
            <binding>
                <strength value="preferred" />
                <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/specialty-my-core" />
            </binding>
        </element>
        <element id="Slot.appointmentType">
            <path value="Slot.appointmentType" />
            <min value="1" />
            <binding>
                <strength value="required" />
                <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/schedule-type-my-core" />
            </binding>
        </element>
        <element id="Slot.schedule">
            <path value="Slot.schedule" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.hie.moh.gov.my/StructureDefinition/Schedule-my-core" />
            </type>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "Slot-my-core",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2024-03-06T08:52:26.7088495+00:00"
    },
    "url": "http://fhir.hie.moh.gov.my/StructureDefinition/Slot-my-core",
    "version": "1.0.1",
    "name": "SlotMyCore",
    "title": "Slot (MY Core)",
    "status": "active",
    "date": "2024-03-13T01:41:41.3395961+00:00",
    "publisher": "Malaysia MOH - HIE Steering Committee",
    "description": "A slot of time on a schedule that may be available for booking appointments.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Slot",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Slot",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Slot.extension",
                "path": "Slot.extension",
                "min": 1
            },
            {
                "id": "Slot.extension:slotQuota",
                "path": "Slot.extension",
                "sliceName": "slotQuota",
                "short": "Extension about the maximum quota allocated for a slot",
                "definition": "Extension about the maximum quota allocated for a slot",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.hie.moh.gov.my/StructureDefinition/slot-quota-my-core"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Slot.serviceCategory",
                "path": "Slot.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": "Slot.serviceCategory:encounterClass",
                "path": "Slot.serviceCategory",
                "sliceName": "encounterClass",
                "binding": {
                    "strength": "example",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core"
                }
            },
            {
                "id": "Slot.serviceCategory:encounterClass.coding.system",
                "path": "Slot.serviceCategory.coding.system",
                "fixedUri": "http://fhir.hie.moh.gov.my/ValueSet/encounter-class-my-core"
            },
            {
                "id": "Slot.serviceCategory:serviceRequestCategory",
                "path": "Slot.serviceCategory",
                "sliceName": "serviceRequestCategory",
                "binding": {
                    "strength": "example",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core"
                }
            },
            {
                "id": "Slot.serviceCategory:serviceRequestCategory.coding.system",
                "path": "Slot.serviceCategory.coding.system",
                "fixedUri": "http://fhir.hie.moh.gov.my/ValueSet/servicerequest-category-my-core"
            },
            {
                "id": "Slot.serviceType",
                "path": "Slot.serviceType",
                "min": 1,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/service-type-my-core"
                }
            },
            {
                "id": "Slot.specialty",
                "path": "Slot.specialty",
                "min": 1,
                "binding": {
                    "strength": "preferred",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/specialty-my-core"
                }
            },
            {
                "id": "Slot.appointmentType",
                "path": "Slot.appointmentType",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/schedule-type-my-core"
                }
            },
            {
                "id": "Slot.schedule",
                "path": "Slot.schedule",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.hie.moh.gov.my/StructureDefinition/Schedule-my-core"
                        ]
                    }
                ]
            }
        ]
    }
}

Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
slotQuotaI1..1Extension(Complex)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceTypeΣ1..*CodeableConceptBinding
specialtyΣ1..*CodeableConceptBinding
appointmentTypeΣ1..1CodeableConceptBinding
scheduleΣ I1..1Reference(Schedule (MY Core))
statusΣ1..1codeBinding
startΣ1..1instant
endΣ1..1instant
overbooked0..1boolean
comment0..1string

Diff

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
slotQuotaI1..1Extension(Complex)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceTypeΣ1..*CodeableConceptBinding
specialtyΣ1..*CodeableConceptBinding
appointmentTypeΣ1..1CodeableConceptBinding
scheduleΣ I1..1Reference(Schedule (MY Core))
statusΣ1..1codeBinding
startΣ1..1instant
endΣ1..1instant
overbooked0..1boolean
comment0..1string

Hybrid

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
slotQuotaI1..1Extension(Complex)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceTypeΣ1..*CodeableConceptBinding
specialtyΣ1..*CodeableConceptBinding
appointmentTypeΣ1..1CodeableConceptBinding
scheduleΣ I1..1Reference(Schedule (MY Core))
statusΣ1..1codeBinding
startΣ1..1instant
endΣ1..1instant
overbooked0..1boolean
comment0..1string

This profile is derived from the base FHIR Slot resource.

Requirements

This structure defines these element as mandatory requirement:

  1. A schedule referenced schedule
  2. A service category serviceCategory
  3. A service type serviceType
  4. A specialty/service specialty
  5. A status status
  6. A start instance start
  7. An end instance end
  8. The slot quota extension where extension.url=https://simplifier.net/resolve?scope=MyHIE@current&filepath=Extension/extension-slot-quota-my-core.json

Extension

This structure includes the following extension:

  1. ExtensionSlotQuota (MY Core)