HIV Case-Based Surveillance, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/openhie/HIV-CBS and changes regularly. See the Directory of published versions

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

Resource Profile: Patient Enrollment Type

This profile is used to enrol the patient into HIV care.

Usage:

• Examples for this Resource Profile: EpisodeOfCare/HIVEpisodeOfCareExample

Formal Views of Profile Content

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

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

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints
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
Slices for identifier		1..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open At End by pattern:system
identifier:PI		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: PI
system		1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id
value		1..1	string	The value that is unique
diagnosis		1..*	BackboneElement	The list of diagnosis relevant to this episode of care
managingOrganization		1..1	Reference(Organization)	Organization that assumes care
period		1..1	Period	Interval during responsibility is assumed
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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
Slices for identifier		1..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open At End by pattern:system
identifier:PI		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care.
diagnosis	Σ	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)	Conditions/problems/diagnoses this episode of care is for
patient	Σ	1..1	Reference(Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	Organization that assumes care
period	Σ	1..1	Period	Interval during responsibility is assumed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
EpisodeOfCare.identifier:PI.use	required	IdentifierUse
EpisodeOfCare.status	required	EpisodeOfCareStatus

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

Name	Flags	Card.	Type	Description & Constraints
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
Slices for identifier		1..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open At End by pattern:system
identifier:PI		1..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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: PI
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
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id
value	Σ	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	?!Σ	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	Σ	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)	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(Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	Organization that assumes care
period	Σ	1..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
EpisodeOfCare.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.identifier:PI.use	required	IdentifierUse
EpisodeOfCare.identifier:PI.type	extensible	Identifier Type Codes
EpisodeOfCare.status	required	EpisodeOfCareStatus
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus
EpisodeOfCare.type	example	EpisodeOfCareType
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 7 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

• The element EpisodeOfCare.identifier is sliced based on the value of pattern:system (Open at End)

Differential View

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints
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
Slices for identifier		1..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open At End by pattern:system
identifier:PI		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: PI
system		1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id
value		1..1	string	The value that is unique
diagnosis		1..*	BackboneElement	The list of diagnosis relevant to this episode of care
managingOrganization		1..1	Reference(Organization)	Organization that assumes care
period		1..1	Period	Interval during responsibility is assumed
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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
Slices for identifier		1..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open At End by pattern:system
identifier:PI		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care.
diagnosis	Σ	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)	Conditions/problems/diagnoses this episode of care is for
patient	Σ	1..1	Reference(Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	Organization that assumes care
period	Σ	1..1	Period	Interval during responsibility is assumed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
EpisodeOfCare.identifier:PI.use	required	IdentifierUse
EpisodeOfCare.status	required	EpisodeOfCareStatus

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
Slices for identifier		1..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open At End by pattern:system
identifier:PI		1..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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: PI
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
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id
value	Σ	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	?!Σ	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	Σ	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)	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(Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	Organization that assumes care
period	Σ	1..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
EpisodeOfCare.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.identifier:PI.use	required	IdentifierUse
EpisodeOfCare.identifier:PI.type	extensible	Identifier Type Codes
EpisodeOfCare.status	required	EpisodeOfCareStatus
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus
EpisodeOfCare.type	example	EpisodeOfCareType
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 7 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

• The element EpisodeOfCare.identifier is sliced based on the value of pattern:system (Open at End)

Other representations of profile: CSV, Excel, Schematron