Vital Records Common Library (VRCL) STU2-ballot
2.0.0 - trial-use
Vital Records Common Library (VRCL) STU2-ballot
2.0.0 - trial-use
Vital Records Common Library (VRCL) STU2-ballot, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Observation-education-level-vr | Version: 2.0.0 | |||
| Active as of 2024-03-21 | Computable Name: ObservationEducationLevelVitalRecords | |||
The highest degree or level of schooling completed by the decedent or parent. This profile is designed to supplant similar profile in VRDR
| Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
|---|---|---|---|---|---|---|
| Natality | 32 | Mother's Education | MEDUC | value, code=57712-2 (Highest level of education Mother) |
codeable | ValueSetEducationLevelVitalRecords |
| Natality | 33 | Mother's Education--Edit Flag | MEDUC_BYPASS | value.extension[bypassEditFlag].value, code=57712-2 (Highest level of education Mother) |
codeable | ValueSetEditBypass01234VitalRecords, See Handling of edit flags |
| Natality | 78 | Father's Education | FEDUC | value, code=87300-0 (Highest level of education Father) |
codeable | ValueSetEducationLevelVitalRecords |
| Natality | 79 | Father's Education--Edit Flag | FEDUC_BYPASS | value.extension[bypassEditFlag].value, code=87300-0 (Highest level of education Father) |
codeable | ValueSetEditBypass01234VitalRecords, See Handling of edit flags |
| Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
|---|---|---|---|---|---|---|
| Fetal Death | 32 | Mother's Education | MEDUC | value, code=57712-2 (Highest level of education Mother) |
codeable | ValueSetEducationLevelVitalRecords |
| Fetal Death | 33 | Mother's Education--Edit Flag | MEDUC_BYPASS | value.extension[bypassEditFlag].value, code=57712-2 (Highest level of education Mother) |
codeable | ValueSetEditBypass01234VitalRecords, See Handling of edit flags |
| Fetal Death | 283 | Father's Education | FEDUC | value, code=87300-0 (Highest level of education Father) |
codeable | ValueSetEducationLevelVitalRecords |
| Fetal Death | 284 | Father's Education--Edit Flag | FEDUC_BYPASS | value.extension[bypassEditFlag].value, code=87300-0 (Highest level of education Father) |
codeable | ValueSetEditBypass01234VitalRecords, See Handling of edit flags |
| Item # | Form Field | FHIR Profile Field | Reference |
|---|---|---|---|
| 20 | Mother’s Education | code | Certificate of Live Birth |
| 23 | Father’s Education | code | Certificate of Live Birth |
| 8 | What is the highest level of schooling that you will have completed at the time of delivery? | code | Mothers Worksheet for Child’s Birth Certificate |
| 22 | What is the highest level of schooling that the father will have completed at the time of delivery? | code | Mothers Worksheet for Child’s Birth Certificate |
| 19 | Mother’s Education | code | Report of Fetal Death |
| 8 | What is the highest level of schooling that you have completed at the time of delivery? | code | Patient’s Worksheet for the Report of Fetal Death |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | Measurements and simple assertions | |
  code | 1..1 | CodeableConcept | Persons for whom education level can be reported. Binding: Education Level Person Vital Records (required): EducationLevelPerson | |
 subject | 1..1 | Reference(Patient - Vital Records) | This is the subject of the report, not the parent | |
