BSeR: Bidirectional Services_eReferral - Local Development build (v2.0.0-connectathon). See the Directory of published versions

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

Resource Profile: BSeR Tobacco Use Cessation Feedback Medication

A statement regarding the use of a tobacco cessation medication. Medication.status indicates active or inactive use of the medication indicated in medication.code.

Usage:

• Refer to this Resource Profile: BSeR Referral Feedback Composition
• Examples for this Resource Profile: Medication/medication-bser-tobacco-use-cessation-feedback-eve-everywoman

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 USCoreMedicationProfile

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	USCoreMedicationProfile	Definition of a Medication
code		1..1	CodeableConcept	Codes that identify this medication Binding: FDA Approved Tobacco Cessation Medications (extensible)
status		1..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Medication.code	extensible	FDA Approved Tobacco Cessation Medications
Medication.status	required	Medication Status Codes

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	USCoreMedicationProfile	Definition of a Medication
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: FDA Approved Tobacco Cessation Medications (extensible)
status	?!Σ	1..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Medication.code	extensible	FDA Approved Tobacco Cessation Medications
Medication.status	required	Medication Status Codes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	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
Medication		0..*	USCoreMedicationProfile	Definition of a Medication
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 for this medication
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: FDA Approved Tobacco Cessation Medications (extensible)
status	?!Σ	1..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required)
manufacturer	Σ	0..1	Reference(Organization)	Manufacturer of the item
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		0..*	BackboneElement	Active or inactive ingredient
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
item[x]		1..1		The actual ingredient or content
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | Medication)
isActive		0..1	boolean	Active ingredient indicator
strength		0..1	Ratio	Quantity of ingredient present
batch		0..1	BackboneElement	Details about packaged medications
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
lotNumber		0..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Medication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Medication.code	extensible	FDA Approved Tobacco Cessation Medications
Medication.status	required	Medication Status Codes
Medication.form	example	SNOMEDCTFormCodes

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 USCoreMedicationProfile

Summary

Mandatory: 2 elements

Differential View

This structure is derived from USCoreMedicationProfile

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	USCoreMedicationProfile	Definition of a Medication
code		1..1	CodeableConcept	Codes that identify this medication Binding: FDA Approved Tobacco Cessation Medications (extensible)
status		1..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Medication.code	extensible	FDA Approved Tobacco Cessation Medications
Medication.status	required	Medication Status Codes

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	USCoreMedicationProfile	Definition of a Medication
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: FDA Approved Tobacco Cessation Medications (extensible)
status	?!Σ	1..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Medication.code	extensible	FDA Approved Tobacco Cessation Medications
Medication.status	required	Medication Status Codes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	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
Medication		0..*	USCoreMedicationProfile	Definition of a Medication
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 for this medication
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: FDA Approved Tobacco Cessation Medications (extensible)
status	?!Σ	1..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required)
manufacturer	Σ	0..1	Reference(Organization)	Manufacturer of the item
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		0..*	BackboneElement	Active or inactive ingredient
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
item[x]		1..1		The actual ingredient or content
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | Medication)
isActive		0..1	boolean	Active ingredient indicator
strength		0..1	Ratio	Quantity of ingredient present
batch		0..1	BackboneElement	Details about packaged medications
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
lotNumber		0..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Medication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Medication.code	extensible	FDA Approved Tobacco Cessation Medications
Medication.status	required	Medication Status Codes
Medication.form	example	SNOMEDCTFormCodes

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 USCoreMedicationProfile

Summary

Mandatory: 2 elements

Other representations of profile: CSV, Excel, Schematron