MedMe Pharmacy Services Implementation Guide
0.9.24 - ci-build Canada flag

MedMe Pharmacy Services Implementation Guide - Local Development build (v0.9.24) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MedMe Pharmacy Appointment

Official URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/medme-pharmacy-appointment Version: 0.9.24
Draft as of 2025-12-08 Computable Name: MedMePharmacyAppointment

A profile of Appointment for MedMe pharmacy services, based on FHIR R4, with essential fields for pharmacy appointment management.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Unique identifier for the appointment
... meta Σ 1..1 Meta Metadata including profile version
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:appointmentMode 1..1 string The mode of service delivery (e.g., in-person, virtual, phone)
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/appointment-mode
.... extension:artifactContact 0..1 ContactDetail Contact details for appointment communications (may be different from patient)
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
.... extension:communicationLanguage 1..1 CodeableConcept Preferred language for appointment communications
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/communication-language
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier MedMe appointment ID
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: https://fhir.medmehealth.com/pharmacy-services/systems/entity/appointment/id
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code Status of the appointment (pending, booked, cancelled, fulfilled, entered-in-error)
Binding: MedMe Appointment Status (required)
... appointmentType ΣC 1..1 CodeableConcept Type of appointment (WALKIN or ROUTINE)
Binding: MedMe Appointment Type (required)
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0276
..... code Σ 1..1 code Symbol in syntax defined by the system
... start Σ 1..1 instant Scheduled start time of the appointment
... end Σ 1..1 instant Scheduled end time of the appointment
... minutesDuration 1..1 positiveInt Duration of the appointment in minutes
... slot 0..1 Reference(MedMe Pharmacy Slot) The slot fulfilled by this appointment, only required for non-WALKIN/INSTANT appointments originating from dynamic slots.
... created 1..1 dateTime Date and time when the appointment was created
... participant C 2..* BackboneElement Participants in the appointment (at least 2: patient and healthcare service)
Constraints: app-1, at-least-one-patient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(MedMe Pharmacy Patient | MedMe Pharmacy HealthcareService | MedMe Pharmacy Location) Reference to the participant (Patient or HealthcareService)
.... status Σ 1..1 code Status of the participant's participation
Binding: ParticipationStatus (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Appointment.status Base required MedMe Appointment Status 📦0.9.24 This IG
Appointment.appointmentType Base required MedMe Appointment Type 📦0.9.24 This IG
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
at-least-one-healthcare-service error **ALL** elements At least one participant must be a HealthcareService participant.where(actor.reference.startsWith('HealthcareService/')).count() >= 1
at-least-one-patient error Appointment.participant At least one participant must be a Patient participant.where(actor.reference.startsWith('Patient/')).count() >= 1
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
walkin-no-slot error **ALL** elements If appointment type is WALKIN, slot must not be present appointmentType.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0276' and code = 'WALKIN').exists() implies slot.empty()

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
... id 0..1 id Unique identifier for the appointment
... meta 1..1 Meta Metadata including profile version
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:appointmentMode 1..1 string The mode of service delivery (e.g., in-person, virtual, phone)
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/appointment-mode
.... extension:artifactContact 0..1 ContactDetail Contact details for appointment communications (may be different from patient)
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
.... extension:communicationLanguage 1..1 CodeableConcept Preferred language for appointment communications
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/communication-language
.... system 0..1 uri The namespace for the identifier value
Fixed Value: https://fhir.medmehealth.com/pharmacy-services/systems/entity/appointment/id
.... value 1..1 string The value that is unique
... status 1..1 code Status of the appointment (pending, booked, cancelled, fulfilled, entered-in-error)
Binding: MedMe Appointment Status (required)
... appointmentType C 1..1 CodeableConcept Type of appointment (WALKIN or ROUTINE)
Binding: MedMe Appointment Type (required)
.... coding 1..1 Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0276
..... code 1..1 code Symbol in syntax defined by the system
... start 1..1 instant Scheduled start time of the appointment
... end 1..1 instant Scheduled end time of the appointment
... minutesDuration 1..1 positiveInt Duration of the appointment in minutes
... slot 0..1 Reference(MedMe Pharmacy Slot) The slot fulfilled by this appointment, only required for non-WALKIN/INSTANT appointments originating from dynamic slots.
... created 1..1 dateTime Date and time when the appointment was created
... participant C 2..* BackboneElement Participants in the appointment (at least 2: patient and healthcare service)
Constraints: at-least-one-patient
.... actor 1..1 Reference(MedMe Pharmacy Patient | MedMe Pharmacy HealthcareService | MedMe Pharmacy Location) Reference to the participant (Patient or HealthcareService)
.... status 1..1 code Status of the participant's participation
Binding: ParticipationStatus (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.status Base required MedMe Appointment Status 📦0.9.24 This IG
Appointment.appointmentType Base required MedMe Appointment Type 📦0.9.24 This IG
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
at-least-one-healthcare-service error **ALL** elements At least one participant must be a HealthcareService participant.where(actor.reference.startsWith('HealthcareService/')).count() >= 1
at-least-one-patient error Appointment.participant At least one participant must be a Patient participant.where(actor.reference.startsWith('Patient/')).count() >= 1
walkin-no-slot error **ALL** elements If appointment type is WALKIN, slot must not be present appointmentType.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0276' and code = 'WALKIN').exists() implies slot.empty()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Unique identifier for the appointment
... meta Σ 1..1 Meta Metadata including profile version
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:appointmentMode 1..1 string The mode of service delivery (e.g., in-person, virtual, phone)
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/appointment-mode
.... extension:artifactContact 0..1 ContactDetail Contact details for appointment communications (may be different from patient)
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
.... extension:communicationLanguage 1..1 CodeableConcept Preferred language for appointment communications
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/communication-language
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier MedMe appointment ID
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: https://fhir.medmehealth.com/pharmacy-services/systems/entity/appointment/id
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code Status of the appointment (pending, booked, cancelled, fulfilled, entered-in-error)
Binding: MedMe Appointment Status (required)
... cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType ΣC 1..1 CodeableConcept Type of appointment (WALKIN or ROUTINE)
Binding: MedMe Appointment Type (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0276
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
... start Σ 1..1 instant Scheduled start time of the appointment
... end Σ 1..1 instant Scheduled end time of the appointment
... minutesDuration 1..1 positiveInt Duration of the appointment in minutes
... slot 0..1 Reference(MedMe Pharmacy Slot) The slot fulfilled by this appointment, only required for non-WALKIN/INSTANT appointments originating from dynamic slots.
... created 1..1 dateTime Date and time when the appointment was created
... comment 0..1 string Additional comments
... patientInstruction 0..1 string Detailed information and instructions for the patient
... basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
... participant C 2..* BackboneElement Participants in the appointment (at least 2: patient and healthcare service)
Constraints: app-1, at-least-one-patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
.... actor Σ 1..1 Reference(MedMe Pharmacy Patient | MedMe Pharmacy HealthcareService | MedMe Pharmacy Location) Reference to the participant (Patient or HealthcareService)
.... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
.... status Σ 1..1 code Status of the participant's participation
Binding: ParticipationStatus (required)
.... period 0..1 Period Participation period of the actor
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Appointment.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Appointment.status Base required MedMe Appointment Status 📦0.9.24 This IG
Appointment.cancelationReason Base example Appointment cancellation reason 📍4.0.1 FHIR Std.
Appointment.serviceCategory Base example Service category 📍4.0.1 FHIR Std.
Appointment.serviceType Base example Service type 📍4.0.1 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Appointment.appointmentType Base required MedMe Appointment Type 📦0.9.24 This IG
Appointment.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Appointment.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
at-least-one-healthcare-service error **ALL** elements At least one participant must be a HealthcareService participant.where(actor.reference.startsWith('HealthcareService/')).count() >= 1
at-least-one-patient error Appointment.participant At least one participant must be a Patient participant.where(actor.reference.startsWith('Patient/')).count() >= 1
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
walkin-no-slot error **ALL** elements If appointment type is WALKIN, slot must not be present appointmentType.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0276' and code = 'WALKIN').exists() implies slot.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Unique identifier for the appointment
... meta Σ 1..1 Meta Metadata including profile version
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:appointmentMode 1..1 string The mode of service delivery (e.g., in-person, virtual, phone)
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/appointment-mode
.... extension:artifactContact 0..1 ContactDetail Contact details for appointment communications (may be different from patient)
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
.... extension:communicationLanguage 1..1 CodeableConcept Preferred language for appointment communications
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/communication-language
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier MedMe appointment ID
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: https://fhir.medmehealth.com/pharmacy-services/systems/entity/appointment/id
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code Status of the appointment (pending, booked, cancelled, fulfilled, entered-in-error)
Binding: MedMe Appointment Status (required)
... appointmentType ΣC 1..1 CodeableConcept Type of appointment (WALKIN or ROUTINE)
Binding: MedMe Appointment Type (required)
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0276
..... code Σ 1..1 code Symbol in syntax defined by the system
... start Σ 1..1 instant Scheduled start time of the appointment
... end Σ 1..1 instant Scheduled end time of the appointment
... minutesDuration 1..1 positiveInt Duration of the appointment in minutes
... slot 0..1 Reference(MedMe Pharmacy Slot) The slot fulfilled by this appointment, only required for non-WALKIN/INSTANT appointments originating from dynamic slots.
... created 1..1 dateTime Date and time when the appointment was created
... participant C 2..* BackboneElement Participants in the appointment (at least 2: patient and healthcare service)
Constraints: app-1, at-least-one-patient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(MedMe Pharmacy Patient | MedMe Pharmacy HealthcareService | MedMe Pharmacy Location) Reference to the participant (Patient or HealthcareService)
.... status Σ 1..1 code Status of the participant's participation
Binding: ParticipationStatus (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Appointment.status Base required MedMe Appointment Status 📦0.9.24 This IG
Appointment.appointmentType Base required MedMe Appointment Type 📦0.9.24 This IG
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
at-least-one-healthcare-service error **ALL** elements At least one participant must be a HealthcareService participant.where(actor.reference.startsWith('HealthcareService/')).count() >= 1
at-least-one-patient error Appointment.participant At least one participant must be a Patient participant.where(actor.reference.startsWith('Patient/')).count() >= 1
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
walkin-no-slot error **ALL** elements If appointment type is WALKIN, slot must not be present appointmentType.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0276' and code = 'WALKIN').exists() implies slot.empty()

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
... id 0..1 id Unique identifier for the appointment
... meta 1..1 Meta Metadata including profile version
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:appointmentMode 1..1 string The mode of service delivery (e.g., in-person, virtual, phone)
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/appointment-mode
.... extension:artifactContact 0..1 ContactDetail Contact details for appointment communications (may be different from patient)
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
.... extension:communicationLanguage 1..1 CodeableConcept Preferred language for appointment communications
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/communication-language
.... system 0..1 uri The namespace for the identifier value
Fixed Value: https://fhir.medmehealth.com/pharmacy-services/systems/entity/appointment/id
.... value 1..1 string The value that is unique
... status 1..1 code Status of the appointment (pending, booked, cancelled, fulfilled, entered-in-error)
Binding: MedMe Appointment Status (required)
... appointmentType C 1..1 CodeableConcept Type of appointment (WALKIN or ROUTINE)
Binding: MedMe Appointment Type (required)
.... coding 1..1 Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0276
..... code 1..1 code Symbol in syntax defined by the system
... start 1..1 instant Scheduled start time of the appointment
... end 1..1 instant Scheduled end time of the appointment
... minutesDuration 1..1 positiveInt Duration of the appointment in minutes
... slot 0..1 Reference(MedMe Pharmacy Slot) The slot fulfilled by this appointment, only required for non-WALKIN/INSTANT appointments originating from dynamic slots.
... created 1..1 dateTime Date and time when the appointment was created
... participant C 2..* BackboneElement Participants in the appointment (at least 2: patient and healthcare service)
Constraints: at-least-one-patient
.... actor 1..1 Reference(MedMe Pharmacy Patient | MedMe Pharmacy HealthcareService | MedMe Pharmacy Location) Reference to the participant (Patient or HealthcareService)
.... status 1..1 code Status of the participant's participation
Binding: ParticipationStatus (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.status Base required MedMe Appointment Status 📦0.9.24 This IG
Appointment.appointmentType Base required MedMe Appointment Type 📦0.9.24 This IG
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
at-least-one-healthcare-service error **ALL** elements At least one participant must be a HealthcareService participant.where(actor.reference.startsWith('HealthcareService/')).count() >= 1
at-least-one-patient error Appointment.participant At least one participant must be a Patient participant.where(actor.reference.startsWith('Patient/')).count() >= 1
walkin-no-slot error **ALL** elements If appointment type is WALKIN, slot must not be present appointmentType.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0276' and code = 'WALKIN').exists() implies slot.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Unique identifier for the appointment
... meta Σ 1..1 Meta Metadata including profile version
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:appointmentMode 1..1 string The mode of service delivery (e.g., in-person, virtual, phone)
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/appointment-mode
.... extension:artifactContact 0..1 ContactDetail Contact details for appointment communications (may be different from patient)
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
.... extension:communicationLanguage 1..1 CodeableConcept Preferred language for appointment communications
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/communication-language
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier MedMe appointment ID
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: https://fhir.medmehealth.com/pharmacy-services/systems/entity/appointment/id
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code Status of the appointment (pending, booked, cancelled, fulfilled, entered-in-error)
Binding: MedMe Appointment Status (required)
... cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType ΣC 1..1 CodeableConcept Type of appointment (WALKIN or ROUTINE)
Binding: MedMe Appointment Type (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0276
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
... start Σ 1..1 instant Scheduled start time of the appointment
... end Σ 1..1 instant Scheduled end time of the appointment
... minutesDuration 1..1 positiveInt Duration of the appointment in minutes
... slot 0..1 Reference(MedMe Pharmacy Slot) The slot fulfilled by this appointment, only required for non-WALKIN/INSTANT appointments originating from dynamic slots.
... created 1..1 dateTime Date and time when the appointment was created
... comment 0..1 string Additional comments
... patientInstruction 0..1 string Detailed information and instructions for the patient
... basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
... participant C 2..* BackboneElement Participants in the appointment (at least 2: patient and healthcare service)
Constraints: app-1, at-least-one-patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
.... actor Σ 1..1 Reference(MedMe Pharmacy Patient | MedMe Pharmacy HealthcareService | MedMe Pharmacy Location) Reference to the participant (Patient or HealthcareService)
.... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
.... status Σ 1..1 code Status of the participant's participation
Binding: ParticipationStatus (required)
.... period 0..1 Period Participation period of the actor
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Appointment.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Appointment.status Base required MedMe Appointment Status 📦0.9.24 This IG
Appointment.cancelationReason Base example Appointment cancellation reason 📍4.0.1 FHIR Std.
Appointment.serviceCategory Base example Service category 📍4.0.1 FHIR Std.
Appointment.serviceType Base example Service type 📍4.0.1 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Appointment.appointmentType Base required MedMe Appointment Type 📦0.9.24 This IG
Appointment.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Appointment.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
at-least-one-healthcare-service error **ALL** elements At least one participant must be a HealthcareService participant.where(actor.reference.startsWith('HealthcareService/')).count() >= 1
at-least-one-patient error Appointment.participant At least one participant must be a Patient participant.where(actor.reference.startsWith('Patient/')).count() >= 1
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
walkin-no-slot error **ALL** elements If appointment type is WALKIN, slot must not be present appointmentType.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0276' and code = 'WALKIN').exists() implies slot.empty()

 

Other representations of profile: CSV, Excel, Schematron