FHIR.EGDEVJ\VJ Appointment

0.1.0 - ci-build

EgdeVJ_IG - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: VJ Appointment

Defining URL:

http://fhir.onegde.no/StructureDefinition/egde-vj-appointment

Version:

0.1.0

Name:

VJAppointment

Title:

VJ Appointment

Status:

Draft as of 2021-08-18T14:36:33+02:00

Definition:

Resource containing the Appointment details

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://fhir.onegde.no/StructureDefinition/egde-vj-appointment

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Appointment

Summary

Mandatory: 1 element
Prohibited: 6 elements

This structure is derived from Appointment

Name	Card.	Type	Description & Constraints
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)
cancelationReason	0..0
serviceCategory	0..0
serviceType	0..0
specialty	0..0
appointmentType	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code	1..1	code	Symbol in syntax defined by the system Fixed Value: 130311006
display	1..1	string	Representation defined by the system Fixed Value: FOLLOWUP
reasonCode	0..0
priority	0..0
description	1..1	string	Shown on a subject line in a meeting request, or appointment list
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Appointment	I	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	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error \| checked-in \| waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 130311006
display		1..1	string	Representation defined by the system Fixed Value: FOLLOWUP
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
reasonReference		0..*	Reference(Condition \| Procedure \| Observation \| ImmunizationRecommendation)	Reason the appointment is to take place (resource)
description		1..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	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially 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	I	1..*	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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	Σ	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Appointment	I	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)
Documentation for this format

This structure is derived from Appointment

Summary

Mandatory: 1 element
Prohibited: 6 elements

Differential View

This structure is derived from Appointment

Name	Card.	Type	Description & Constraints
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)
cancelationReason	0..0
serviceCategory	0..0
serviceType	0..0
specialty	0..0
appointmentType	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code	1..1	code	Symbol in syntax defined by the system Fixed Value: 130311006
display	1..1	string	Representation defined by the system Fixed Value: FOLLOWUP
reasonCode	0..0
priority	0..0
description	1..1	string	Shown on a subject line in a meeting request, or appointment list
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	I	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	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error \| checked-in \| waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 130311006
display		1..1	string	Representation defined by the system Fixed Value: FOLLOWUP
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
reasonReference		0..*	Reference(Condition \| Procedure \| Observation \| ImmunizationRecommendation)	Reason the appointment is to take place (resource)
description		1..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	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially 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	I	1..*	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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	Σ	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Appointment.language	preferred	CommonLanguages Max Binding: AllLanguages
Appointment.status	required	AppointmentStatus
Appointment.appointmentType	preferred	Pattern: SNOMED CT code 130311006("FOLLOWUP")
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus

Constraints

Id	Path	Details	Requirements
app-2	Appointment	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	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	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')
dom-2	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	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	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	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Appointment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Appointment.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Appointment.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Appointment.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Appointment.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Appointment.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.appointmentType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.supportingInformation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.start	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.end	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.minutesDuration	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.slot	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.created	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.comment	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.patientInstruction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
app-1	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
ele-1	Appointment.participant	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.participant.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Appointment.participant.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Appointment.participant.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Appointment.participant.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Appointment.participant.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.participant.actor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.participant.required	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.participant.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.participant.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Appointment.requestedPeriod	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())