OPENHIE.VN.CASE-REPORTING.HIV\Hepatitis Treatment

HIV Case-reporting for Vietnam - candidate draft
0.1.0-test - CI Build

HIV Case-reporting for Vietnam - candidate draft - Local Development build (v0.1.0-test). See the Directory of published versions

Resource Profile: Hepatitis Treatment

Official URL: http://openhie.org/fhir/openhie.vn.case-reporting.hiv/StructureDefinition/hiv-treatment-hepatitis-process				Version: 0.1.0-test
Active as of 2022-03-29		Responsible: OpenHIE	Realm:	Computable Name: HepatitisTreatment

This profile allows to add hepatitis status

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from CarePlan

Summary

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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	External Ids for this plan
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition \| Questionnaire \| Measure \| ActivityDefinition \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	Σ	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	Σ	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal \| plan \| order \| option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	Σ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
title	Σ	0..1	string	Human-friendly name for the care plan
description	Σ	0..1	string	Summary of nature of plan
subject	Σ	1..1	Reference(Patient \| Group)	Who the care plan is for
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	Σ	0..1	Period	Time period plan covers
created	Σ	0..1	dateTime	Date record was first recorded
author	Σ	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who is the designated responsible party
contributor		0..*	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who provided the content of the care plan
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
supportingInfo		0..*	Reference(Resource)	Information considered as part of plan
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	I	0..*	BackboneElement	Action to occur as part of plan
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
outcomeCodeableConcept		0..*	CodeableConcept	Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
outcomeReference		0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
progress		0..*	Annotation	Comments about the activity status/progress
reference	I	0..1	Reference(Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription \| RequestGroup)	Activity details defined in specific resource
detail	I	0..1	BackboneElement	In-line definition of activity
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
kind		0..1	code	Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
instantiatesCanonical		0..*	canonical(PlanDefinition \| ActivityDefinition \| Questionnaire \| Measure \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri		0..*	uri	Instantiates external protocol or definition
code		0..1	CodeableConcept	Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
reasonReference		0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why activity is needed
goal		0..*	Reference(Goal)	Goals this activity relates to
status	?!	1..1	code	not-started \| scheduled \| in-progress \| on-hold \| completed \| cancelled \| stopped \| unknown \| entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
statusReason		0..1	CodeableConcept	Reason for current status
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
scheduled[x]		0..1		When activity is to occur
scheduledTiming			Timing
scheduledPeriod			Period
scheduledString			string
location		0..1	Reference(Location)	Where it should happen
performer		0..*	Reference(Practitioner \| PractitionerRole \| Organization \| RelatedPerson \| Patient \| CareTeam \| HealthcareService \| Device)	Who will be responsible?
product[x]		0..1		What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
productCodeableConcept			CodeableConcept
productReference			Reference(Medication \| Substance)
dailyAmount		0..1	SimpleQuantity	How to consume/day?
quantity		0..1	SimpleQuantity	How much to administer/supply/consume
description		0..1	string	Extra info describing activity to perform
note		0..*	Annotation	Comments about the plan
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
Documentation for this format

This structure is derived from CarePlan

Summary

Differential View

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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	External Ids for this plan
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition \| Questionnaire \| Measure \| ActivityDefinition \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	Σ	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	Σ	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal \| plan \| order \| option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	Σ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
title	Σ	0..1	string	Human-friendly name for the care plan
description	Σ	0..1	string	Summary of nature of plan
subject	Σ	1..1	Reference(Patient \| Group)	Who the care plan is for
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	Σ	0..1	Period	Time period plan covers
created	Σ	0..1	dateTime	Date record was first recorded
author	Σ	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who is the designated responsible party
contributor		0..*	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who provided the content of the care plan
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
supportingInfo		0..*	Reference(Resource)	Information considered as part of plan
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	I	0..*	BackboneElement	Action to occur as part of plan
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
outcomeCodeableConcept		0..*	CodeableConcept	Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
outcomeReference		0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
progress		0..*	Annotation	Comments about the activity status/progress
reference	I	0..1	Reference(Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription \| RequestGroup)	Activity details defined in specific resource
detail	I	0..1	BackboneElement	In-line definition of activity
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
kind		0..1	code	Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
instantiatesCanonical		0..*	canonical(PlanDefinition \| ActivityDefinition \| Questionnaire \| Measure \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri		0..*	uri	Instantiates external protocol or definition
code		0..1	CodeableConcept	Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
reasonReference		0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why activity is needed
goal		0..*	Reference(Goal)	Goals this activity relates to
status	?!	1..1	code	not-started \| scheduled \| in-progress \| on-hold \| completed \| cancelled \| stopped \| unknown \| entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
statusReason		0..1	CodeableConcept	Reason for current status
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
scheduled[x]		0..1		When activity is to occur
scheduledTiming			Timing
scheduledPeriod			Period
scheduledString			string
location		0..1	Reference(Location)	Where it should happen
performer		0..*	Reference(Practitioner \| PractitionerRole \| Organization \| RelatedPerson \| Patient \| CareTeam \| HealthcareService \| Device)	Who will be responsible?
product[x]		0..1		What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
productCodeableConcept			CodeableConcept
productReference			Reference(Medication \| Substance)
dailyAmount		0..1	SimpleQuantity	How to consume/day?
quantity		0..1	SimpleQuantity	How much to administer/supply/consume
description		0..1	string	Extra info describing activity to perform
note		0..*	Annotation	Comments about the plan
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
CarePlan.language	preferred	CommonLanguages Max Binding: AllLanguages
CarePlan.status	required	RequestStatus
CarePlan.intent	required	CarePlanIntent
CarePlan.category	example	CarePlanCategory
CarePlan.activity.outcomeCodeableConcept	example	CarePlanActivityOutcome
CarePlan.activity.detail.kind	required	CarePlanActivityKind
CarePlan.activity.detail.code	example	ProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCode	example	SNOMEDCTClinicalFindings
CarePlan.activity.detail.status	required	CarePlanActivityStatus
CarePlan.activity.detail.product[x]	example	SNOMEDCTMedicationCodes

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CarePlan	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	CarePlan	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	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	CarePlan.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CarePlan.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CarePlan.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CarePlan.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CarePlan.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.replaces	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.intent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.title	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.created	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.author	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.contributor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.careTeam	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.addresses	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.supportingInfo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.goal	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
ele-1	error	CarePlan.activity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CarePlan.activity.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CarePlan.activity.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CarePlan.activity.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CarePlan.activity.outcomeCodeableConcept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.outcomeReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.progress	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.reference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CarePlan.activity.detail.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CarePlan.activity.detail.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CarePlan.activity.detail.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CarePlan.activity.detail.kind	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.goal	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.statusReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.doNotPerform	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.scheduled[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.product[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.dailyAmount	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.quantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.activity.detail.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CarePlan.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ OpenHIE. Package openhie.vn.case-reporting.hiv#0.1.0-test based on FHIR 4.0.1. Generated 2022-03-29
Links: Table of Contents | QA Report | Issues | Version History | |