| focus | 0..1 | Reference(Patient - Mother Vital Records | Related Person - Parent Vital Records) | The RelatedPerson or Patient record for the parent | |
  value[x] | 1..1 | CodeableConcept | The collection of education levels used for vital records reporting. Binding: Education Level Vital Records (required): Vital Records Education Level (NCHS) | |
  bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
 value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 01234 Vital Records (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.code | required | ValueSetEducationLevelPersonVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-person-vrfrom this IG | |
| Observation.value[x] | required | ValueSetEducationLevelVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-vrfrom this IG | |
| Observation.value[x].extension:bypassEditFlag.value[x] | required | ValueSetEditBypass01234VitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/valueset-edit-bypass-01234-vrfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
 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 | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code | Σ | 1..1 | CodeableConcept | Persons for whom education level can be reported. Binding: Education Level Person Vital Records (required): EducationLevelPerson |
| subject | Σ | 1..1 | Reference(Patient - Vital Records) | This is the subject of the report, not the parent |
| focus | Σ | 0..1 | Reference(Patient - Mother Vital Records | Related Person - Parent Vital Records) | The RelatedPerson or Patient record for the parent |
| value[x] | ΣC | 1..1 | CodeableConcept | The collection of education levels used for vital records reporting. Binding: Education Level Vital Records (required): Vital Records Education Level (NCHS) |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 01234 Vital Records (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.code | required | ValueSetEducationLevelPersonVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-person-vrfrom this IG | |
| Observation.value[x] | required | ValueSetEducationLevelVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-vrfrom this IG | |
| Observation.value[x].extension:bypassEditFlag.value[x] | required | ValueSetEditBypass01234VitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/valueset-edit-bypass-01234-vrfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
| 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.
| |||||
| 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 observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code | Σ | 1..1 | CodeableConcept | Persons for whom education level can be reported. Binding: Education Level Person Vital Records (required): EducationLevelPerson | ||||
| subject | Σ | 1..1 | Reference(Patient - Vital Records) | This is the subject of the report, not the parent | ||||
| focus | Σ | 0..1 | Reference(Patient - Mother Vital Records | Related Person - Parent Vital Records) | The RelatedPerson or Patient record for the parent | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
  effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
 effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effectiveTiming | Timing | |||||||
 effectiveInstant | instant | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | ΣC | 1..1 | CodeableConcept | The collection of education levels used for vital records reporting. Binding: Education Level Vital Records (required): Vital Records Education Level (NCHS) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 01234 Vital Records (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
| 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 | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component | Σ | 0..* | BackboneElement | Component results | ||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | required | ValueSetEducationLevelPersonVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-person-vrfrom this IG | ||||
| Observation.value[x] | required | ValueSetEducationLevelVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-vrfrom this IG | ||||
| Observation.value[x].extension:bypassEditFlag.value[x] | required | ValueSetEditBypass01234VitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/valueset-edit-bypass-01234-vrfrom this IG | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
This structure is derived from Observation
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Observation | Measurements and simple assertions | |
| code | 1..1 | CodeableConcept | Persons for whom education level can be reported. Binding: Education Level Person Vital Records (required): EducationLevelPerson | |
| subject | 1..1 | Reference(Patient - Vital Records) | This is the subject of the report, not the parent | |
| focus | 0..1 | Reference(Patient - Mother Vital Records | Related Person - Parent Vital Records) | The RelatedPerson or Patient record for the parent | |
| value[x] | 1..1 | CodeableConcept | The collection of education levels used for vital records reporting. Binding: Education Level Vital Records (required): Vital Records Education Level (NCHS) | |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 01234 Vital Records (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.code | required | ValueSetEducationLevelPersonVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-person-vrfrom this IG | |
| Observation.value[x] | required | ValueSetEducationLevelVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-vrfrom this IG | |
| Observation.value[x].extension:bypassEditFlag.value[x] | required | ValueSetEditBypass01234VitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/valueset-edit-bypass-01234-vrfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
| 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 | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code | Σ | 1..1 | CodeableConcept | Persons for whom education level can be reported. Binding: Education Level Person Vital Records (required): EducationLevelPerson |
| subject | Σ | 1..1 | Reference(Patient - Vital Records) | This is the subject of the report, not the parent |
| focus | Σ | 0..1 | Reference(Patient - Mother Vital Records | Related Person - Parent Vital Records) | The RelatedPerson or Patient record for the parent |
| value[x] | ΣC | 1..1 | CodeableConcept | The collection of education levels used for vital records reporting. Binding: Education Level Vital Records (required): Vital Records Education Level (NCHS) |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 01234 Vital Records (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.code | required | ValueSetEducationLevelPersonVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-person-vrfrom this IG | |
| Observation.value[x] | required | ValueSetEducationLevelVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-vrfrom this IG | |
| Observation.value[x].extension:bypassEditFlag.value[x] | required | ValueSetEditBypass01234VitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/valueset-edit-bypass-01234-vrfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
| 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.
| |||||
| 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 observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code | Σ | 1..1 | CodeableConcept | Persons for whom education level can be reported. Binding: Education Level Person Vital Records (required): EducationLevelPerson | ||||
| subject | Σ | 1..1 | Reference(Patient - Vital Records) | This is the subject of the report, not the parent | ||||
| focus | Σ | 0..1 | Reference(Patient - Mother Vital Records | Related Person - Parent Vital Records) | The RelatedPerson or Patient record for the parent | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effectiveTiming | Timing | |||||||
| effectiveInstant | instant | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | ΣC | 1..1 | CodeableConcept | The collection of education levels used for vital records reporting. Binding: Education Level Vital Records (required): Vital Records Education Level (NCHS) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 01234 Vital Records (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
| 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 | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component | Σ | 0..* | BackboneElement | Component results | ||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | required | ValueSetEducationLevelPersonVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-person-vrfrom this IG | ||||
| Observation.value[x] | required | ValueSetEducationLevelVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-education-level-vrfrom this IG | ||||
| Observation.value[x].extension:bypassEditFlag.value[x] | required | ValueSetEditBypass01234VitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/valueset-edit-bypass-01234-vrfrom this IG | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
This structure is derived from Observation
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Public Health. Package hl7.fhir.us.vr-common-library#2.0.0 based on FHIR 4.0.1. Generated 2024-03-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change