HL7 Japan-JAMI eReferral ImplementationGuide
1.1.1-rc - release
HL7 Japan-JAMI eReferral ImplementationGuide - Local Development build (v1.1.1-rc). See the Directory of published versions
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/eClinicalSummary/StructureDefinition/JP_CarePlan_eClinicalSummary |
Version | 1.1.1-rc |
Name | JP_CarePlan_eClinicalSummary |
Status | Draft ( 2022-12-14 ) |
Copyright | Copyright HL7Japan and Japan Association of Medical Informatics (JAMI), CC(Creative Commons license) BY-ND CC表示・改変禁止 |
Derived Profile from JP-Core
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from JP_CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | JP_CarePlan | Healthcare plan for patient or group | |
text | S | 0..1 | Narrative | 本リソースをテキストで表現したものを入れてもよい。 |
status | 1..1 | code | generated Required Pattern: generated | |
div | 1..1 | xhtml | Limited xhtml content | |
identifier | S | 0..1 | Identifier | External Ids for this plan |
system | S | 1..1 | uri | The namespace for the identifier value Required Pattern: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier |
value | S | 1..1 | string | The value that is unique |
status | S | 1..1 | code | プランのステータス Required Pattern: active |
intent | S | 1..1 | code | 趣旨区分 Required Pattern: plan |
category | S | 0..1 | CodeableConcept | プランのタイプ |
coding | 0..* | Coding | Code defined by a terminology system Binding: http://jpfhir.jp/fhir/CarePlan/ValueSet/category (required) | |
title | S | 1..1 | string | プランの課題名称 |
description | S | 1..1 | string | プランの内容サマリー |
subject | S | 1..1 | Reference(JP Core Patient Profile) | 患者のあらわずPatientリソースへの参照 |
encounter | S | 0..1 | Reference(JP Core Encounter Profile) | 対象となる入院情報または退院情報を含む入院詳細情報 |
period | S | 1..1 | Period | このプランがカバーする期間 |
start | S | 1..1 | dateTime | 入院日または、退院日または退院日以降のこのプランのカバー開始日付 |
end | S | 0..1 | dateTime | 退院日または退院日以降のこのプランのカバー終了日付。通常省略されるが、ひき続き、次のプランに引き継ぐ場合には終了日付が入る。 |
created | S | 0..1 | dateTime | このプランが最初に作成された日付 |
author | S | 0..1 | Reference(JP Core Practitioner Profile) | このプランの責任者情報への参照 |
contributor | S | 0..0 | ||
careTeam | S | 0..0 | ||
Documentation for this format |
Path | Conformance | ValueSet |
CarePlan.category.coding | required | http://jpfhir.jp/fhir/CarePlan/ValueSet/category |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | JP_CarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | 本リソースをテキストで表現したものを入れてもよい。 |
status | 1..1 | code | generated Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: generated | |
div | C | 1..1 | xhtml | Limited xhtml content |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | External Ids for this plan |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | プランのステータス Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Required Pattern: active |
intent | ?!SΣ | 1..1 | code | 趣旨区分 Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan |
category | SΣ | 0..1 | CodeableConcept | プランのタイプ Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: http://jpfhir.jp/fhir/CarePlan/ValueSet/category (required) |
title | SΣ | 1..1 | string | プランの課題名称 |
description | SΣ | 1..1 | string | プランの内容サマリー |
subject | SΣ | 1..1 | Reference(JP Core Patient Profile) | 患者のあらわずPatientリソースへの参照 |
encounter | SΣ | 0..1 | Reference(JP Core Encounter Profile) | 対象となる入院情報または退院情報を含む入院詳細情報 |
period | SΣ | 1..1 | Period | このプランがカバーする期間 |
start | SΣC | 1..1 | dateTime | 入院日または、退院日または退院日以降のこのプランのカバー開始日付 |
end | SΣC | 0..1 | dateTime | 退院日または退院日以降のこのプランのカバー終了日付。通常省略されるが、ひき続き、次のプランに引き継ぐ場合には終了日付が入る。 |
created | SΣ | 0..1 | dateTime | このプランが最初に作成された日付 |
author | SΣ | 0..1 | Reference(JP Core Practitioner Profile) | このプランの責任者情報への参照 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
CarePlan.text.status | required | Pattern: generated |
CarePlan.identifier.use | required | IdentifierUse |
CarePlan.status | required | Pattern: active |
CarePlan.intent | required | Pattern: plan |
CarePlan.category | example | CarePlanCategory |
CarePlan.category.coding | required | http://jpfhir.jp/fhir/CarePlan/ValueSet/category |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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 | error | CarePlan | 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 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | JP_CarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | 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): A human language.
| |||||
text | S | 0..1 | Narrative | 本リソースをテキストで表現したものを入れてもよい。 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
status | 1..1 | code | generated Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: generated | |||||
div | C | 1..1 | xhtml | Limited xhtml content | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..1 | Identifier | External Ids for this plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
status | ?!SΣ | 1..1 | code | プランのステータス Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Required Pattern: active | ||||
intent | ?!SΣ | 1..1 | code | 趣旨区分 Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan | ||||
category | SΣ | 0..1 | CodeableConcept | プランのタイプ Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: http://jpfhir.jp/fhir/CarePlan/ValueSet/category (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
title | SΣ | 1..1 | string | プランの課題名称 | ||||
description | SΣ | 1..1 | string | プランの内容サマリー | ||||
subject | SΣ | 1..1 | Reference(JP Core Patient Profile) | 患者のあらわずPatientリソースへの参照 | ||||
encounter | SΣ | 0..1 | Reference(JP Core Encounter Profile) | 対象となる入院情報または退院情報を含む入院詳細情報 | ||||
period | SΣ | 1..1 | Period | このプランがカバーする期間 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | 入院日または、退院日または退院日以降のこのプランのカバー開始日付 | ||||
end | SΣC | 0..1 | dateTime | 退院日または退院日以降のこのプランのカバー終了日付。通常省略されるが、ひき続き、次のプランに引き継ぐ場合には終了日付が入る。 | ||||
created | SΣ | 0..1 | dateTime | このプランが最初に作成された日付 | ||||
author | SΣ | 0..1 | Reference(JP Core Practitioner Profile) | このプランの責任者情報への参照 | ||||
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
activity | C | 0..* | BackboneElement | Action to occur as part of plan | ||||
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 | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
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 | ||||
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |||||
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
scheduled[x] | 0..1 | When activity is to occur | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Extra info describing activity to perform | |||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
CarePlan.language | preferred | CommonLanguages
| ||||
CarePlan.text.status | required | Pattern: generated | ||||
CarePlan.identifier.use | required | IdentifierUse | ||||
CarePlan.identifier.type | extensible | Identifier Type Codes | ||||
CarePlan.status | required | Pattern: active | ||||
CarePlan.intent | required | Pattern: plan | ||||
CarePlan.category | example | CarePlanCategory | ||||
CarePlan.category.coding | required | http://jpfhir.jp/fhir/CarePlan/ValueSet/category | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from JP_CarePlan
Differential View
This structure is derived from JP_CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | JP_CarePlan | Healthcare plan for patient or group | |
text | S | 0..1 | Narrative | 本リソースをテキストで表現したものを入れてもよい。 |
status | 1..1 | code | generated Required Pattern: generated | |
div | 1..1 | xhtml | Limited xhtml content | |
identifier | S | 0..1 | Identifier | External Ids for this plan |
system | S | 1..1 | uri | The namespace for the identifier value Required Pattern: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier |
value | S | 1..1 | string | The value that is unique |
status | S | 1..1 | code | プランのステータス Required Pattern: active |
intent | S | 1..1 | code | 趣旨区分 Required Pattern: plan |
category | S | 0..1 | CodeableConcept | プランのタイプ |
coding | 0..* | Coding | Code defined by a terminology system Binding: http://jpfhir.jp/fhir/CarePlan/ValueSet/category (required) | |
title | S | 1..1 | string | プランの課題名称 |
description | S | 1..1 | string | プランの内容サマリー |
subject | S | 1..1 | Reference(JP Core Patient Profile) | 患者のあらわずPatientリソースへの参照 |
encounter | S | 0..1 | Reference(JP Core Encounter Profile) | 対象となる入院情報または退院情報を含む入院詳細情報 |
period | S | 1..1 | Period | このプランがカバーする期間 |
start | S | 1..1 | dateTime | 入院日または、退院日または退院日以降のこのプランのカバー開始日付 |
end | S | 0..1 | dateTime | 退院日または退院日以降のこのプランのカバー終了日付。通常省略されるが、ひき続き、次のプランに引き継ぐ場合には終了日付が入る。 |
created | S | 0..1 | dateTime | このプランが最初に作成された日付 |
author | S | 0..1 | Reference(JP Core Practitioner Profile) | このプランの責任者情報への参照 |
contributor | S | 0..0 | ||
careTeam | S | 0..0 | ||
Documentation for this format |
Path | Conformance | ValueSet |
CarePlan.category.coding | required | http://jpfhir.jp/fhir/CarePlan/ValueSet/category |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | JP_CarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | 本リソースをテキストで表現したものを入れてもよい。 |
status | 1..1 | code | generated Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: generated | |
div | C | 1..1 | xhtml | Limited xhtml content |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | External Ids for this plan |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | プランのステータス Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Required Pattern: active |
intent | ?!SΣ | 1..1 | code | 趣旨区分 Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan |
category | SΣ | 0..1 | CodeableConcept | プランのタイプ Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: http://jpfhir.jp/fhir/CarePlan/ValueSet/category (required) |
title | SΣ | 1..1 | string | プランの課題名称 |
description | SΣ | 1..1 | string | プランの内容サマリー |
subject | SΣ | 1..1 | Reference(JP Core Patient Profile) | 患者のあらわずPatientリソースへの参照 |
encounter | SΣ | 0..1 | Reference(JP Core Encounter Profile) | 対象となる入院情報または退院情報を含む入院詳細情報 |
period | SΣ | 1..1 | Period | このプランがカバーする期間 |
start | SΣC | 1..1 | dateTime | 入院日または、退院日または退院日以降のこのプランのカバー開始日付 |
end | SΣC | 0..1 | dateTime | 退院日または退院日以降のこのプランのカバー終了日付。通常省略されるが、ひき続き、次のプランに引き継ぐ場合には終了日付が入る。 |
created | SΣ | 0..1 | dateTime | このプランが最初に作成された日付 |
author | SΣ | 0..1 | Reference(JP Core Practitioner Profile) | このプランの責任者情報への参照 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
CarePlan.text.status | required | Pattern: generated |
CarePlan.identifier.use | required | IdentifierUse |
CarePlan.status | required | Pattern: active |
CarePlan.intent | required | Pattern: plan |
CarePlan.category | example | CarePlanCategory |
CarePlan.category.coding | required | http://jpfhir.jp/fhir/CarePlan/ValueSet/category |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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 | error | CarePlan | 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 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | JP_CarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | 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): A human language.
| |||||
text | S | 0..1 | Narrative | 本リソースをテキストで表現したものを入れてもよい。 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
status | 1..1 | code | generated Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: generated | |||||
div | C | 1..1 | xhtml | Limited xhtml content | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..1 | Identifier | External Ids for this plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
status | ?!SΣ | 1..1 | code | プランのステータス Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Required Pattern: active | ||||
intent | ?!SΣ | 1..1 | code | 趣旨区分 Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan | ||||
category | SΣ | 0..1 | CodeableConcept | プランのタイプ Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: http://jpfhir.jp/fhir/CarePlan/ValueSet/category (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
title | SΣ | 1..1 | string | プランの課題名称 | ||||
description | SΣ | 1..1 | string | プランの内容サマリー | ||||
subject | SΣ | 1..1 | Reference(JP Core Patient Profile) | 患者のあらわずPatientリソースへの参照 | ||||
encounter | SΣ | 0..1 | Reference(JP Core Encounter Profile) | 対象となる入院情報または退院情報を含む入院詳細情報 | ||||
period | SΣ | 1..1 | Period | このプランがカバーする期間 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | 入院日または、退院日または退院日以降のこのプランのカバー開始日付 | ||||
end | SΣC | 0..1 | dateTime | 退院日または退院日以降のこのプランのカバー終了日付。通常省略されるが、ひき続き、次のプランに引き継ぐ場合には終了日付が入る。 | ||||
created | SΣ | 0..1 | dateTime | このプランが最初に作成された日付 | ||||
author | SΣ | 0..1 | Reference(JP Core Practitioner Profile) | このプランの責任者情報への参照 | ||||
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
activity | C | 0..* | BackboneElement | Action to occur as part of plan | ||||
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 | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
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 | ||||
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |||||
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
scheduled[x] | 0..1 | When activity is to occur | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Extra info describing activity to perform | |||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
CarePlan.language | preferred | CommonLanguages
| ||||
CarePlan.text.status | required | Pattern: generated | ||||
CarePlan.identifier.use | required | IdentifierUse | ||||
CarePlan.identifier.type | extensible | Identifier Type Codes | ||||
CarePlan.status | required | Pattern: active | ||||
CarePlan.intent | required | Pattern: plan | ||||
CarePlan.category | example | CarePlanCategory | ||||
CarePlan.category.coding | required | http://jpfhir.jp/fhir/CarePlan/ValueSet/category | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from JP_CarePlan
Other representations of profile: CSV, Excel, Schematron