WHO SMART Guidelines - HIV - Local Development build (v0.3.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: HIV Prep Active ( Experimental )

A medication statement describing a patient on active PrEP

Usage:

• This Resource 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.

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

This structure is derived from MedicationStatement

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatement	Record of medication being taken by a patient
Slices for medication[x]		1..1	CodeableConcept, Reference(Medication)	What medication was taken Slice: Unordered, Open by type:$this
medication[x]:medicationCodeableConcept		0..1	CodeableConcept	What medication was taken Binding: PrEP product prescribed ValueSet (required)
reasonCode		0..*	CodeableConcept	Reason for why the medication is being/was taken Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://smart.who.int/hiv/CodeSystem/HIVConcepts
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIV.C.DE76
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationStatement.medication[x]:medicationCodeableConcept	required	HIVCDE80 http://smart.who.int/hiv/ValueSet/HIV.C.DE80 from this IG

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatement	Record of medication being taken by a patient
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	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
Slices for medication[x]	Σ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	What medication was taken Binding: PrEP product prescribed ValueSet (required)
subject	Σ	1..1	Reference(Patient | Group)	Who is/was taking the medication
reasonCode		0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://smart.who.int/hiv/CodeSystem/HIVConcepts
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIV.C.DE76
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	required	HIVCDE80 http://smart.who.int/hiv/ValueSet/HIV.C.DE80 from this IG
MedicationStatement.reasonCode	example	Pattern: HIV.C.DE76 http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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
MedicationStatement		0..*	MedicationStatement	Record of medication being taken by a patient
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	External identifier
basedOn	Σ	0..*	Reference(MedicationRequest | CarePlan | ServiceRequest)	Fulfils plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)	Part of referenced event
status	?!Σ	1..1	code	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
statusReason		0..*	CodeableConcept	Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
category	Σ	0..1	CodeableConcept	Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
Slices for medication[x]	Σ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	What medication was taken Binding: PrEP product prescribed ValueSet (required)
subject	Σ	1..1	Reference(Patient | Group)	Who is/was taking the medication
context	Σ	0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with MedicationStatement
effective[x]	Σ	0..1		The date/time or interval when the medication is/was/will be taken
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	Σ	0..1	dateTime	When the statement was asserted?
informationSource		0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)	Person or organization that provided the information about the taking of this medication
derivedFrom		0..*	Reference(Resource)	Additional supporting information
reasonCode		0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://smart.who.int/hiv/CodeSystem/HIVConcepts
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIV.C.DE76
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
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition or observation that supports why the medication is being/was taken
note		0..*	Annotation	Further information about the statement
dosage		0..*	Dosage	Details of how medication is/was taken or should be taken
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MedicationStatement.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard
MedicationStatement.statusReason	example	SNOMEDCTDrugTherapyStatusCodes http://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard
MedicationStatement.category	preferred	Medication usage category codes http://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	required	HIVCDE80 http://smart.who.int/hiv/ValueSet/HIV.C.DE80 from this IG
MedicationStatement.reasonCode	example	Pattern: HIV.C.DE76 http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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 MedicationStatement

Summary

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MedicationStatement.medication[x]

Differential View

This structure is derived from MedicationStatement

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatement	Record of medication being taken by a patient
Slices for medication[x]		1..1	CodeableConcept, Reference(Medication)	What medication was taken Slice: Unordered, Open by type:$this
medication[x]:medicationCodeableConcept		0..1	CodeableConcept	What medication was taken Binding: PrEP product prescribed ValueSet (required)
reasonCode		0..*	CodeableConcept	Reason for why the medication is being/was taken Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://smart.who.int/hiv/CodeSystem/HIVConcepts
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIV.C.DE76
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationStatement.medication[x]:medicationCodeableConcept	required	HIVCDE80 http://smart.who.int/hiv/ValueSet/HIV.C.DE80 from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatement	Record of medication being taken by a patient
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	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
Slices for medication[x]	Σ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	What medication was taken Binding: PrEP product prescribed ValueSet (required)
subject	Σ	1..1	Reference(Patient | Group)	Who is/was taking the medication
reasonCode		0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://smart.who.int/hiv/CodeSystem/HIVConcepts
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIV.C.DE76
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	required	HIVCDE80 http://smart.who.int/hiv/ValueSet/HIV.C.DE80 from this IG
MedicationStatement.reasonCode	example	Pattern: HIV.C.DE76 http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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
MedicationStatement		0..*	MedicationStatement	Record of medication being taken by a patient
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	External identifier
basedOn	Σ	0..*	Reference(MedicationRequest | CarePlan | ServiceRequest)	Fulfils plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)	Part of referenced event
status	?!Σ	1..1	code	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
statusReason		0..*	CodeableConcept	Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
category	Σ	0..1	CodeableConcept	Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
Slices for medication[x]	Σ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	What medication was taken Binding: PrEP product prescribed ValueSet (required)
subject	Σ	1..1	Reference(Patient | Group)	Who is/was taking the medication
context	Σ	0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with MedicationStatement
effective[x]	Σ	0..1		The date/time or interval when the medication is/was/will be taken
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	Σ	0..1	dateTime	When the statement was asserted?
informationSource		0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)	Person or organization that provided the information about the taking of this medication
derivedFrom		0..*	Reference(Resource)	Additional supporting information
reasonCode		0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://smart.who.int/hiv/CodeSystem/HIVConcepts
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIV.C.DE76
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
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition or observation that supports why the medication is being/was taken
note		0..*	Annotation	Further information about the statement
dosage		0..*	Dosage	Details of how medication is/was taken or should be taken
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MedicationStatement.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard
MedicationStatement.statusReason	example	SNOMEDCTDrugTherapyStatusCodes http://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard
MedicationStatement.category	preferred	Medication usage category codes http://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	required	HIVCDE80 http://smart.who.int/hiv/ValueSet/HIV.C.DE80 from this IG
MedicationStatement.reasonCode	example	Pattern: HIV.C.DE76 http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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 MedicationStatement

Summary

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MedicationStatement.medication[x]

Other representations of profile: CSV, Excel, Schematron