Union of https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-appointment and https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-appointment

This is the set of resources that conform to either of the profiles FiSchedulingAppointment (https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-appointment) and FiSchedulingAppointment (https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-appointment). E.g. what you have to deal with if you get resources conforming to one of them

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*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)
app-2: Either start and end are specified, or neither
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1codeLanguage of the resource content
Binding: ?? (preferred): A human language.


ele-1: All FHIR elements must have a @value or children
... text 0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ1..*IdentifierExternal Ids for this item
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: ?? (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type Σ0..1CodeableConceptDescription of identifier
Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
.... system Σ0..1uriThe namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
ele-1: All FHIR elements must have a @value or children
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ1..1codesuunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
Binding: ?? (required): The free/busy status of an appointment.


ele-1: All FHIR elements must have a @value or children
... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: ?? (example)
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... coding Σ0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system Σ0..1uriTHL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
ele-1: All FHIR elements must have a @value or children
..... version Σ0..1stringVersion of the system - if relevant
ele-1: All FHIR elements must have a @value or children
..... code Σ0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
ele-1: All FHIR elements must have a @value or children
.... text Σ0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ?? (example)
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... coding Σ0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system Σ0..1uriAR/YDIN - Palvelutapahtumaluokitus
ele-1: All FHIR elements must have a @value or children
..... version Σ0..1stringVersion of the system - if relevant
ele-1: All FHIR elements must have a @value or children
..... code Σ0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
ele-1: All FHIR elements must have a @value or children
.... text Σ0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... serviceType Σ1..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ?? (example)
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... coding Σ0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system Σ0..1uriTHL - Sosiaali- ja terveysalan palvelunimikkeistö
ele-1: All FHIR elements must have a @value or children
..... version Σ0..1stringVersion of the system - if relevant
ele-1: All FHIR elements must have a @value or children
..... code Σ0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
ele-1: All FHIR elements must have a @value or children
.... text Σ0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: ?? (preferred)
ele-1: All FHIR elements must have a @value or children
... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: ?? (preferred)
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... coding Σ0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system Σ0..1urihl7fi: asiointitapa
ele-1: All FHIR elements must have a @value or children
..... version Σ0..1stringVersion of the system - if relevant
ele-1: All FHIR elements must have a @value or children
..... code Σ0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
ele-1: All FHIR elements must have a @value or children
.... text Σ0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... reasonCode Σ0..*CodeableConceptCoded reason this appointment is scheduled
Binding: ?? (preferred): The Reason for the appointment to take place.


ele-1: All FHIR elements must have a @value or children
... reasonReference 0..*Reference(Condition) {c}Reason the appointment is to take place (resource)
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... reference Σ0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model).


ele-1: All FHIR elements must have a @value or children
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
.... display Σ0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
ele-1: All FHIR elements must have a @value or children
... description 0..1stringShown on a subject line in a meeting request, or appointment list
ele-1: All FHIR elements must have a @value or children
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
ele-1: All FHIR elements must have a @value or children
... start Σ0..1instantWhen appointment is to take place
ele-1: All FHIR elements must have a @value or children
... end Σ0..1instantWhen appointment is to conclude
ele-1: All FHIR elements must have a @value or children
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
ele-1: All FHIR elements must have a @value or children
... slot 0..*Reference(Slot)The slots that this appointment is filling
ele-1: All FHIR elements must have a @value or children
... created 0..1dateTimeThe date that this appointment was initially created
ele-1: All FHIR elements must have a @value or children
... comment 0..1stringhl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
ele-1: All FHIR elements must have a @value or children
... patientInstruction 0..1stringhl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionExtension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
ele-1: All FHIR elements must have a @value or children
... participant C1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ?? (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children
.... actor Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)Person, Location/HealthcareService or Device
ele-1: All FHIR elements must have a @value or children
.... required Σ0..1coderequired | optional | information-only
Binding: ?? (required): Is the Participant required to attend the appointment.


ele-1: All FHIR elements must have a @value or children
.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ?? (required): The Participation status of an appointment.


ele-1: All FHIR elements must have a @value or children
.... period 0..1PeriodParticipation period of the actor
ele-1: All FHIR elements must have a @value or children
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format