International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. 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/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPACarePlan

Minimum expectations for a CarePlan resource when accessed via a International Patient Access API

The official URL for this profile is: 

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-careplan

Formal Views of Profile Content

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

This structure is derived from CarePlan

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text SI1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Ids for this plan
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan)Fulfills CarePlan
... replaces ΣI0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf ΣI0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣI0..*CodeableConceptType of plan
Binding: CarePlanCategory (example)
... title ΣI0..1stringHuman-friendly name for the care plan
... description ΣI0..1stringSummary of nature of plan
... subject SΣI1..1Reference(IPA-Patient)Who the care plan is for
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... period SΣI0..1PeriodTime period plan covers
... created ΣI0..1dateTimeDate record was first recorded
... author ΣI0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
... contributor I0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam I0..*Reference(CareTeam)Who's involved in plan?
... addresses ΣI0..*Reference(Condition)Health issues this plan addresses
... supportingInfo I0..*Reference(Resource)Information considered as part of plan
... goal I0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept I0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference I0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress I0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical I0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri I0..*uriInstantiates external protocol or definition
..... code I0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode I0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal I0..*Reference(Goal)Goals this activity relates to
..... status ?!I1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason I0..1CodeableConceptReason for current status
..... doNotPerform ?!I0..1booleanIf true, activity is prohibiting action
..... scheduled[x] I0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location I0..1Reference(Location)Where it should happen
..... performer I0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
..... product[x] I0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount I0..1SimpleQuantityHow to consume/day?
..... quantity I0..1SimpleQuantityHow much to administer/supply/consume
..... description I0..1stringExtra info describing activity to perform
... note I0..*AnnotationComments about the plan

doco Documentation for this format

This structure is derived from CarePlan

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text SI1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Ids for this plan
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan)Fulfills CarePlan
... replaces ΣI0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf ΣI0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣI0..*CodeableConceptType of plan
Binding: CarePlanCategory (example)
... title ΣI0..1stringHuman-friendly name for the care plan
... description ΣI0..1stringSummary of nature of plan
... subject SΣI1..1Reference(IPA-Patient)Who the care plan is for
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... period SΣI0..1PeriodTime period plan covers
... created ΣI0..1dateTimeDate record was first recorded
... author ΣI0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
... contributor I0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam I0..*Reference(CareTeam)Who's involved in plan?
... addresses ΣI0..*Reference(Condition)Health issues this plan addresses
... supportingInfo I0..*Reference(Resource)Information considered as part of plan
... goal I0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept I0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference I0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress I0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical I0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri I0..*uriInstantiates external protocol or definition
..... code I0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode I0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal I0..*Reference(Goal)Goals this activity relates to
..... status ?!I1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason I0..1CodeableConceptReason for current status
..... doNotPerform ?!I0..1booleanIf true, activity is prohibiting action
..... scheduled[x] I0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location I0..1Reference(Location)Where it should happen
..... performer I0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
..... product[x] I0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount I0..1SimpleQuantityHow to consume/day?
..... quantity I0..1SimpleQuantityHow much to administer/supply/consume
..... description I0..1stringExtra info describing activity to perform
... note I0..*AnnotationComments about the plan

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
CarePlan.languagepreferredCommonLanguages
Max Binding: AllLanguages
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

Constraints

IdPathDetailsRequirements
cpl-3CarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()