This version of the PS-CA Implementation Guide has been superseded by a newer version. Other releases of the PS-CA Implementation Guide may be found on a table on the Home Page of this Project.
Observation Alcohol Use (PS-CA)
Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at SHx Observation: Alcohol Use (PS-CA)
Profile
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
code | S Σ | 1..1 | CodeableConceptPattern | Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. This is a fixed pattern that enforces the presense of a globally shared code to represent this concept. It is meant to mimic the approach used in a number of FHIR implementation guides to constrain tobacco use observations, however minimal existing smoking use observatoin profiles exist - so this code may change if other terminology is identified. Additional codings can be supplied, but at least one of them must follow the pattern below. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "74013-4" } ] }
|
subject | S Σ I | 1..1 | Reference(Patient (PS-CA)) | Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdObservation.subject.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdObservation.subject.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdObservation.subject.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.subject.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | S Σ | 1..1 | Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. Knowing when an observation was deemed true is important to its relevance as well as determining trends. Datatype is constrained to dateTime. If no dateTime is available, the dataAbsentReason extension must be used
| |
effectiveDateTime | dateTime | Data Type | ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdObservation.effective[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
data-absent-reason | S I | 0..1 | Extension(code) | Element IdObservation.effective[x].extension:data-absent-reason effective[x] absence reason Alternate namesextensions, user content DefinitionProvides a reason why the effectiveTime is missing. While the IPS-UV specification considers this a Must Support element, many systems will not have a field within their data dictionaries that directly corresponds to the dataAbsentReason extension, however it is recommended that systems be able to support the use of this extension across a number of clinical profiles where population of the clinical element is crucial to clinical interpretation and use. Further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. Datatype is constrained to Quantity. If Quantity is provided, the expectation is that it be conformant to the QuantityIPS data type which requires the provision of system and code. If no Quantity is available, the dataAbsentReason extension must be used. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | S Σ I | 0..1 | Data Type: Quantity (PS-CA) | Element IdObservation.value[x]:valueQuantity A measured amount using UCUM DefinitionA measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
Extensions
This profile uses the following extensions:
Observation.effective[x]
: data-absent-reason (Must Support)
Key Differences between the IPS-UV and PS-CA
Must Support Differences:
The following elements are considered Must Support in the IPS Observation (SH: alcohol use) profile that are relaxed in this version of the PS-CA profile:
Observation
Cardinality Differences:
There are no cardinality differences between this profile and IPS-UV
Vocabulary Differences:
There are no vocabulary differences between this profile and IPS-UV
Other differences between the IPS and PS-CA Include:
Observation.code
: IPS datatype profiling removedObservation.subject
: reference target changed to Patient (PS-CA) profileObservation.effective[x]:data-absent-reason
- extension slicing corrected
Observation.valueQuantity
: IPS datatype profile replaced with Data Type: Quantity (PS-CA) profile