HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

Publish Box goes here

Appointment

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-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 profile builds on Appointment.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Appointment maps to Appointment:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  Status maps to status
  Specialty maps to extension
  ReasonCode maps to reason
  ReasonReference maps to extension
  PriorityRankUnsignedInt maps to priority
  CommentOrDescription maps to description
  TimePeriod.BeginDateTime maps to start
  TimePeriod.EndDateTime maps to end
  AppointmentParticipation maps to participant
  AppointmentParticipation.ParticipationType maps to participant.type
  AppointmentParticipation.AppointmentParticipant maps to participant.actor
  AppointmentParticipation.Need maps to participant.required
  AppointmentParticipation.Status maps to participant.status
  Type maps to extension
  ServiceType maps to extension
  ServiceCategory maps to extension
  Indication maps to extension
  RelatedInformation maps to extension
  StatementDateTime maps to extension
  ReferralRequest maps to extension
  ExpectedPerformanceTime maps to extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment shr-core-Appointment
... extension Slice: Unordered, Open by value:url
... shr-core-Specialty-extension 0..*CodeableConceptSpecialty
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Specialty-extension
Binding: Practice Setting Code Value Set (preferred)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-Type-extension 0..1CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... valueCodeableConcept Binding: v2 Appointment reason codes (preferred)
... shr-core-ServiceType-extension 0..*CodeableConceptServiceType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceType-extension
Binding: service-type (example)
... shr-core-ServiceCategory-extension 0..1CodeableConceptServiceCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceCategory-extension
Binding: service-category (example)
... shr-core-Indication-extension 0..*Reference(shr-core-Condition | shr-core-Procedure)Indication
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Indication-extension
... shr-core-RelatedInformation-extension 0..*Reference(shr-core-DomainResource)RelatedInformation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelatedInformation-extension
... shr-core-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-StatementDateTime-extension
... shr-core-ReferralRequest-extension 0..*Reference(shr-core-ReferralRequest)ReferralRequest
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRequest-extension
... shr-core-ExpectedPerformanceTime-extension 0..*dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformanceTime-extension
... participant
.... type 1..*
.... actor Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Device | shr-core-Location)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*shr-core-Appointment
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-2: Either start and end are specified, or neither
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Specialty-extension 0..*CodeableConceptSpecialty
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Specialty-extension
Binding: Practice Setting Code Value Set (preferred)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-Type-extension 0..1CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: v2 Appointment reason codes (preferred)
... shr-core-ServiceType-extension 0..*CodeableConceptServiceType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceType-extension
Binding: service-type (example)
... shr-core-ServiceCategory-extension 0..1CodeableConceptServiceCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceCategory-extension
Binding: service-category (example)
... shr-core-Indication-extension 0..*Reference(shr-core-Condition | shr-core-Procedure)Indication
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Indication-extension
... shr-core-RelatedInformation-extension 0..*Reference(shr-core-DomainResource)RelatedInformation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelatedInformation-extension
... shr-core-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-StatementDateTime-extension
... shr-core-ReferralRequest-extension 0..*Reference(shr-core-ReferralRequest)ReferralRequest
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRequest-extension
... shr-core-ExpectedPerformanceTime-extension 0..*dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformanceTime-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow
Binding: AppointmentStatus (required)
... type Σ0..1CodeableConceptThe type of appointment that is being booked
Binding: Practice Setting Code Value Set (preferred)
... reason Σ0..1CodeableConceptReason this appointment is scheduled
Binding: Encounter Reason Codes (required)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... start Σ0..1instantWhen appointment is to take place
... end Σ0..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)If provided, then no schedule and start/end values MUST match slot
... comment 0..1stringAdditional comments
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant MUST be specified
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type Σ1..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (required)
.... actor Σ0..1Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Device | shr-core-Location)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status 1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Appointment maps to Appointment:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  Status maps to status
  Specialty maps to extension
  ReasonCode maps to reason
  ReasonReference maps to extension
  PriorityRankUnsignedInt maps to priority
  CommentOrDescription maps to description
  TimePeriod.BeginDateTime maps to start
  TimePeriod.EndDateTime maps to end
  AppointmentParticipation maps to participant
  AppointmentParticipation.ParticipationType maps to participant.type
  AppointmentParticipation.AppointmentParticipant maps to participant.actor
  AppointmentParticipation.Need maps to participant.required
  AppointmentParticipation.Status maps to participant.status
  Type maps to extension
  ServiceType maps to extension
  ServiceCategory maps to extension
  Indication maps to extension
  RelatedInformation maps to extension
  StatementDateTime maps to extension
  ReferralRequest maps to extension
  ExpectedPerformanceTime maps to extension

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment shr-core-Appointment
... extension Slice: Unordered, Open by value:url
... shr-core-Specialty-extension 0..*CodeableConceptSpecialty
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Specialty-extension
Binding: Practice Setting Code Value Set (preferred)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-Type-extension 0..1CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... valueCodeableConcept Binding: v2 Appointment reason codes (preferred)
... shr-core-ServiceType-extension 0..*CodeableConceptServiceType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceType-extension
Binding: service-type (example)
... shr-core-ServiceCategory-extension 0..1CodeableConceptServiceCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceCategory-extension
Binding: service-category (example)
... shr-core-Indication-extension 0..*Reference(shr-core-Condition | shr-core-Procedure)Indication
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Indication-extension
... shr-core-RelatedInformation-extension 0..*Reference(shr-core-DomainResource)RelatedInformation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelatedInformation-extension
... shr-core-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-StatementDateTime-extension
... shr-core-ReferralRequest-extension 0..*Reference(shr-core-ReferralRequest)ReferralRequest
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRequest-extension
... shr-core-ExpectedPerformanceTime-extension 0..*dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformanceTime-extension
... participant
.... type 1..*
.... actor Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Device | shr-core-Location)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*shr-core-Appointment
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-2: Either start and end are specified, or neither
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Specialty-extension 0..*CodeableConceptSpecialty
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Specialty-extension
Binding: Practice Setting Code Value Set (preferred)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-Type-extension 0..1CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: v2 Appointment reason codes (preferred)
... shr-core-ServiceType-extension 0..*CodeableConceptServiceType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceType-extension
Binding: service-type (example)
... shr-core-ServiceCategory-extension 0..1CodeableConceptServiceCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ServiceCategory-extension
Binding: service-category (example)
... shr-core-Indication-extension 0..*Reference(shr-core-Condition | shr-core-Procedure)Indication
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Indication-extension
... shr-core-RelatedInformation-extension 0..*Reference(shr-core-DomainResource)RelatedInformation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelatedInformation-extension
... shr-core-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-StatementDateTime-extension
... shr-core-ReferralRequest-extension 0..*Reference(shr-core-ReferralRequest)ReferralRequest
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRequest-extension
... shr-core-ExpectedPerformanceTime-extension 0..*dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformanceTime-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow
Binding: AppointmentStatus (required)
... type Σ0..1CodeableConceptThe type of appointment that is being booked
Binding: Practice Setting Code Value Set (preferred)
... reason Σ0..1CodeableConceptReason this appointment is scheduled
Binding: Encounter Reason Codes (required)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... start Σ0..1instantWhen appointment is to take place
... end Σ0..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)If provided, then no schedule and start/end values MUST match slot
... comment 0..1stringAdditional comments
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant MUST be specified
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type Σ1..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (required)
.... actor Σ0..1Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Device | shr-core-Location)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status 1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

 

Constraints

IdPathDetailsRequirements
app-3AppointmentOnly proposed or cancelled appointments can be missing start/end dates
:
app-2AppointmentEither start and end are specified, or neither
:
app-1Appointment.participantEither the type or actor on the participant MUST be specified
: