WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build International flag

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). 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/costateixeira/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: ANC EpisodeOfCare

Official URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/anc-episodeofcare Version: 0.3.0
Draft as of 2024-09-10 Computable Name: ANCEpisodeOfCare

ANC EpisodeOfCare

Usage:

Formal Views of Profile Content

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

This structure is derived from WHOEpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* WHOEpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... diagnosis 1..* BackboneElement The list of diagnosis relevant to this episode of care
.... condition 1..1 Reference(ANC Condition) Conditions/problems/diagnoses this episode of care is for
... patient 1..1 Reference(ANC Patient) The patient who is the focus of this episode of care
... managingOrganization 0..1 Reference(ANC Organization) Organization that assumes care
... team 0..* Reference(ANC CareTeam) Other practitioners facilitating this episode of care

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* WHOEpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... enrolledIn S 0..* canonical() Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣ 1..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
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... type SΣ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care


... diagnosis SΣ 1..* BackboneElement The list of diagnosis relevant to this episode of care
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(ANC Condition) Conditions/problems/diagnoses this episode of care is for
.... role SΣ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (extensible)
.... rank SΣ 0..1 positiveInt Ranking of the diagnosis (for each role type)
... patient SΣ 1..1 Reference(ANC Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that assumes care
... period SΣ 0..1 Period Interval during responsibility is assumed
... careManager S 0..1 Reference(ANC Practitioner | ANC PractitionerRole) Care manager/care coordinator for the patient
... team S 0..* Reference(ANC CareTeam) Other practitioners facilitating this episode of care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typepreferredEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.roleextensibleDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* WHOEpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... 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
... 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
.... enrolledIn S 0..* canonical() Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
.... 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 ?!SΣ 1..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
Example General: http://www.acme.com/identifiers/patient
.... 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)
... status ?!SΣ 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 SΣ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care


... diagnosis SΣ 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 SΣ 1..1 Reference(ANC Condition) Conditions/problems/diagnoses this episode of care is for
.... role SΣ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (extensible)
.... rank SΣ 0..1 positiveInt Ranking of the diagnosis (for each role type)
... patient SΣ 1..1 Reference(ANC Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that assumes care
... period SΣ 0..1 Period Interval during responsibility is assumed
... referralRequest 0..* Reference(ServiceRequest) Originating Referral Request(s)
... careManager S 0..1 Reference(ANC Practitioner | ANC PractitionerRole) Care manager/care coordinator for the patient
... team S 0..* Reference(ANC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typepreferredEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.roleextensibleDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from WHOEpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* WHOEpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... diagnosis 1..* BackboneElement The list of diagnosis relevant to this episode of care
.... condition 1..1 Reference(ANC Condition) Conditions/problems/diagnoses this episode of care is for
... patient 1..1 Reference(ANC Patient) The patient who is the focus of this episode of care
... managingOrganization 0..1 Reference(ANC Organization) Organization that assumes care
... team 0..* Reference(ANC CareTeam) Other practitioners facilitating this episode of care

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* WHOEpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... enrolledIn S 0..* canonical() Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣ 1..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
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... type SΣ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care


... diagnosis SΣ 1..* BackboneElement The list of diagnosis relevant to this episode of care
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(ANC Condition) Conditions/problems/diagnoses this episode of care is for
.... role SΣ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (extensible)
.... rank SΣ 0..1 positiveInt Ranking of the diagnosis (for each role type)
... patient SΣ 1..1 Reference(ANC Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that assumes care
... period SΣ 0..1 Period Interval during responsibility is assumed
... careManager S 0..1 Reference(ANC Practitioner | ANC PractitionerRole) Care manager/care coordinator for the patient
... team S 0..* Reference(ANC CareTeam) Other practitioners facilitating this episode of care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typepreferredEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.roleextensibleDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* WHOEpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... 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
... 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
.... enrolledIn S 0..* canonical() Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
.... 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 ?!SΣ 1..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
Example General: http://www.acme.com/identifiers/patient
.... 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)
... status ?!SΣ 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 SΣ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care


... diagnosis SΣ 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 SΣ 1..1 Reference(ANC Condition) Conditions/problems/diagnoses this episode of care is for
.... role SΣ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (extensible)
.... rank SΣ 0..1 positiveInt Ranking of the diagnosis (for each role type)
... patient SΣ 1..1 Reference(ANC Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that assumes care
... period SΣ 0..1 Period Interval during responsibility is assumed
... referralRequest 0..* Reference(ServiceRequest) Originating Referral Request(s)
... careManager S 0..1 Reference(ANC Practitioner | ANC PractitionerRole) Care manager/care coordinator for the patient
... team S 0..* Reference(ANC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typepreferredEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.roleextensibleDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron