medTech IG
0.1.0 - CI Build

medTech IG, published by medtech. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/medtech/ and changes regularly. See the Directory of published versions

Resource Profile: Appointment profile

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/MtAppointment
Version:0.1.0
Name:MtAppointment
Title:Appointment profile
Status:Active as of 2021-07-11T23:33:42+00:00
Definition:

The Appointment resource exposed by the ALEX infrastructure.

Publisher:medtech
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/MtAppointment

Formal Views of Profile Content

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

This structure is derived from Appointment

Summary

Prohibited: 16 elements

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment 0..*AppointmentA 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)
... identifier 0..0
... cancelationReason 0..0
... serviceCategory 0..0
... specialty 0..0
... appointmentType 0..0
... reasonCode 0..0
... reasonReference 0..0
... priority 0..0
... description 0..0
... supportingInformation 0..0
... minutesDuration 0..0
... slot 0..0
... created 0..0
... patientInstruction 0..0
... basedOn 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... start Σ0..1instantWhen appointment is to take place
... end Σ0..1instantWhen appointment is to conclude
... comment 0..1stringAdditional comments
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA 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)

doco Documentation for this format

This structure is derived from Appointment

Summary

Prohibited: 16 elements

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment 0..*AppointmentA 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)
... identifier 0..0
... cancelationReason 0..0
... serviceCategory 0..0
... specialty 0..0
... appointmentType 0..0
... reasonCode 0..0
... reasonReference 0..0
... priority 0..0
... description 0..0
... supportingInformation 0..0
... minutesDuration 0..0
... slot 0..0
... created 0..0
... patientInstruction 0..0
... basedOn 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... start Σ0..1instantWhen appointment is to take place
... end Σ0..1instantWhen appointment is to conclude
... comment 0..1stringAdditional comments
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Appointment.languagepreferredCommonLanguages
Max Binding: AllLanguages
Appointment.statusrequiredAppointmentStatus
Appointment.participant.typeextensibleParticipantType
Appointment.participant.requiredrequiredParticipantRequired
Appointment.participant.statusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
app-1Appointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()