StructureDefinition/ObservationWomenHealth - FHIR Implementation Guide for ABDM v6.0.0

FHIR Implementation Guide for ABDM
6.0.0 - active India flag

This page is part of the FHIR Implementation Guide for ABDM (v6.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: StructureDefinition/ObservationWomenHealth

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/ObservationWomenHealth				Version: 6.0.0
Draft as of 2024-01-24				Computable Name: ObservationWomenHealth

This profile sets minimum expectations for ObservationWomenHealth to record, search, and fetch the details of women’s health.

This profile sets minimum expectations for the ObservationWomenHealth to record, search, and fetch the details of women’s health. It identifies the mandatory core elements, vocabularies, and value sets which SHALL be present in the Observation resource when using this profile.

In the Observation resource, the type of value[x] and the unit should be defined in accordance with the code defined in Observation.code element (either LOINC or SNOMED CT). If LOINC code is not associated with the unit, then the type of value can be selected as Quantity, String, or CodeableConcept depending on the context.

E.g. If Observation.code.coding.code is 42798-9 (LOINC Code for Age at menarche), then value[x] type should be Quantity with unit as per the LOINC Specification.

Examples

Usage:

Refer to this Resource Profile: WellnessRecord
Examples for this Resource Profile: Observation/example-18, Observation/example-19, Observation/example-20, Observation/example-21 and Observation/example-23

Formal Views of Profile Content

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

This structure is derived from Observation

Name	Card.	Type	Description & Constraints
Observation	0..*	Observation	Measurements and simple assertions
basedOn	0..*	Reference(DeviceRequest \| CarePlan \| ImmunizationRecommendation \| ServiceRequest \| MedicationRequest \| NutritionOrder)	Fulfills plan, proposal or order
code	1..1	CodeableConcept	Type of observation (code / type) Binding: Women Health (extensible): Codes identifying names of women health observations.
value[x]	0..1		Actual result
valueQuantity		Quantity
valueString		string
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Observation.code	extensible	WomenHealth `https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-women-health` from this IG

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
basedOn	Σ	0..*	Reference(DeviceRequest \| CarePlan \| ImmunizationRecommendation \| ServiceRequest \| MedicationRequest \| NutritionOrder)	Fulfills plan, proposal or order
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
code	SΣ	1..1	CodeableConcept	Type of observation (code / type) Binding: Women Health (extensible): Codes identifying names of women health observations.
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:LOINC	Σ	0..*	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
coding:SNOMEDCT	Σ	0..*	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
text	SΣ	0..1	string	Plain text representation of the concept
value[x]	SΣC	0..1		Actual result
valueQuantity			Quantity
valueString			string
hasMember	SΣ	0..*	Reference(QuestionnaireResponse \| MolecularSequence \| Observation)	Related resource that belongs to the Observation group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Observation.status	required	ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` from the FHIR Standard
Observation.code	extensible	WomenHealth `https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-women-health` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	Observation	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	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	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()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Description & Constraints

Observation

C

0..*

Observation

Measurements and simple assertions

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Observation.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Observation.status

required

ObservationStatus

http://hl7.org/fhir/ValueSet/observation-status|4.0.1

from the FHIR Standard

Observation.category

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

from the FHIR Standard

Observation.code

extensible

WomenHealth

https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-women-health

from this IG

Observation.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Observation.bodySite

example

SNOMEDCTBodyStructures

http://hl7.org/fhir/ValueSet/body-site

from the FHIR Standard

Observation.method

example

ObservationMethods

http://hl7.org/fhir/ValueSet/observation-methods

from the FHIR Standard

Observation.referenceRange.type

preferred

ObservationReferenceRangeMeaningCodes

http://hl7.org/fhir/ValueSet/referencerange-meaning

from the FHIR Standard

Observation.referenceRange.appliesTo

example

ObservationReferenceRangeAppliesToCodes

http://hl7.org/fhir/ValueSet/referencerange-appliesto

from the FHIR Standard

Observation.component.code

example

LOINCCodes (a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

from the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	Observation	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	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	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()
obs-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Observation

Name	Card.	Type	Description & Constraints
Observation	0..*	Observation	Measurements and simple assertions
basedOn	0..*	Reference(DeviceRequest \| CarePlan \| ImmunizationRecommendation \| ServiceRequest \| MedicationRequest \| NutritionOrder)	Fulfills plan, proposal or order
code	1..1	CodeableConcept	Type of observation (code / type) Binding: Women Health (extensible): Codes identifying names of women health observations.
value[x]	0..1		Actual result
valueQuantity		Quantity
valueString		string
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Observation.code	extensible	WomenHealth `https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-women-health` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
basedOn	Σ	0..*	Reference(DeviceRequest \| CarePlan \| ImmunizationRecommendation \| ServiceRequest \| MedicationRequest \| NutritionOrder)	Fulfills plan, proposal or order
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
code	SΣ	1..1	CodeableConcept	Type of observation (code / type) Binding: Women Health (extensible): Codes identifying names of women health observations.
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:LOINC	Σ	0..*	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
coding:SNOMEDCT	Σ	0..*	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
text	SΣ	0..1	string	Plain text representation of the concept
value[x]	SΣC	0..1		Actual result
valueQuantity			Quantity
valueString			string
hasMember	SΣ	0..*	Reference(QuestionnaireResponse \| MolecularSequence \| Observation)	Related resource that belongs to the Observation group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Observation.status	required	ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` from the FHIR Standard
Observation.code	extensible	WomenHealth `https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-women-health` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	Observation	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	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	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()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Snapshot View

Description & Constraints

Observation

C

0..*

Observation

Measurements and simple assertions

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Observation.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Observation.status

required

ObservationStatus

http://hl7.org/fhir/ValueSet/observation-status|4.0.1

from the FHIR Standard

Observation.category

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

from the FHIR Standard

Observation.code

extensible

WomenHealth

https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-women-health

from this IG

Observation.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Observation.bodySite

example

SNOMEDCTBodyStructures

http://hl7.org/fhir/ValueSet/body-site

from the FHIR Standard

Observation.method

example

ObservationMethods

http://hl7.org/fhir/ValueSet/observation-methods

from the FHIR Standard

Observation.referenceRange.type

preferred

ObservationReferenceRangeMeaningCodes

http://hl7.org/fhir/ValueSet/referencerange-meaning

from the FHIR Standard

Observation.referenceRange.appliesTo

example

ObservationReferenceRangeAppliesToCodes

http://hl7.org/fhir/ValueSet/referencerange-appliesto

from the FHIR Standard

Observation.component.code

example

LOINCCodes (a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

from the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	Observation	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	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	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()
obs-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel, Schematron

<prev

top

next>

IG © 2020+ National Resource Center for EHR Standards. Package ndhm.in#6.0.0 based on FHIR 4.0.1. Generated 2024-01-24
Links: Table of Contents | QA Report | Version History |