NO Municipal API - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: municipal-service

A EpisodeOfCare profile to represent the NO Municipal standard API.

Usages:

• This Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare		0..*	EpisodeOfCare	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
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.
type	Σ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://finnkode.helsedirektoratet.no/adm/collections/9151
code	Σ	1..1	code	Tjenestetype i helse- og omsorgstjenesten
patient	Σ	1..1	Reference(no-basis-Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(municipal-organization)	Organization that assumes care
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type From the FHIR Standard

Constraints

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare		0..*	EpisodeOfCare	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
type		1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: https://finnkode.helsedirektoratet.no/adm/collections/9151
code		1..1	code	Tjenestetype i helse- og omsorgstjenesten
patient		1..1	Reference(no-basis-Patient)	The patient who is the focus of this episode of care
managingOrganization		1..1	Reference(municipal-organization)	Organization that assumes care
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare		0..*	EpisodeOfCare	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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	Σ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care.
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	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://finnkode.helsedirektoratet.no/adm/collections/9151
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Tjenestetype i helse- og omsorgstjenesten
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
diagnosis	Σ	0..*	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)	Conditions/problems/diagnoses this episode of care is for
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(no-basis-Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(municipal-organization)	Organization that assumes care
period	Σ	0..1	Period	Interval during responsibility is assumed
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

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type From the FHIR Standard
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard

Constraints

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

Summary

Mandatory: 5 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• no-basis-Patient (http://hl7.no/fhir/StructureDefinition/no-basis-Patient)
• municipal-organization (https://github.com/oslokommune/Pasientjournal-API/StructureDefinition/municipal-organization)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare		0..*	EpisodeOfCare	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
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.
type	Σ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://finnkode.helsedirektoratet.no/adm/collections/9151
code	Σ	1..1	code	Tjenestetype i helse- og omsorgstjenesten
patient	Σ	1..1	Reference(no-basis-Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(municipal-organization)	Organization that assumes care
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type From the FHIR Standard

Constraints

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()

Differential View

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare		0..*	EpisodeOfCare	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
type		1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: https://finnkode.helsedirektoratet.no/adm/collections/9151
code		1..1	code	Tjenestetype i helse- og omsorgstjenesten
patient		1..1	Reference(no-basis-Patient)	The patient who is the focus of this episode of care
managingOrganization		1..1	Reference(municipal-organization)	Organization that assumes care
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare		0..*	EpisodeOfCare	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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	Σ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care.
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	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://finnkode.helsedirektoratet.no/adm/collections/9151
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Tjenestetype i helse- og omsorgstjenesten
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
diagnosis	Σ	0..*	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)	Conditions/problems/diagnoses this episode of care is for
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(no-basis-Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(municipal-organization)	Organization that assumes care
period	Σ	0..1	Period	Interval during responsibility is assumed
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

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type From the FHIR Standard
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard

Constraints

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

Summary

Mandatory: 5 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• no-basis-Patient (http://hl7.no/fhir/StructureDefinition/no-basis-Patient)
• municipal-organization (https://github.com/oslokommune/Pasientjournal-API/StructureDefinition/municipal-organization)

Other representations of profile: CSV, Excel, Schematron