ObservationBodyWeightRelative

Introduction

The ObservationBodyWeightRelative profile represents the vital parameter body weight and is a profile created from the resource Observation. Body weight relative is an observation concerning body weight of a persons biological mother or father. The profile is derived from the standard FHIR profile Body weight which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The profile ObservationBodyWeightRelative is used for communicating an entry of a patients relative's body weight, by sending a value in the element observation.value.

Read Body Weight for Relative

Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handeled outside the API.

Specific Rules and Limitations

Type Description
Rule This API should not be used to transfer data between caregivers.
Rule If the performer is Patient, the subject should be the same as given performer.

Profile Overview

ObservationGCBodyWeightRelative

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..0Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..0Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
encounterΣ I0..1Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..0instant
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
id0..1string
extensionI0..*Extension
valueS Σ1..1decimal
comparatorΣ ?!0..1codeBinding
unitS Σ1..1string
systemS Σ I1..1uriFixed Value
codeS Σ1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
interpretation0..0CodeableConceptBinding
note0..*Annotation
bodySite0..0CodeableConcept
method0..0CodeableConcept
specimenI0..0Reference(Specimen)
deviceI0..0Reference(Device | DeviceMetric)
hasMemberΣ I0..0Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile)
derivedFromΣ I0..0Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile)

Statuses

User action in COSMIC FHIR status Status in COSMIC
Saved by signer preliminary ReadyToSign
Signed by signer final SignedComplete
Signed with counter signer and/or attester final Sign
Saved by secretary preliminary NotReadyToSign
Ready to sign by secretary preliminary ReadyToSign
Entered by patient final CompleteNonSignable
Parameter from a device final CompleteNonSignable
Correcting a previously signed parameter amended Resign
Remove a not signed parameter entered-in-error Deleted/Removed
Invalidate a signed parameter entered-in-error InvalidateComplete
Invalidate a parameter from a device or patient entered-in-error InvalidateComplete

Terminology Bindings

The ObservationBodyWeightRelative profile is sliced on Observation.code.coding. The first slice is mandatory and fixed to the LOINC code 29463-7, this is inherited from the body weight base profile, BodyWeight.

The second slice on Observation.code.coding is fixed and inherited from the ObservationBodyWeightCore profile. Since it doesn't support any code, consumers can't use it.

The third slice on Observation.code.coding is fixed to a value set of Snomed CT concepts 72681000052105 | Weight of the biological father | & 72691000052107 | Weight of the biological mother |.

Supported Operations

HTTP Methods

Method Description
GET Used to get or search for registrations of Body weight for relative

Query Operations

Search Parameters

Parameter Format Mandatory Comment
code token No SNOMED CT code of the observation type
patient reference No The subject that the observation is about (if patient). The reference can be a literal reference ex: subject=1 or a Business identifier as well.ex: subject.identifier=urn:oid:1.2.752.129.2.1.3.1|20200109-6078

Supported Queries

  1. GET [baseURL]/Observation/?search?patient=&code= (Search)

Supported SearchInclude Operations

No supported parameters

Supported RevInclude Operations

No supported parameters

Error Codes

In the table below, a few error messages specific for observations are listed.

Code Description Comment
400 "Subject and Performer Patient references does not match."
400 "The date time: < date > is invalid" the dateTime must contain a time component