Netherlands - Generic Functions for data exchange Implementation Guide
0.3.0 - ci-build
Netherlands
Netherlands - Generic Functions for data exchange Implementation Guide, published by Stichting Nuts. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nuts-foundation/nl-generic-functions-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/nl-gf-episodeofcare | Version: 0.3.0 | |||
| Draft as of 2026-01-06 | Computable Name: NlGfEpisodeOfCare | |||
An association between a patient and an organization / healthcare provider during which time encounters may occur.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | NlcoreEpisodeOfCare | EpisodeOfCare | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
![]() ![]() ![]() |
N | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..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. |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
![]() ![]() |
Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | nl core Problem) | FocusEpisodeOfCare |
![]() ![]() |
Σ | 1..1 | Reference(Patient | nl core Patient) | The patient who is the focus of this episode of care |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.identifier:AssignedId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 NlcoreEpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | NlcoreEpisodeOfCare | EpisodeOfCare | |
![]() ![]() |
1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: author | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEpisodeOfCare | EpisodeOfCare | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Comment | |||||
![]() ![]() ![]() |
N | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:$this | |||||
![]() ![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
![]() ![]() |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
![]() ![]() ![]() |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | nl core Problem) | FocusEpisodeOfCare | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient | nl core Patient) | The patient who is the focus of this episode of care | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that assumes care | ||||
![]() ![]() |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | StartDate | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | EndDate | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
![]() ![]() |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type | Base | example | Episode of care type | 📦4.0.1 | FHIR Std. |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 NlcoreEpisodeOfCare
Summary
Mandatory: 9 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | NlcoreEpisodeOfCare | EpisodeOfCare | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
![]() ![]() ![]() |
N | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..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. |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
![]() ![]() |
Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | nl core Problem) | FocusEpisodeOfCare |
![]() ![]() |
Σ | 1..1 | Reference(Patient | nl core Patient) | The patient who is the focus of this episode of care |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.identifier:AssignedId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from NlcoreEpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | NlcoreEpisodeOfCare | EpisodeOfCare | |
![]() ![]() |
1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: author | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEpisodeOfCare | EpisodeOfCare | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Comment | |||||
![]() ![]() ![]() |
N | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-EpisodeOfCare.EpisodeOfCareName | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:$this | |||||
![]() ![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
![]() ![]() |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
![]() ![]() ![]() |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | nl core Problem) | FocusEpisodeOfCare | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient | nl core Patient) | The patient who is the focus of this episode of care | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that assumes care | ||||
![]() ![]() |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | StartDate | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | EndDate | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
![]() ![]() |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:AssignedId.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type | Base | example | Episode of care type | 📦4.0.1 | FHIR Std. |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 NlcoreEpisodeOfCare
Summary
Mandatory: 9 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron