Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-EpisodeOfCare | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibEpisodeOfCare | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
The period in which a health problem, such as a complaint or illness, receives attention from a care provider. During this period the designation of this health problem can change due to evolving insight and/or the progress of the illness. An episode of care serves as a context for all data related to the health problem.
This EpisodeOfCare resource represents the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) EpisodeOfCare v1.0 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EpisodeOfCare | 0..* | EpisodeOfCare | This is an abstract profile. Child profiles: NlcoreEpisodeOfCare EpisodeOfCare | |
  comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
   value[x] | 0..1 | string | Comment | |
 episodeOfCareName | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | |
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error | |
| diagnosis | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care | |
  condition | 1..1 | Reference(Condition | zib Problem) | FocusEpisodeOfCare | |
 period | ||||
 start | 0..1 | dateTime | StartDate | |
| end | 0..1 | dateTime | EndDate | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | This is an abstract profile. Child profiles: NlcoreEpisodeOfCare EpisodeOfCare | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
 url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | Comment | |
| episodeOfCareName | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
 diagnosis | Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| condition | Σ | 1..1 | Reference(Condition | zib Problem) | FocusEpisodeOfCare |
| patient | Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| EpisodeOfCare.status | required | EpisodeOfCareStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | This is an abstract profile. Child profiles: NlcoreEpisodeOfCare EpisodeOfCare | |||||
| 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | Comment | |||||
| episodeOfCareName | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| 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 | ||||
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period | 1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type | Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| diagnosis | Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| 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 | ||||
| condition | Σ | 1..1 | Reference(Condition | zib Problem) | FocusEpisodeOfCare | ||||
| role | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient | Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that assumes care | ||||
| period | Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
| 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 | ΣC | 0..1 | dateTime | StartDate | ||||
| end | ΣC | 0..1 | dateTime | EndDate | ||||
| referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team | 0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| EpisodeOfCare.language | preferred | CommonLanguages
| ||||
| EpisodeOfCare.status | required | EpisodeOfCareStatus | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatus | ||||
| EpisodeOfCare.type | example | EpisodeOfCareType | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRole |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | 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() |
This structure is derived from EpisodeOfCare
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | This is an abstract profile. Child profiles: NlcoreEpisodeOfCare EpisodeOfCare | |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| value[x] | 0..1 | string | Comment | |
| episodeOfCareName | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | |
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error | |
| diagnosis | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care | |
| condition | 1..1 | Reference(Condition | zib Problem) | FocusEpisodeOfCare | |
| period | ||||
| start | 0..1 | dateTime | StartDate | |
| end | 0..1 | dateTime | EndDate | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | This is an abstract profile. Child profiles: NlcoreEpisodeOfCare EpisodeOfCare | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | Comment | |
| episodeOfCareName | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
| diagnosis | Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| condition | Σ | 1..1 | Reference(Condition | zib Problem) | FocusEpisodeOfCare |
| patient | Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| EpisodeOfCare.status | required | EpisodeOfCareStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | This is an abstract profile. Child profiles: NlcoreEpisodeOfCare EpisodeOfCare | |||||
| 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | Comment | |||||
| episodeOfCareName | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| 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 | ||||
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period | 1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type | Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| diagnosis | Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| 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 | ||||
| condition | Σ | 1..1 | Reference(Condition | zib Problem) | FocusEpisodeOfCare | ||||
| role | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient | Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that assumes care | ||||
| period | Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
| 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 | ΣC | 0..1 | dateTime | StartDate | ||||
| end | ΣC | 0..1 | dateTime | EndDate | ||||
| referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team | 0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| EpisodeOfCare.language | preferred | CommonLanguages
| ||||
| EpisodeOfCare.status | required | EpisodeOfCareStatus | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatus | ||||
| EpisodeOfCare.type | example | EpisodeOfCareType | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRole |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | 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() |
This structure is derived from EpisodeOfCare
Other representations of profile: CSV, Excel, Schematron