Module health.fhir.r4.uscore501

ballerinax/health.fhir.r4.uscore501 Ballerina library

1.3.1

FHIR R4 US Core Implementation Guide - 5.0.1 - STU5 Release US

Sample Usage

This section focuses on samples depicting how to use this package to implement FHIR related integrations

Prerequisites

Install Ballerina 2201.6.0 or later

1. Parse JSON FHIR resource to FHIR resource model

Sample below is using the Patient resource in health.fhir.r4.uscore501 package.


import ballerina/log;
import ballerinax/health.fhir.r4.uscore501;
import ballerinax/health.fhir.r4.parser;

public function main() {
    json patientPayload = {
        "resourceType": "Patient",
        "id": "example-patient",
        "text": {
            "status": "generated",
            "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">John Doe</div>"
        },
        "identifier": [
            {
                "system": "http://example.com/patient-ids",
                "value": "12345"
            }
        ],
        "extension": [
            {
                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/v3/Race",
                            "code": "2106-3",
                            "display": "White"
                        }
                    ]
                }
            }
        ],
        "name": [
            {
                "use": "official",
                "family": "Doe",
                "given": [
                    "John"
                ]
            }
        ],
        "gender": "male",
        "birthDate": "2000-01-01"
    };

    do {
        anydata parsedResult = check parser:parse(patientPayload, uscore501:USCorePatientProfile);
        uscore501:USCorePatientProfile patientModel = check parsedResult.ensureType();
        log:printInfo(string `Patient name : ${patientModel.name[0].toString()}`);
    } on fail error parseError {
    	log:printError(string `Error occurred while parsing : ${parseError.message()}`, parseError);
    }
}

2. Creating FHIR Resource models and serializing to JSON wire formats


import ballerina/log;
import ballerina/time;
import ballerinax/health.fhir.r4.uscore501;
import ballerinax/health.fhir.r4;

public function main() {
    uscore501:USCorePatientProfile patient = {
        meta: {
            lastUpdated: time:utcToString(time:utcNow()),
            profile: [uscore501:PROFILE_BASE_USCOREPATIENTPROFILE]
        },
        active: true,
        name: [
            {
                family: "Doe",
                given: ["Jhon"],
                use: uscore501:CODE_USE_OFFICIAL,
                prefix: ["Mr"]
            }
        ],
        address: [
            {
                line: ["652 S. Lantern Dr."],
                city: "New York",
                country: "United States",
                postalCode: "10022",
                'type: uscore501:CODE_TYPE_PHYSICAL,
                use: uscore501:CODE_USE_HOME
            }
        ],
        identifier: [],
        gender: uscore501:CODE_GENDER_MALE
    };
    r4:FHIRResourceEntity fhirEntity = new(patient);
    // Serialize FHIR resource record to Json payload
    json|r4:FHIRSerializerError jsonResult = fhirEntity.toJson();
    if jsonResult is json {
        log:printInfo(string `Patient resource JSON payload : ${jsonResult.toJsonString()}`);
    } else {
        log:printError(string `Error occurred while serializing to JSON payload : ${jsonResult.message()}`, jsonResult);
    }
}

Functions

initialize

Isolated Function

function initialize()

This empty function is used to initialize the module by other modules/packages.

Constants

health.fhir.r4.uscore501: PROFILE_BASE_USCOREALLERGYINTOLERANCE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBLOODPRESSUREPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBMIPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBODYHEIGHTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBODYTEMPERATUREPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBODYWEIGHTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight"

health.fhir.r4.uscore501: PROFILE_BASE_USCORECAREPLANPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"

health.fhir.r4.uscore501: PROFILE_BASE_USCORECARETEAM

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"

health.fhir.r4.uscore501: PROFILE_BASE_USCORECONDITION

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"

health.fhir.r4.uscore501: PROFILE_BASE_USCORECONDITIONENCOUNTERDIAGNOSISPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis"

health.fhir.r4.uscore501: PROFILE_BASE_USCORECONDITIONPROBLEMSHEALTHCONCERNSPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREDOCUMENTREFERENCEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREENCOUNTERPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREGOALPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREHEADCIRCUMFERENCEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREHEARTRATEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREIMMUNIZATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREIMPLANTABLEDEVICEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"

health.fhir.r4.uscore501: PROFILE_BASE_USCORELABORATORYRESULTOBSERVATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"

health.fhir.r4.uscore501: PROFILE_BASE_USCORELOCATION

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREMEDICATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREMEDICATIONREQUESTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONCLINICALTESTRESULTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-test"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONIMAGINGRESULTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-imaging"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSDOHASSESSMENT

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sdoh-assessment"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSEXUALORIENTATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSOCIALHISTORYPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-social-history"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSURVEYPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-survey"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREORGANIZATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPATIENTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICHEADOCCIPITALFRONTALCIRCUMFERENCEPERCENTILEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPRACTITIONERPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPRACTITIONERROLEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPROCEDUREPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPROVENANCE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPULSEOXIMETRYPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREQUESTIONNAIRERESPONSEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse"

health.fhir.r4.uscore501: PROFILE_BASE_USCORERELATEDPERSONPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"

health.fhir.r4.uscore501: PROFILE_BASE_USCORERESPIRATORYRATEPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate"

health.fhir.r4.uscore501: PROFILE_BASE_USCORESERVICEREQUESTPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest"

health.fhir.r4.uscore501: PROFILE_BASE_USCORESMOKINGSTATUSPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"

health.fhir.r4.uscore501: PROFILE_BASE_USCOREVITALSIGNSPROFILE

string "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREALLERGYINTOLERANCE

string "AllergyIntolerance"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBLOODPRESSUREPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBMIPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBODYHEIGHTPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBODYTEMPERATUREPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBODYWEIGHTPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECAREPLANPROFILE

string "CarePlan"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECARETEAM

string "CareTeam"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECONDITION

string "Condition"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECONDITIONENCOUNTERDIAGNOSISPROFILE

string "Condition"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECONDITIONPROBLEMSHEALTHCONCERNSPROFILE

string "Condition"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING

string "DiagnosticReport"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE

string "DiagnosticReport"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREDOCUMENTREFERENCEPROFILE

string "DocumentReference"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREENCOUNTERPROFILE

string "Encounter"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREGOALPROFILE

string "Goal"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREHEADCIRCUMFERENCEPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREHEARTRATEPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREIMMUNIZATIONPROFILE

string "Immunization"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE

string "Device"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORELABORATORYRESULTOBSERVATIONPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORELOCATION

string "Location"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREMEDICATIONPROFILE

string "Medication"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREMEDICATIONREQUESTPROFILE

string "MedicationRequest"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREOBSERVATIONCLINICALTESTRESULTPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREOBSERVATIONIMAGINGRESULTPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREOBSERVATIONSDOHASSESSMENT

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREOBSERVATIONSEXUALORIENTATIONPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREOBSERVATIONSOCIALHISTORYPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREOBSERVATIONSURVEYPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREORGANIZATIONPROFILE

string "Organization"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPATIENTPROFILE

string "Patient"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPEDIATRICHEADOCCIPITALFRONTALCIRCUMFERENCEPERCENTILEPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPRACTITIONERPROFILE

string "Practitioner"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPRACTITIONERROLEPROFILE

string "PractitionerRole"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPROCEDUREPROFILE

string "Procedure"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPROVENANCE

string "Provenance"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPULSEOXIMETRYPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREQUESTIONNAIRERESPONSEPROFILE

string "QuestionnaireResponse"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORERELATEDPERSONPROFILE

string "RelatedPerson"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORERESPIRATORYRATEPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORESERVICEREQUESTPROFILE

string "ServiceRequest"

health.fhir.r4.uscore501: RESOURCE_NAME_USCORESMOKINGSTATUSPROFILE

string "Observation"

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREVITALSIGNSPROFILE

string "Observation"

Enums

health.fhir.r4.uscore501: USCoreAllergyIntoleranceCategory

USCoreAllergyIntoleranceCategory enum

Members

CODE_CATEGORY_ENVIRONMENT

CODE_CATEGORY_BIOLOGIC

CODE_CATEGORY_MEDICATION

CODE_CATEGORY_FOOD

health.fhir.r4.uscore501: USCoreAllergyIntoleranceCriticality

USCoreAllergyIntoleranceCriticality enum

Members

CODE_CRITICALITY_HIGH

CODE_CRITICALITY_LOW

CODE_CRITICALITY_UNABLE_TO_ASSESS

health.fhir.r4.uscore501: USCoreAllergyIntoleranceReactionSeverity

USCoreAllergyIntoleranceReactionSeverity enum

Members

CODE_SEVERITY_MILD

CODE_SEVERITY_SEVERE

CODE_SEVERITY_MODERATE

health.fhir.r4.uscore501: USCoreAllergyIntoleranceType

USCoreAllergyIntoleranceType enum

Members

CODE_TYPE_INTOLERANCE

CODE_TYPE_ALLERGY

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentValueComparator

USCoreBloodPressureProfileComponentValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreBloodPressureProfileStatus

USCoreBloodPressureProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreBMIProfileStatus

USCoreBMIProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreBMIProfileValueComparator

USCoreBMIProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreBodyHeightProfileStatus

USCoreBodyHeightProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreBodyHeightProfileValueComparator

USCoreBodyHeightProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileStatus

USCoreBodyTemperatureProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileValueComparator

USCoreBodyTemperatureProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreBodyWeightProfileStatus

USCoreBodyWeightProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreBodyWeightProfileValueComparator

USCoreBodyWeightProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreCarePlanProfileActivityDetailKind

USCoreCarePlanProfileActivityDetailKind enum

Members

CODE_KIND_APPOINTMENT

CODE_KIND_MEDICATIONREQUEST

CODE_KIND_TASK

CODE_KIND_NUTRITIONORDER

CODE_KIND_VISIONPRESCRIPTION

CODE_KIND_DEVICEREQUEST

CODE_KIND_SERVICEREQUEST

CODE_KIND_COMMUNICATIONREQUEST

health.fhir.r4.uscore501: USCoreCarePlanProfileActivityDetailStatus

USCoreCarePlanProfileActivityDetailStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_SCHEDULED

CODE_STATUS_NOT_STARTED

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4.uscore501: USCoreCarePlanProfileIntent

USCoreCarePlanProfileIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_PLAN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4.uscore501: USCoreCarePlanProfileStatus

USCoreCarePlanProfileStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4.uscore501: USCoreCarePlanProfileTextStatus

USCoreCarePlanProfileTextStatus enum

Members

CODE_STATUS_EXTENSIONS

CODE_STATUS_GENERATED

CODE_STATUS_ADDITIONAL

CODE_STATUS_EMPTY

health.fhir.r4.uscore501: USCoreCareTeamStatus

USCoreCareTeamStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_PROPOSED

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_SUSPENDED

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileLaboratoryReportingStatus

USCoreDiagnosticReportProfileLaboratoryReportingStatus enum

Members

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

CODE_STATUS_PARTIAL

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileNoteExchangeStatus

USCoreDiagnosticReportProfileNoteExchangeStatus enum

Members

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

CODE_STATUS_PARTIAL

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileDocStatus

USCoreDocumentReferenceProfileDocStatus enum

Members

CODE_DOCSTATUS_AMENDED

CODE_DOCSTATUS_FINAL

CODE_DOCSTATUS_PRELIMINARY

CODE_DOCSTATUS_ENTERED_IN_ERROR

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileRelatesToCode

USCoreDocumentReferenceProfileRelatesToCode enum

Members

CODE_CODE_SIGNS

CODE_CODE_REPLACES

CODE_CODE_TRANSFORMS

CODE_CODE_APPENDS

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileStatus

USCoreDocumentReferenceProfileStatus enum

Members

CODE_STATUS_CURRENT

CODE_STATUS_SUPERSEDED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4.uscore501: USCoreEncounterProfileIdentifierUse

USCoreEncounterProfileIdentifierUse enum

Members

CODE_USE_SECONDARY

CODE_USE_TEMP

CODE_USE_USUAL

CODE_USE_OLD

CODE_USE_OFFICIAL

health.fhir.r4.uscore501: USCoreEncounterProfileLocationStatus

USCoreEncounterProfileLocationStatus enum

Members

CODE_STATUS_RESERVED

CODE_STATUS_ACTIVE

CODE_STATUS_PLANNED

CODE_STATUS_COMPLETED

health.fhir.r4.uscore501: USCoreEncounterProfileStatus

USCoreEncounterProfileStatus enum

Members

CODE_STATUS_TRIAGED

CODE_STATUS_ARRIVED

CODE_STATUS_ONLEAVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_IN_PROGRESS

health.fhir.r4.uscore501: USCoreEncounterProfileStatusHistoryStatus

USCoreEncounterProfileStatusHistoryStatus enum

Members

CODE_STATUS_TRIAGED

CODE_STATUS_ARRIVED

CODE_STATUS_ONLEAVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_IN_PROGRESS

health.fhir.r4.uscore501: USCoreGoalProfileLifecycleStatus

USCoreGoalProfileLifecycleStatus enum

Members

CODE_LIFECYCLESTATUS_PROPOSED

CODE_LIFECYCLESTATUS_REJECTED

CODE_LIFECYCLESTATUS_ACCEPTED

CODE_LIFECYCLESTATUS_ACTIVE

CODE_LIFECYCLESTATUS_CANCELLED

CODE_LIFECYCLESTATUS_PLANNED

CODE_LIFECYCLESTATUS_COMPLETED

CODE_LIFECYCLESTATUS_ENTERED_IN_ERROR

CODE_LIFECYCLESTATUS_ON_HOLD

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileStatus

USCoreHeadCircumferenceProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileValueComparator

USCoreHeadCircumferenceProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreHeartRateProfileStatus

USCoreHeartRateProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreHeartRateProfileValueComparator

USCoreHeartRateProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreImmunizationProfileStatus

USCoreImmunizationProfileStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_NOT_DONE

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileDeviceNameType

USCoreImplantableDeviceProfileDeviceNameType enum

Members

CODE_TYPE_UDI_LABEL_NAME

CODE_TYPE_OTHER

CODE_TYPE_MANUFACTURER_NAME

CODE_TYPE_MODEL_NAME

CODE_TYPE_USER_FRIENDLY_NAME

CODE_TYPE_PATIENT_REPORTED_NAME

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileStatus

USCoreImplantableDeviceProfileStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileUdiCarrierEntryType

USCoreImplantableDeviceProfileUdiCarrierEntryType enum

Members

CODE_ENTRYTYPE_RFID

CODE_ENTRYTYPE_MANUAL

CODE_ENTRYTYPE_BARCODE

health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfileStatus

USCoreLaboratoryResultObservationProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreLocationAddressType

USCoreLocationAddressType enum

Members

CODE_TYPE_POSTAL

CODE_TYPE_PHYSICAL

CODE_TYPE_BOTH

health.fhir.r4.uscore501: USCoreLocationAddressUse

USCoreLocationAddressUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_HOME

CODE_USE_BILLING

health.fhir.r4.uscore501: USCoreLocationHoursOfOperationDaysOfWeek

USCoreLocationHoursOfOperationDaysOfWeek enum

Members

CODE_DAYSOFWEEK_THU

CODE_DAYSOFWEEK_TUE

CODE_DAYSOFWEEK_WED

CODE_DAYSOFWEEK_SAT

CODE_DAYSOFWEEK_FRI

CODE_DAYSOFWEEK_MON

CODE_DAYSOFWEEK_SUN

health.fhir.r4.uscore501: USCoreLocationMode

USCoreLocationMode enum

Members

CODE_MODE_INSTANCE

CODE_MODE_KIND

health.fhir.r4.uscore501: USCoreLocationStatus

USCoreLocationStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_SUSPENDED

health.fhir.r4.uscore501: USCoreMedicationProfileStatus

USCoreMedicationProfileStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4.uscore501: USCoreMedicationRequestProfileIntent

USCoreMedicationRequestProfileIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4.uscore501: USCoreMedicationRequestProfilePriority

USCoreMedicationRequestProfilePriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4.uscore501: USCoreMedicationRequestProfileStatus

USCoreMedicationRequestProfileStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4.uscore501: USCoreObservationClinicalTestResultProfileStatus

USCoreObservationClinicalTestResultProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreObservationImagingResultProfileStatus

USCoreObservationImagingResultProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentStatus

USCoreObservationSDOHAssessmentStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreObservationSexualOrientationProfileStatus

USCoreObservationSexualOrientationProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileStatus

USCoreObservationSocialHistoryProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreObservationSurveyProfileStatus

USCoreObservationSurveyProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreOrganizationProfileAddressType

USCoreOrganizationProfileAddressType enum

Members

CODE_TYPE_POSTAL

CODE_TYPE_PHYSICAL

CODE_TYPE_BOTH

health.fhir.r4.uscore501: USCoreOrganizationProfileAddressUse

USCoreOrganizationProfileAddressUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_HOME

CODE_USE_BILLING

health.fhir.r4.uscore501: USCoreOrganizationProfileIdentifierUse

USCoreOrganizationProfileIdentifierUse enum

Members

CODE_USE_SECONDARY

CODE_USE_TEMP

CODE_USE_USUAL

CODE_USE_OLD

CODE_USE_OFFICIAL

health.fhir.r4.uscore501: USCoreOrganizationProfileTelecomSystem

USCoreOrganizationProfileTelecomSystem enum

Members

CODE_SYSTEM_OTHER

CODE_SYSTEM_PAGER

CODE_SYSTEM_PHONE

CODE_SYSTEM_SMS

CODE_SYSTEM_FAX

CODE_SYSTEM_EMAIL

CODE_SYSTEM_URL

health.fhir.r4.uscore501: USCoreOrganizationProfileTelecomUse

USCoreOrganizationProfileTelecomUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_MOBILE

CODE_USE_HOME

health.fhir.r4.uscore501: USCorePatientProfileAddressType

USCorePatientProfileAddressType enum

Members

CODE_TYPE_POSTAL

CODE_TYPE_PHYSICAL

CODE_TYPE_BOTH

health.fhir.r4.uscore501: USCorePatientProfileAddressUse

USCorePatientProfileAddressUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_HOME

CODE_USE_BILLING

health.fhir.r4.uscore501: USCorePatientProfileContactGender

USCorePatientProfileContactGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4.uscore501: USCorePatientProfileGender

USCorePatientProfileGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4.uscore501: USCorePatientProfileIdentifierUse

USCorePatientProfileIdentifierUse enum

Members

CODE_USE_SECONDARY

CODE_USE_TEMP

CODE_USE_USUAL

CODE_USE_OLD

CODE_USE_OFFICIAL

health.fhir.r4.uscore501: USCorePatientProfileLinkType

USCorePatientProfileLinkType enum

Members

CODE_TYPE_REFER

CODE_TYPE_REPLACES

CODE_TYPE_SEEALSO

CODE_TYPE_REPLACED_BY

health.fhir.r4.uscore501: USCorePatientProfileNameUse

USCorePatientProfileNameUse enum

Members

CODE_USE_MAIDEN

CODE_USE_TEMP

CODE_USE_USUAL

CODE_USE_OLD

CODE_USE_NICKNAME

CODE_USE_OFFICIAL

CODE_USE_ANONYMOUS

health.fhir.r4.uscore501: USCorePatientProfileTelecomSystem

USCorePatientProfileTelecomSystem enum

Members

CODE_SYSTEM_OTHER

CODE_SYSTEM_PAGER

CODE_SYSTEM_PHONE

CODE_SYSTEM_SMS

CODE_SYSTEM_FAX

CODE_SYSTEM_EMAIL

CODE_SYSTEM_URL

health.fhir.r4.uscore501: USCorePatientProfileTelecomUse

USCorePatientProfileTelecomUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_MOBILE

CODE_USE_HOME

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileStatus

USCorePediatricBMIforAgeObservationProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileValueComparator

USCorePediatricBMIforAgeObservationProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileStatus

USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileValueComparator

USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileStatus

USCorePediatricWeightForHeightObservationProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileValueComparator

USCorePediatricWeightForHeightObservationProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCorePractitionerProfileAddressType

USCorePractitionerProfileAddressType enum

Members

CODE_TYPE_POSTAL

CODE_TYPE_PHYSICAL

CODE_TYPE_BOTH

health.fhir.r4.uscore501: USCorePractitionerProfileAddressUse

USCorePractitionerProfileAddressUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_HOME

CODE_USE_BILLING

health.fhir.r4.uscore501: USCorePractitionerProfileGender

USCorePractitionerProfileGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4.uscore501: USCorePractitionerProfileIdentifierUse

USCorePractitionerProfileIdentifierUse enum

Members

CODE_USE_SECONDARY

CODE_USE_TEMP

CODE_USE_USUAL

CODE_USE_OLD

CODE_USE_OFFICIAL

health.fhir.r4.uscore501: USCorePractitionerProfileNameUse

USCorePractitionerProfileNameUse enum

Members

CODE_USE_MAIDEN

CODE_USE_TEMP

CODE_USE_USUAL

CODE_USE_OLD

CODE_USE_NICKNAME

CODE_USE_OFFICIAL

CODE_USE_ANONYMOUS

health.fhir.r4.uscore501: USCorePractitionerProfileTelecomSystem

USCorePractitionerProfileTelecomSystem enum

Members

CODE_SYSTEM_OTHER

CODE_SYSTEM_PAGER

CODE_SYSTEM_PHONE

CODE_SYSTEM_SMS

CODE_SYSTEM_FAX

CODE_SYSTEM_EMAIL

CODE_SYSTEM_URL

health.fhir.r4.uscore501: USCorePractitionerProfileTelecomUse

USCorePractitionerProfileTelecomUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_MOBILE

CODE_USE_HOME

health.fhir.r4.uscore501: USCorePractitionerRoleProfileAvailableTimeDaysOfWeek

USCorePractitionerRoleProfileAvailableTimeDaysOfWeek enum

Members

CODE_DAYSOFWEEK_THU

CODE_DAYSOFWEEK_TUE

CODE_DAYSOFWEEK_WED

CODE_DAYSOFWEEK_SAT

CODE_DAYSOFWEEK_FRI

CODE_DAYSOFWEEK_MON

CODE_DAYSOFWEEK_SUN

health.fhir.r4.uscore501: USCorePractitionerRoleProfileTelecomSystem

USCorePractitionerRoleProfileTelecomSystem enum

Members

CODE_SYSTEM_OTHER

CODE_SYSTEM_PAGER

CODE_SYSTEM_PHONE

CODE_SYSTEM_SMS

CODE_SYSTEM_FAX

CODE_SYSTEM_EMAIL

CODE_SYSTEM_URL

health.fhir.r4.uscore501: USCorePractitionerRoleProfileTelecomUse

USCorePractitionerRoleProfileTelecomUse enum

Members

CODE_USE_TEMP

CODE_USE_WORK

CODE_USE_OLD

CODE_USE_MOBILE

CODE_USE_HOME

health.fhir.r4.uscore501: USCoreProcedureProfileStatus

USCoreProcedureProfileStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r4.uscore501: USCoreProvenanceEntityRole

USCoreProvenanceEntityRole enum

Members

CODE_ROLE_REMOVAL

CODE_ROLE_DERIVATION

CODE_ROLE_SOURCE

CODE_ROLE_QUOTATION

CODE_ROLE_REVISION

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentValueComparator

USCorePulseOximetryProfileComponentValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCorePulseOximetryProfileStatus

USCorePulseOximetryProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfileStatus

USCoreQuestionnaireResponseProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r4.uscore501: USCoreRelatedPersonProfileGender

USCoreRelatedPersonProfileGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileStatus

USCoreRespiratoryRateProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileValueComparator

USCoreRespiratoryRateProfileValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4.uscore501: USCoreServiceRequestProfileIntent

USCoreServiceRequestProfileIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4.uscore501: USCoreServiceRequestProfilePriority

USCoreServiceRequestProfilePriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4.uscore501: USCoreServiceRequestProfileStatus

USCoreServiceRequestProfileStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4.uscore501: USCoreSmokingStatusProfileStatus

USCoreSmokingStatusProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4.uscore501: USCoreVitalSignsProfileStatus

USCoreVitalSignsProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

Variables

health.fhir.r4.uscore501: terminologyProcessor

TerminologyProcessor(default r4:terminologyProcessor)

Terminology processor instance

health.fhir.r4.uscore501: fhirRegistry

FHIRRegistry(default r4:fhirRegistry)

FHIR registry instance

health.fhir.r4.uscore501: FHIR_VALUE_SETS

json[](default [])

health.fhir.r4.uscore501: FHIR_CODE_SYSTEMS

json[](default [])

Records

health.fhir.r4.uscore501: BaseUSCoreConditionMeta

Closed record

Fields

Fields Included from * Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4.uscore501: USCoreAllergyIntolerance

FHIR USCoreAllergyIntolerance resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREALLERGYINTOLERANCE(default RESOURCE_NAME_USCOREALLERGYINTOLERANCE) - The type of the resource describes

note Annotation[]? - Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

onsetRange Range? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

criticality USCoreAllergyIntoleranceCriticality? - Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

language code? - The base language in which the resource is written.

clinicalStatus CodeableConcept? - The clinical status of the allergy or intolerance.

onsetDateTime dateTime? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

'type USCoreAllergyIntoleranceType? - Identification of the underlying physiological mechanism for the reaction risk.

onsetString string? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

onsetAge Age? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

lastOccurrence dateTime? - Represents the date and/or time of the last known occurrence of a reaction event.

patient Reference - The patient who has the allergy or intolerance.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

onsetPeriod Period? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

reaction USCoreAllergyIntoleranceReaction[]? - Details about each adverse reaction event linked to exposure to the identified substance.

verificationStatus CodeableConcept? - Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

recordedDate dateTime? - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

encounter Reference? - The encounter when the allergy or intolerance was asserted.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

asserter Reference? - The source of the information about the allergy that is recorded.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category USCoreAllergyIntoleranceCategory[]? - Category of the identified substance.

Element... - Rest field

health.fhir.r4.uscore501: USCoreAllergyIntoleranceReaction

Closed record

FHIR USCoreAllergyIntoleranceReaction datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

severity USCoreAllergyIntoleranceReactionSeverity? - Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

note Annotation[]? - Additional text about the adverse reaction event not captured in other fields.

extension Extension[]? - May 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.

manifestation CodeableConcept[] - Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

substance CodeableConcept? - Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

description string? - Text description about the reaction as a whole, including details of the manifestation if required.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

onset dateTime? - Record of the date and/or time of the onset of the Reaction.

exposureRoute CodeableConcept? - Identification of the route by which the subject was exposed to the substance.

health.fhir.r4.uscore501: UsCoreBirthsex

Closed record

Fields

Fields Included from * CodeExtension

url uri
valueCode code
id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

valueCode code -

url string -

health.fhir.r4.uscore501: USCoreBloodPressureProfile

FHIR USCoreBloodPressureProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREBLOODPRESSUREPROFILE(default RESOURCE_NAME_USCOREBLOODPRESSUREPROFILE) - The type of the resource describes

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type.

code USCoreBloodPressureProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreBloodPressureProfileComponent[] - Used when reporting component observation such as systolic and diastolic blood pressure.
- component Slicings
1. USCoreBloodPressureProfileComponentSystolic: Systolic Blood Pressure
- min = 1
- max = 1
1. USCoreBloodPressureProfileComponentDiastolic: Diastolic Blood Pressure
- min = 1
- max = 1

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreBloodPressureProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - Vital Signs value are typically recorded using the Quantity data type.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreBloodPressureProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreBloodPressureProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreBloodPressureProfileCategoryCoding

Closed record

FHIR USCoreBloodPressureProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreBloodPressureProfileCategoryVSCat

Closed record

FHIR USCoreBloodPressureProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBloodPressureProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreBloodPressureProfileCode

Closed record

FHIR USCoreBloodPressureProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBloodPressureProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBloodPressureProfileCodeCoding

Closed record

FHIR USCoreBloodPressureProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "85354-9") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponent

Closed record

FHIR USCoreBloodPressureProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentCode

Closed record

FHIR USCoreBloodPressureProfileComponentCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBloodPressureProfileComponentCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentCodeCoding

Closed record

FHIR USCoreBloodPressureProfileComponentCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "8480-6") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentCodeCodingOne

Closed record

FHIR USCoreBloodPressureProfileComponentCodeCodingOne datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "8462-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentCodeOne

Closed record

FHIR USCoreBloodPressureProfileComponentCodeOne datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBloodPressureProfileComponentCodeCodingOne[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentDiastolic

Closed record

FHIR USCoreBloodPressureProfileComponentDiastolic datatype record.

Fields

Fields Included from * USCoreBloodPressureProfileComponent

valueBoolean boolean
dataAbsentReason CodeableConcept
extension Extension[]
valueTime time
code CodeableConcept
valueRange Range
modifierExtension Extension[]
valueCodeableConcept CodeableConcept
valueRatio Ratio
valueString string
interpretation CodeableConcept[]
valueSampledData SampledData
valuePeriod Period
valueDateTime dateTime
id string
valueInteger integer
valueQuantity Quantity
Element...

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

code USCoreBloodPressureProfileComponentCodeOne - Describes what was observed. Sometimes this is called the observation 'code'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity USCoreBloodPressureProfileComponentValue? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentSystolic

Closed record

FHIR USCoreBloodPressureProfileComponentSystolic datatype record.

Fields

Fields Included from * USCoreBloodPressureProfileComponent

valueBoolean boolean
dataAbsentReason CodeableConcept
extension Extension[]
valueTime time
code CodeableConcept
valueRange Range
modifierExtension Extension[]
valueCodeableConcept CodeableConcept
valueRatio Ratio
valueString string
interpretation CodeableConcept[]
valueSampledData SampledData
valuePeriod Period
valueDateTime dateTime
id string
valueInteger integer
valueQuantity Quantity
Element...

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

code USCoreBloodPressureProfileComponentCode - Describes what was observed. Sometimes this is called the observation 'code'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity USCoreBloodPressureProfileComponentValue? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBloodPressureProfileComponentValue

Closed record

FHIR USCoreBloodPressureProfileComponentValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreBloodPressureProfileComponentValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

unit string - A human-readable form of the unit.

code code(default "mm[Hg]") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreBloodPressureProfileReferenceRange

Closed record

FHIR USCoreBloodPressureProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreBMIProfile

FHIR USCoreBMIProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREBMIPROFILE(default RESOURCE_NAME_USCOREBMIPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreBMIProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreBMIProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreBMIProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreBMIProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreBMIProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreBMIProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreBMIProfileCategoryCoding

Closed record

FHIR USCoreBMIProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreBMIProfileCategoryVSCat

Closed record

FHIR USCoreBMIProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBMIProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreBMIProfileCode

Closed record

FHIR USCoreBMIProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBMIProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBMIProfileCodeCoding

Closed record

FHIR USCoreBMIProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "39156-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBMIProfileComponent

Closed record

FHIR USCoreBMIProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBMIProfileReferenceRange

Closed record

FHIR USCoreBMIProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreBMIProfileValue

Closed record

FHIR USCoreBMIProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreBMIProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code(default "kg/m2") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreBodyHeightProfile

FHIR USCoreBodyHeightProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREBODYHEIGHTPROFILE(default RESOURCE_NAME_USCOREBODYHEIGHTPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreBodyHeightProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreBodyHeightProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreBodyHeightProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreBodyHeightProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreBodyHeightProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreBodyHeightProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreBodyHeightProfileCategoryCoding

Closed record

FHIR USCoreBodyHeightProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreBodyHeightProfileCategoryVSCat

Closed record

FHIR USCoreBodyHeightProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBodyHeightProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreBodyHeightProfileCode

Closed record

FHIR USCoreBodyHeightProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBodyHeightProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBodyHeightProfileCodeCoding

Closed record

FHIR USCoreBodyHeightProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "8302-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBodyHeightProfileComponent

Closed record

FHIR USCoreBodyHeightProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBodyHeightProfileReferenceRange

Closed record

FHIR USCoreBodyHeightProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreBodyHeightProfileValue

Closed record

FHIR USCoreBodyHeightProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreBodyHeightProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreBodyTemperatureProfile

FHIR USCoreBodyTemperatureProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREBODYTEMPERATUREPROFILE(default RESOURCE_NAME_USCOREBODYTEMPERATUREPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreBodyTemperatureProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreBodyTemperatureProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreBodyTemperatureProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreBodyTemperatureProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreBodyTemperatureProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreBodyTemperatureProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileCategoryCoding

Closed record

FHIR USCoreBodyTemperatureProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileCategoryVSCat

Closed record

FHIR USCoreBodyTemperatureProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBodyTemperatureProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileCode

Closed record

FHIR USCoreBodyTemperatureProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBodyTemperatureProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileCodeCoding

Closed record

FHIR USCoreBodyTemperatureProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "8310-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileComponent

Closed record

FHIR USCoreBodyTemperatureProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileReferenceRange

Closed record

FHIR USCoreBodyTemperatureProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreBodyTemperatureProfileValue

Closed record

FHIR USCoreBodyTemperatureProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreBodyTemperatureProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreBodyWeightProfile

FHIR USCoreBodyWeightProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREBODYWEIGHTPROFILE(default RESOURCE_NAME_USCOREBODYWEIGHTPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreBodyWeightProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreBodyWeightProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreBodyWeightProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreBodyWeightProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreBodyWeightProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreBodyWeightProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreBodyWeightProfileCategoryCoding

Closed record

FHIR USCoreBodyWeightProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreBodyWeightProfileCategoryVSCat

Closed record

FHIR USCoreBodyWeightProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBodyWeightProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreBodyWeightProfileCode

Closed record

FHIR USCoreBodyWeightProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreBodyWeightProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreBodyWeightProfileCodeCoding

Closed record

FHIR USCoreBodyWeightProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "29463-7") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreBodyWeightProfileComponent

Closed record

FHIR USCoreBodyWeightProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreBodyWeightProfileReferenceRange

Closed record

FHIR USCoreBodyWeightProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreBodyWeightProfileValue

Closed record

FHIR USCoreBodyWeightProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreBodyWeightProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreCarePlanProfile

FHIR USCoreCarePlanProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORECAREPLANPROFILE(default RESOURCE_NAME_USCORECAREPLANPROFILE) - The type of the resource describes

note Annotation[]? - General notes about the care plan not covered elsewhere.

partOf Reference[]? - A larger care plan of which this particular care plan is a component or step.

addresses Reference[]? - Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

activity USCoreCarePlanProfileActivity[]? - Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

subject Reference - Who care plan is for.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description string? - A description of the scope and nature of the plan.

language code? - The base language in which the resource is written.

title string? - Human-friendly name for the care plan.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

contributor Reference[]? - Identifies the individual(s) or organization who provided the contents of the care plan.

supportingInfo Reference[]? - Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text USCoreCarePlanProfileText - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - A care plan that is fulfilled in whole or in part by this care plan.

careTeam Reference[]? - Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

identifier Identifier[]? - Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

period Period? - Indicates when the plan did (or is intended to) come into effect and end.

goal Reference[]? - Describes the intended objective(s) of carrying out the care plan.

author Reference? - When populated, the author is responsible for the care plan. The care plan is attributed to the author.

created dateTime? - Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

replaces Reference[]? - Completed or terminated care plan whose function is taken by this new care plan.

encounter Reference? - The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

intent USCoreCarePlanProfileIntent - Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - Type of plan.
- category Slicings
1. USCoreCarePlanProfileCategoryAssessPlan: Type of plan
- min = 1
- max = 1

status USCoreCarePlanProfileStatus - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Element... - Rest field

health.fhir.r4.uscore501: USCoreCarePlanProfileActivity

Closed record

FHIR USCoreCarePlanProfileActivity datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

reference Reference? - The details of the proposed activity represented in a specific resource.

extension Extension[]? - May 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.

outcomeCodeableConcept CodeableConcept[]? - Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

outcomeReference Reference[]? - Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

progress Annotation[]? - Notes about the adherence/status/progress of the activity.

detail USCoreCarePlanProfileActivityDetail? - A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreCarePlanProfileActivityDetail

Closed record

FHIR USCoreCarePlanProfileActivityDetail datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

code CodeableConcept? - Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.

goal Reference[]? - Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

performer Reference[]? - Identifies who's expected to be involved in the activity.

quantity Quantity? - Identifies the quantity expected to be supplied, administered or consumed by the subject.

kind USCoreCarePlanProfileActivityDetailKind? - A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description string? - This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

productCarePlanCodeableConcept CodeableConcept? - Identifies the food, drug or other product to be consumed or supplied in the activity.

reasonReference Reference[]? - Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

scheduledCarePlanPeriod Period? - The period, timing or frequency upon which the described activity is to occur.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

scheduledCarePlanString string? - The period, timing or frequency upon which the described activity is to occur.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

productCarePlanReference Reference? - Identifies the food, drug or other product to be consumed or supplied in the activity.

statusReason CodeableConcept? - Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

dailyAmount Quantity? - Identifies the quantity expected to be consumed in a given day.

location Reference? - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

reasonCode CodeableConcept[]? - Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

doNotPerform boolean? - If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.

scheduledCarePlanTiming Timing? - The period, timing or frequency upon which the described activity is to occur.

status USCoreCarePlanProfileActivityDetailStatus - Identifies what progress is being made for the specific activity.

health.fhir.r4.uscore501: USCoreCarePlanProfileCategoryAssessPlan

Closed record

FHIR USCoreCarePlanProfileCategoryAssessPlan datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreCarePlanProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreCarePlanProfileCategoryCoding

Closed record

FHIR USCoreCarePlanProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/careplan-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "assess-plan") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreCarePlanProfileText

Closed record

FHIR USCoreCarePlanProfileText datatype record.

Fields

Fields Included from * Narrative

id string
extension Extension[]
status StatusCode
div xhtml
Element...

div xhtml - The actual narrative content, a stripped down version of XHTML.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status USCoreCarePlanProfileTextStatus - The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

health.fhir.r4.uscore501: USCoreCareTeam

FHIR USCoreCareTeam resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORECARETEAM(default RESOURCE_NAME_USCORECARETEAM) - The type of the resource describes

identifier Identifier[]? - Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

note Annotation[]? - Comments made about the CareTeam.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

period Period? - Indicates when the team did (or is intended to) come into effect and end.

subject Reference - Identifies the patient or group whose intended care is handled by the team.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reasonReference Reference[]? - Condition(s) that this care team addresses.

language code? - The base language in which the resource is written.

encounter Reference? - The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.

participant USCoreCareTeamParticipant[] - Identifies all people and organizations who are expected to be involved in the care team.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

managingOrganization Reference[]? - The organization responsible for the care team.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name string? - A label for human use intended to distinguish like teams. E.g. the 'red' vs. 'green' trauma teams.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A central contact detail for the care team (that applies to all members).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes why the care team exists.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[]? - Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.

status USCoreCareTeamStatus? - Indicates the current state of the care team.

Element... - Rest field

health.fhir.r4.uscore501: USCoreCareTeamParticipant

Closed record

FHIR USCoreCareTeamParticipant datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period? - Indicates when the specific member or organization did (or is intended to) come into effect and end.

role CodeableConcept - Indicates specific responsibility of an individual within the care team, such as 'Primary care physician', 'Trained social worker counselor', 'Caregiver', etc.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

member Reference - The specific person or organization who is participating/expected to participate in the care team.

onBehalfOf Reference? - The organization of the practitioner.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreCondition

FHIR USCoreCondition resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORECONDITION(default RESOURCE_NAME_USCORECONDITION) - The type of the resource describes

meta BaseUSCoreConditionMeta(default { profile : [PROFILE_BASE_USCORECONDITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - Identification of the condition, problem or diagnosis.

evidence USCoreConditionEvidence[]? - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

onsetRange Range? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementDateTime dateTime? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

subject Reference - Indicates the patient or group who the condition record is associated with.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language code? - The base language in which the resource is written.

clinicalStatus CodeableConcept? - The clinical status of the condition.

onsetDateTime dateTime? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetString string? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetAge Age? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementPeriod Period? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

abatementString string? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

severity CodeableConcept? - A subjective assessment of the severity of the condition as evaluated by the clinician.

identifier Identifier[]? - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

onsetPeriod Period? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

verificationStatus CodeableConcept? - The verification status to support the clinical status of the condition.

recordedDate dateTime? - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

abatementRange Range? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

encounter Reference? - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

bodySite CodeableConcept[]? - The anatomical location where this condition manifests itself.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

asserter Reference? - Individual who is making the condition statement.

stage USCoreConditionStage[]? - Clinical stage or grade of a condition. May include formal severity assessments.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A category assigned to the condition.

abatementAge Age? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

never... - Rest field

health.fhir.r4.uscore501: USCoreConditionEncounterDiagnosisProfile

FHIR USCoreConditionEncounterDiagnosisProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORECONDITIONENCOUNTERDIAGNOSISPROFILE(default RESOURCE_NAME_USCORECONDITIONENCOUNTERDIAGNOSISPROFILE) - The type of the resource describes

note Annotation[]? - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

extension Extension[]? - An Extension
- extension Slicings
1. Extension: Date the condition was first asserted
- min = 0
- max = 1

code CodeableConcept - Identification of the condition, problem or diagnosis.

evidence USCoreConditionEncounterDiagnosisProfileEvidence[]? - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

onsetRange Range? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementDateTime dateTime? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

subject Reference - Indicates the patient or group who the condition record is associated with.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language code? - The base language in which the resource is written.

clinicalStatus CodeableConcept? - The clinical status of the condition.

onsetDateTime dateTime? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetString string? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetAge Age? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementPeriod Period? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

abatementString string? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

severity CodeableConcept? - A subjective assessment of the severity of the condition as evaluated by the clinician.

identifier Identifier[]? - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

onsetPeriod Period? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

verificationStatus CodeableConcept? - The verification status to support the clinical status of the condition.

recordedDate dateTime? - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

abatementRange Range? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

encounter Reference? - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

bodySite CodeableConcept[]? - The anatomical location where this condition manifests itself.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

asserter Reference? - Individual who is making the condition statement.

stage USCoreConditionEncounterDiagnosisProfileStage[]? - Clinical stage or grade of a condition. May include formal severity assessments.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A category assigned to the condition.
- category Slicings
1. USCoreConditionEncounterDiagnosisProfileCategoryUs_core: encounter-diagnosis
- min = 1
- max = 1

abatementAge Age? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

Element... - Rest field

health.fhir.r4.uscore501: USCoreConditionEncounterDiagnosisProfileCategoryCoding

Closed record

FHIR USCoreConditionEncounterDiagnosisProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/condition-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "encounter-diagnosis") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreConditionEncounterDiagnosisProfileCategoryUs_core

Closed record

FHIR USCoreConditionEncounterDiagnosisProfileCategoryUs_core datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreConditionEncounterDiagnosisProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreConditionEncounterDiagnosisProfileEvidence

Closed record

FHIR USCoreConditionEncounterDiagnosisProfileEvidence datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

code CodeableConcept[]? - A manifestation or symptom that led to the recording of this condition.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail Reference[]? - Links to other relevant information, including pathology reports.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreConditionEncounterDiagnosisProfileStage

Closed record

FHIR USCoreConditionEncounterDiagnosisProfileStage datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

summary CodeableConcept? - A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific.

assessment Reference[]? - Reference to a formal record of the evidence on which the staging assessment is based.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The kind of staging, such as pathological or clinical staging.

health.fhir.r4.uscore501: USCoreConditionEvidence

Closed record

FHIR USCoreConditionEvidence datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

code CodeableConcept[]? - A manifestation or symptom that led to the recording of this condition.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail Reference[]? - Links to other relevant information, including pathology reports.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreConditionProblemsHealthConcernsProfile

FHIR USCoreConditionProblemsHealthConcernsProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORECONDITIONPROBLEMSHEALTHCONCERNSPROFILE(default RESOURCE_NAME_USCORECONDITIONPROBLEMSHEALTHCONCERNSPROFILE) - The type of the resource describes

note Annotation[]? - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

extension Extension[]? - An Extension
- extension Slicings
1. Extension: Date the condition was first asserted
- min = 0
- max = 1

code CodeableConcept - Identification of the condition, problem or diagnosis.

evidence USCoreConditionProblemsHealthConcernsProfileEvidence[]? - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

onsetRange Range? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementDateTime dateTime? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

subject Reference - Indicates the patient or group who the condition record is associated with.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language code? - The base language in which the resource is written.

clinicalStatus CodeableConcept? - The clinical status of the condition.

onsetDateTime dateTime? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetString string? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetAge Age? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementPeriod Period? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

abatementString string? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

severity CodeableConcept? - A subjective assessment of the severity of the condition as evaluated by the clinician.

identifier Identifier[]? - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

onsetPeriod Period? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

verificationStatus CodeableConcept? - The verification status to support the clinical status of the condition.

recordedDate dateTime? - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

abatementRange Range? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

encounter Reference? - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

bodySite CodeableConcept[]? - The anatomical location where this condition manifests itself.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

asserter Reference? - Individual who is making the condition statement.

stage USCoreConditionProblemsHealthConcernsProfileStage[]? - Clinical stage or grade of a condition. May include formal severity assessments.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A category assigned to the condition.
- category Slicings
1. USCoreConditionProblemsHealthConcernsProfileCategorySdoh: problem-list-item | encounter-diagnosis
- min = 0
- max = 1
1. USCoreConditionProblemsHealthConcernsProfileCategoryUs_core: problem-list-item | health-concern
- min = 1
- max = *

abatementAge Age? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

Element... - Rest field

health.fhir.r4.uscore501: USCoreConditionProblemsHealthConcernsProfileCategoryCoding

Closed record

FHIR USCoreConditionProblemsHealthConcernsProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/us-core-tags") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "sdoh") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreConditionProblemsHealthConcernsProfileCategorySdoh

Closed record

FHIR USCoreConditionProblemsHealthConcernsProfileCategorySdoh datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreConditionProblemsHealthConcernsProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreConditionProblemsHealthConcernsProfileCategoryUs_core

Closed record

FHIR USCoreConditionProblemsHealthConcernsProfileCategoryUs_core datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

health.fhir.r4.uscore501: USCoreConditionProblemsHealthConcernsProfileEvidence

Closed record

FHIR USCoreConditionProblemsHealthConcernsProfileEvidence datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

code CodeableConcept[]? - A manifestation or symptom that led to the recording of this condition.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail Reference[]? - Links to other relevant information, including pathology reports.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreConditionProblemsHealthConcernsProfileStage

Closed record

FHIR USCoreConditionProblemsHealthConcernsProfileStage datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

summary CodeableConcept? - A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific.

assessment Reference[]? - Reference to a formal record of the evidence on which the staging assessment is based.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The kind of staging, such as pathological or clinical staging.

health.fhir.r4.uscore501: USCoreConditionStage

Closed record

FHIR USCoreConditionStage datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

summary CodeableConcept? - A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific.

assessment Reference[]? - Reference to a formal record of the evidence on which the staging assessment is based.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The kind of staging, such as pathological or clinical staging.

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileLaboratoryReporting

FHIR USCoreDiagnosticReportProfileLaboratoryReporting resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING(default RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING) - The type of the resource describes

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - The test, panel or battery that was ordered.

subject Reference - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

presentedForm Attachment[]? - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

language code? - The base language in which the resource is written.

media USCoreDiagnosticReportProfileLaboratoryReportingMedia[]? - A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

conclusion string? - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

result Reference[]? - Observations that are part of this diagnostic report.

specimen Reference[]? - Details about the specimens on which this diagnostic report is based.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.

basedOn Reference[]? - Details concerning a service requested.

identifier Identifier[]? - Identifiers assigned to this report by the performer or other systems.

performer Reference[]? - The diagnostic service that is responsible for issuing the report.

effectivePeriod Period? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

resultsInterpreter Reference[]? - The practitioner or organization that is responsible for the report's conclusions and interpretations.

conclusionCode CodeableConcept[]? - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

effectiveDateTime dateTime? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
- category Slicings
1. USCoreDiagnosticReportProfileLaboratoryReportingCategoryLaboratorySlice: Service category
- min = 1
- max = 1

imagingStudy Reference[]? - One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.

status USCoreDiagnosticReportProfileLaboratoryReportingStatus - The status of the diagnostic report.

Element... - Rest field

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileLaboratoryReportingCategoryCoding

Closed record

FHIR USCoreDiagnosticReportProfileLaboratoryReportingCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/v2-0074") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "LAB") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileLaboratoryReportingCategoryLaboratorySlice

Closed record

FHIR USCoreDiagnosticReportProfileLaboratoryReportingCategoryLaboratorySlice datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreDiagnosticReportProfileLaboratoryReportingCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileLaboratoryReportingMedia

Closed record

FHIR USCoreDiagnosticReportProfileLaboratoryReportingMedia datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

link Reference - Reference to the image source.

comment string? - A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileNoteExchange

FHIR USCoreDiagnosticReportProfileNoteExchange resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE(default RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE) - The type of the resource describes

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - The test, panel, report, or note that was ordered.

subject Reference - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

presentedForm Attachment[]? - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

language code? - The base language in which the resource is written.

media USCoreDiagnosticReportProfileNoteExchangeMedia[]? - A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

conclusion string? - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

result Reference[]? - Observations that are part of this diagnostic report.

specimen Reference[]? - Details about the specimens on which this diagnostic report is based.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.

basedOn Reference[]? - Details concerning a service requested.

identifier Identifier[]? - Identifiers assigned to this report by the performer or other systems.

performer Reference[]? - The diagnostic service that is responsible for issuing the report.

effectivePeriod Period? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

resultsInterpreter Reference[]? - The practitioner or organization that is responsible for the report's conclusions and interpretations.

conclusionCode CodeableConcept[]? - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

effectiveDateTime dateTime? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
- category Slicings
1. USCoreDiagnosticReportProfileNoteExchangeCategoryUs_core: Service category
- min = 0
- max = *

imagingStudy Reference[]? - One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.

status USCoreDiagnosticReportProfileNoteExchangeStatus - The status of the diagnostic report.

Element... - Rest field

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileNoteExchangeCategoryUs_core

Closed record

FHIR USCoreDiagnosticReportProfileNoteExchangeCategoryUs_core datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

health.fhir.r4.uscore501: USCoreDiagnosticReportProfileNoteExchangeMedia

Closed record

FHIR USCoreDiagnosticReportProfileNoteExchangeMedia datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

link Reference - Reference to the image source.

comment string? - A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: UsCoreDirect

Closed record

Fields

Fields Included from * BooleanExtension

url uri
valueBoolean boolean
id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

valueBoolean boolean -

url string -

health.fhir.r4.uscore501: USCoreDocumentReferenceProfile

FHIR USCoreDocumentReferenceProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREDOCUMENTREFERENCEPROFILE(default RESOURCE_NAME_USCOREDOCUMENTREFERENCEPROFILE) - The type of the resource describes

date instant? - When the document reference was created.

identifier Identifier[]? - Other identifiers associated with the document, including version independent identifiers.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

custodian Reference? - Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

subject Reference - Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

author Reference[]? - Identifies who is responsible for adding the information to the document.

securityLabel CodeableConcept[]? - A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the 'reference' to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description string? - Human-readable description of the source document.

language code? - The base language in which the resource is written.

'type CodeableConcept - Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

masterIdentifier Identifier? - Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

content USCoreDocumentReferenceProfileContent[] - The document and format referenced. There may be multiple content element repetitions, each with a different format.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

docStatus USCoreDocumentReferenceProfileDocStatus? - The status of the underlying document.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

context USCoreDocumentReferenceProfileContext? - The clinical context in which the document was prepared.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relatesTo USCoreDocumentReferenceProfileRelatesTo[]? - Relationships that this document has with other document references that already exist.

category CodeableConcept[] - A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
- category Slicings
1. USCoreDocumentReferenceProfileCategoryUs_core: Categorization of document
- min = 0
- max = *

authenticator Reference? - Which person or organization authenticates that this document is valid.

status USCoreDocumentReferenceProfileStatus - The status of this document reference.

Element... - Rest field

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileCategoryUs_core

Closed record

FHIR USCoreDocumentReferenceProfileCategoryUs_core datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileContent

Closed record

FHIR USCoreDocumentReferenceProfileContent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

attachment Attachment - The document or URL of the document along with critical metadata to prove content has integrity.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

format Coding? - An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileContext

Closed record

FHIR USCoreDocumentReferenceProfileContext datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period? - The time period over which the service that is described by the document was provided.

facilityType CodeableConcept? - The kind of facility where the patient was seen.

practiceSetting CodeableConcept? - This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

encounter Reference? - Describes the clinical encounter or type of care that the document content is associated with.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

event CodeableConcept[]? - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.

sourcePatientInfo Reference? - The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

health.fhir.r4.uscore501: USCoreDocumentReferenceProfileRelatesTo

Closed record

FHIR USCoreDocumentReferenceProfileRelatesTo datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

code USCoreDocumentReferenceProfileRelatesToCode - The type of relationship that this document has with anther document.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target Reference - The target document of this relationship.

health.fhir.r4.uscore501: USCoreEncounterProfile

FHIR USCoreEncounterProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREENCOUNTERPROFILE(default RESOURCE_NAME_USCOREENCOUNTERPROFILE) - The type of the resource describes

serviceType CodeableConcept? - Broad categorization of the service that is to be provided (e.g. cardiology).

partOf Reference? - Another Encounter of which this encounter is a part of (administratively or in time).

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

subject Reference - The patient or group present at the encounter.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reasonReference Reference[]? - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

appointment Reference[]? - The appointment that scheduled this encounter.

language code? - The base language in which the resource is written.

'type CodeableConcept[] - Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

participant USCoreEncounterProfileParticipant[]? - The list of people responsible for providing the service.

episodeOfCare Reference[]? - Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

'class Coding - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

basedOn Reference[]? - The request this encounter satisfies (e.g. incoming referral or procedure request).

identifier USCoreEncounterProfileIdentifier[]? - Identifier(s) by which this encounter is known.

period Period? - The start and end time of the encounter.

classHistory USCoreEncounterProfileClassHistory[]? - The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

hospitalization USCoreEncounterProfileHospitalization? - Details about the admission to a healthcare service.

length Duration? - Quantity of time the encounter lasted. This excludes the time during leaves of absence.

diagnosis USCoreEncounterProfileDiagnosis[]? - The list of diagnosis relevant to this encounter.

priority CodeableConcept? - Indicates the urgency of the encounter.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

statusHistory USCoreEncounterProfileStatusHistory[]? - The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

serviceProvider Reference? - The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location USCoreEncounterProfileLocation[]? - List of locations where the patient has been during this encounter.

account Reference[]? - The set of accounts that may be used for billing for this Encounter.

status USCoreEncounterProfileStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

Element... - Rest field

health.fhir.r4.uscore501: USCoreEncounterProfileClassHistory

Closed record

FHIR USCoreEncounterProfileClassHistory datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period - The time that the episode was in the specified class.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'class Coding - inpatient | outpatient | ambulatory | emergency +.

health.fhir.r4.uscore501: USCoreEncounterProfileDiagnosis

Closed record

FHIR USCoreEncounterProfileDiagnosis datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

condition Reference - Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

extension Extension[]? - May 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.

use CodeableConcept? - Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

rank positiveInt? - Ranking of the diagnosis (for each role type).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreEncounterProfileHospitalization

Closed record

FHIR USCoreEncounterProfileHospitalization datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

specialArrangement CodeableConcept[]? - Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

reAdmission CodeableConcept? - Whether this hospitalization is a readmission and why if known.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

origin Reference? - The location/organization from which the patient came before admission.

destination Reference? - Location/organization to which the patient is discharged.

dietPreference CodeableConcept[]? - Diet preferences reported by the patient.

preAdmissionIdentifier Identifier? - Pre-admission identifier.

specialCourtesy CodeableConcept[]? - Special courtesies (VIP, board member).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

dischargeDisposition CodeableConcept? - Category or kind of location after discharge.

admitSource CodeableConcept? - From where patient was admitted (physician referral, transfer).

health.fhir.r4.uscore501: USCoreEncounterProfileIdentifier

Closed record

FHIR USCoreEncounterProfileIdentifier datatype record.

Fields

Fields Included from * Identifier

id string
extension Extension[]
use IdentifierUse
type CodeableConcept
system uri
value string
period Period
assigner Reference
Element...

extension Extension[]? - May 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.

period Period? - Time period during which identifier is/was valid for use.

system uri - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

use USCoreEncounterProfileIdentifierUse? - The purpose of this identifier.

assigner Reference? - Organization that issued/manages the identifier.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.

health.fhir.r4.uscore501: USCoreEncounterProfileLocation

Closed record

FHIR USCoreEncounterProfileLocation datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period? - Time period during which the patient was present at the location.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

physicalType CodeableConcept? - This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

location Reference - The location where the encounter takes place.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status USCoreEncounterProfileLocationStatus? - The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.

health.fhir.r4.uscore501: USCoreEncounterProfileParticipant

Closed record

FHIR USCoreEncounterProfileParticipant datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period? - The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

individual Reference? - Persons involved in the encounter other than the patient.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept[]? - Role of participant in encounter.

health.fhir.r4.uscore501: USCoreEncounterProfileStatusHistory

Closed record

FHIR USCoreEncounterProfileStatusHistory datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period - The time that the episode was in the specified status.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status USCoreEncounterProfileStatusHistoryStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

health.fhir.r4.uscore501: UsCoreEthnicity

Closed record

Fields

Fields Included from * Base64BinaryExtension

url uri
valueBase64Binary base64Binary
id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

valueCoding Coding -

valueString string -

url uri -

health.fhir.r4.uscore501: UsCoreExtensionQuestionnaireUri

Closed record

Fields

Fields Included from * UriExtension

url uri
valueUri uri
id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

valueUri uri? -

url uri -

health.fhir.r4.uscore501: UsCoreGenderIdentity

Closed record

Fields

Fields Included from * CodeableConceptExtension

url uri
valueCodeableConcept CodeableConcept
id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

valueCodeableConcept CodeableConcept -

url string -

health.fhir.r4.uscore501: USCoreGoalProfile

FHIR USCoreGoalProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREGOALPROFILE(default RESOURCE_NAME_USCOREGOALPROFILE) - The type of the resource describes

statusDate date? - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

note Annotation[]? - Any comments related to the goal.

addresses Reference[]? - The identified conditions and other health record elements that are intended to be addressed by the goal.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

lifecycleStatus USCoreGoalProfileLifecycleStatus - The state of the goal throughout its lifecycle.

outcomeReference Reference[]? - Details of what's changed (or not changed).

subject Reference - Identifies the patient, group or organization for whom the goal is being established.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.

language code? - The base language in which the resource is written.

outcomeCode CodeableConcept[]? - Identifies the change (or lack of change) at the point when the status of the goal is assessed.

statusReason string? - Captures the reason for the current status.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

priority CodeableConcept? - Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

target USCoreGoalProfileTarget[]? - Indicates what should be done by when.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

expressedBy Reference? - Indicates whose goal this is - patient goal, practitioner goal, etc.

startCodeableConcept CodeableConcept? - The date or event after which the goal should begin being pursued.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

achievementStatus CodeableConcept? - Describes the progression, or lack thereof, towards the goal against the target.

category CodeableConcept[]? - Indicates a category the goal falls within.

startDate date? - The date or event after which the goal should begin being pursued.

Element... - Rest field

health.fhir.r4.uscore501: USCoreGoalProfileTarget

Closed record

FHIR USCoreGoalProfileTarget datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

detailRange Range? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

extension Extension[]? - May 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.

detailQuantity Quantity? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

dueDate date? - Indicates either the date or the duration after start by which the goal should be met.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detailString string? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailBoolean boolean? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

dueDuration Duration? - Indicates either the date or the duration after start by which the goal should be met.

measure CodeableConcept? - The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

detailRatio Ratio? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailInteger integer? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailCodeableConcept CodeableConcept? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfile

FHIR USCoreHeadCircumferenceProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREHEADCIRCUMFERENCEPROFILE(default RESOURCE_NAME_USCOREHEADCIRCUMFERENCEPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreHeadCircumferenceProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreHeadCircumferenceProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreHeadCircumferenceProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreHeadCircumferenceProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreHeadCircumferenceProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreHeadCircumferenceProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileCategoryCoding

Closed record

FHIR USCoreHeadCircumferenceProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileCategoryVSCat

Closed record

FHIR USCoreHeadCircumferenceProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreHeadCircumferenceProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileCode

Closed record

FHIR USCoreHeadCircumferenceProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreHeadCircumferenceProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileCodeCoding

Closed record

FHIR USCoreHeadCircumferenceProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "9843-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileComponent

Closed record

FHIR USCoreHeadCircumferenceProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileReferenceRange

Closed record

FHIR USCoreHeadCircumferenceProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreHeadCircumferenceProfileValue

Closed record

FHIR USCoreHeadCircumferenceProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreHeadCircumferenceProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreHeartRateProfile

FHIR USCoreHeartRateProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREHEARTRATEPROFILE(default RESOURCE_NAME_USCOREHEARTRATEPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreHeartRateProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreHeartRateProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreHeartRateProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreHeartRateProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreHeartRateProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreHeartRateProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreHeartRateProfileCategoryCoding

Closed record

FHIR USCoreHeartRateProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreHeartRateProfileCategoryVSCat

Closed record

FHIR USCoreHeartRateProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreHeartRateProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreHeartRateProfileCode

Closed record

FHIR USCoreHeartRateProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreHeartRateProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreHeartRateProfileCodeCoding

Closed record

FHIR USCoreHeartRateProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "8867-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreHeartRateProfileComponent

Closed record

FHIR USCoreHeartRateProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreHeartRateProfileReferenceRange

Closed record

FHIR USCoreHeartRateProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreHeartRateProfileValue

Closed record

FHIR USCoreHeartRateProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreHeartRateProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code(default "/min") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreImmunizationProfile

FHIR USCoreImmunizationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREIMMUNIZATIONPROFILE(default RESOURCE_NAME_USCOREIMMUNIZATIONPROFILE) - The type of the resource describes

note Annotation[]? - Extra information about the immunization that is not conveyed by the other attributes.

primarySource boolean - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

education USCoreImmunizationProfileEducation[]? - Educational material presented to the patient (or guardian) at the time of vaccine administration.

doseQuantity SimpleQuantity? - The quantity of vaccine product that was administered.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reasonReference Reference[]? - Condition, Observation or DiagnosticReport that supports why the immunization was administered.

language code? - The base language in which the resource is written.

manufacturer Reference? - Name of vaccine manufacturer.

programEligibility CodeableConcept[]? - Indicates a patient's eligibility for a funding program.

statusReason CodeableConcept? - Indicates the reason the immunization event was not performed.

isSubpotent boolean? - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

patient Reference - The patient who either received or did not receive the immunization.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Reasons why the vaccine was administered.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

vaccineCode CodeableConcept - Vaccine that was administered or was to be administered.

expirationDate date? - Date vaccine batch expires.

identifier Identifier[]? - A unique identifier assigned to this immunization record.

performer USCoreImmunizationProfilePerformer[]? - Indicates who performed the immunization event.

reaction USCoreImmunizationProfileReaction[]? - Categorical data indicating that an adverse event is associated in time to an immunization.

subpotentReason CodeableConcept[]? - Reason why a dose is considered to be subpotent.

encounter Reference? - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

lotNumber string? - Lot number of the vaccine product.

recorded dateTime? - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

site CodeableConcept? - Body site where vaccine was administered.

route CodeableConcept? - The path by which the vaccine product is taken into the body.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

protocolApplied USCoreImmunizationProfileProtocolApplied[]? - The protocol (set of recommendations) being followed by the provider who administered the dose.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

reportOrigin CodeableConcept? - The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

location Reference? - The service delivery location where the vaccine administration occurred.

occurrenceDateTime dateTime - Date vaccine administered or was to be administered.

occurrenceString string - Date vaccine administered or was to be administered.

fundingSource CodeableConcept? - Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

status USCoreImmunizationProfileStatus - Indicates the current status of the immunization event.

Element... - Rest field

health.fhir.r4.uscore501: USCoreImmunizationProfileEducation

Closed record

FHIR USCoreImmunizationProfileEducation datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

reference uri? - Reference pointer to the educational material given to the patient if the information was on line.

extension Extension[]? - May 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.

documentType string? - Identifier of the material presented to the patient.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

presentationDate dateTime? - Date the educational material was given to the patient.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

publicationDate dateTime? - Date the educational material was published.

health.fhir.r4.uscore501: USCoreImmunizationProfilePerformer

Closed record

FHIR USCoreImmunizationProfilePerformer datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

actor Reference - The practitioner or organization who performed the action.

extension Extension[]? - May 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.

'function CodeableConcept? - Describes the type of performance (e.g. ordering provider, administering provider, etc.).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreImmunizationProfileProtocolApplied

Closed record

FHIR USCoreImmunizationProfileProtocolApplied datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

doseNumberString string - Nominal position in a series.

extension Extension[]? - May 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.

seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.

series string? - One possible path to achieve presumed immunity against a disease - within the context of an authority.

authority Reference? - Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

doseNumberPositiveInt positiveInt - Nominal position in a series.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

targetDisease CodeableConcept[]? - The vaccine preventable disease the dose is being administered against.

seriesDosesString string? - The recommended number of doses to achieve immunity.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreImmunizationProfileReaction

Closed record

FHIR USCoreImmunizationProfileReaction datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

date dateTime? - Date of reaction to the immunization.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reported boolean? - Self-reported indicator.

detail Reference? - Details of the reaction.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreImplantableDeviceProfile

FHIR USCoreImplantableDeviceProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE(default RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE) - The type of the resource describes

note Annotation[]? - Descriptive information, usage information or implantation information that is not captured in an existing element.

parent Reference? - The parent device.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language code? - The base language in which the resource is written.

distinctIdentifier string? - The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

'type CodeableConcept - The kind or type of device.

deviceName USCoreImplantableDeviceProfileDeviceName[]? - This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

manufacturer string? - A name of the manufacturer.

statusReason CodeableConcept[]? - Reason for the dtatus of the Device availability.

patient Reference - Patient information, If the device is affixed to a person.

safety CodeableConcept[]? - Provides additional safety characteristics about a medical device. For example devices containing latex.

contact ContactPoint[]? - Contact details for an organization or a particular human that is responsible for the device.

property USCoreImplantableDeviceProfileProperty[]? - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

manufactureDate dateTime? - The date and time when the device was manufactured.

definition Reference? - The reference to the definition for the device.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

expirationDate dateTime? - The date and time beyond which this device is no longer valid or should not be used (if applicable).

owner Reference? - An organization that is responsible for the provision and ongoing maintenance of the device.

identifier Identifier[]? - Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

serialNumber string? - The serial number assigned by the organization when the device was manufactured.

lotNumber string? - Lot number assigned by the manufacturer.

'version USCoreImplantableDeviceProfileVersion[]? - The actual design of the device or software version running on the device.

url uri? - A network address on which the device may be contacted directly.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

udiCarrier USCoreImplantableDeviceProfileUdiCarrier? - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

specialization USCoreImplantableDeviceProfileSpecialization[]? - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

location Reference? - The place where the device can be found.

modelNumber string? - The model number for the device.

partNumber string? - The part number of the device.

status USCoreImplantableDeviceProfileStatus? - Status of the Device availability.

Element... - Rest field

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileDeviceName

Closed record

FHIR USCoreImplantableDeviceProfileDeviceName datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name string - The name of the device.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type USCoreImplantableDeviceProfileDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileProperty

Closed record

FHIR USCoreImplantableDeviceProfileProperty datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCode CodeableConcept[]? - Property value as a code, e.g., NTP4 (synced to NTP).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

valueQuantity Quantity[]? - Property value as a quantity.

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileSpecialization

Closed record

FHIR USCoreImplantableDeviceProfileSpecialization datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

systemType CodeableConcept - The standard that is used to operate and communicate.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the standard that is used to operate and communicate.

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileUdiCarrier

Closed record

FHIR USCoreImplantableDeviceProfileUdiCarrier datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

entryType USCoreImplantableDeviceProfileUdiCarrierEntryType? - A coded entry to indicate how the data was entered.

extension Extension[]? - May 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.

deviceIdentifier string - The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

carrierHRF string? - The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

jurisdiction uri? - The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

carrierAIDC base64Binary? - The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.

issuer uri? - Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.

health.fhir.r4.uscore501: USCoreImplantableDeviceProfileVersion

Closed record

FHIR USCoreImplantableDeviceProfileVersion datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

component Identifier? - A single component of the device version.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The type of the device version.

value string - The version text.

health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfile

FHIR USCoreLaboratoryResultObservationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORELABORATORYRESULTOBSERVATIONPROFILE(default RESOURCE_NAME_USCORELABORATORYRESULTOBSERVATIONPROFILE) - The type of the resource describes

valueBoolean boolean? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

code CodeableConcept - The test that was performed. A LOINC SHALL be used if the concept is present in LOINC.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

valueRatio Ratio? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.

effectiveTiming Timing? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This 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.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreLaboratoryResultObservationProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreLaboratoryResultObservationProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

effectiveDateTime dateTime? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

valuePeriod Period? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreLaboratoryResultObservationProfileCategoryLaboratory: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.

status USCoreLaboratoryResultObservationProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfileCategoryCoding

Closed record

FHIR USCoreLaboratoryResultObservationProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "laboratory") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfileCategoryLaboratory

Closed record

FHIR USCoreLaboratoryResultObservationProfileCategoryLaboratory datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreLaboratoryResultObservationProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfileComponent

Closed record

FHIR USCoreLaboratoryResultObservationProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfileReferenceRange

Closed record

FHIR USCoreLaboratoryResultObservationProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreLocation

FHIR USCoreLocation resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORELOCATION(default RESOURCE_NAME_USCORELOCATION) - The type of the resource describes

operationalStatus Coding? - The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

partOf Reference? - Another Location of which this Location is physically a part of.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description string? - Description of the Location, which helps in finding or referencing the place.

hoursOfOperation USCoreLocationHoursOfOperation[]? - What days/times during a week is this location usually open.

language code? - The base language in which the resource is written.

'type CodeableConcept[]? - Indicates the type of function performed at the location.

mode USCoreLocationMode? - Indicates whether a resource instance represents a specific location or a class of locations.

endpoint Reference[]? - Technical endpoints providing access to services operated for the location.

alias string[]? - A list of alternate names that the location is known as, or was known as, in the past.

telecom ContactPoint[]? - The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Unique code or number identifying the location to its users.

address USCoreLocationAddress? - Physical location.

physicalType CodeableConcept? - Physical form of the location, e.g. building, room, vehicle, road.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

managingOrganization Reference? - The organization responsible for the provisioning and upkeep of the location.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name string - Name of the location as used by humans. Does not need to be unique.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

position USCoreLocationPosition? - The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

availabilityExceptions string? - A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

status USCoreLocationStatus? - The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Element... - Rest field

health.fhir.r4.uscore501: USCoreLocationAddress

Closed record

FHIR USCoreLocationAddress datatype record.

Fields

Fields Included from * Address

id string
extension Extension[]
use AddressUse
type AddressType
text string
line string[]
city string
district string
state string
postalCode string
country string
period Period
Element...

country string? - Country - a nation as commonly understood or generally accepted.

extension Extension[]? - May 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.

period Period? - Time period when address was/is in use.

city string? - The name of the city, town, suburb, village or other community or delivery center.

line string[]? - This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

use USCoreLocationAddressUse? - The purpose of this address.

district string? - The name of the administrative area (county).

postalCode string? - A postal code designating a region defined by the postal service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

state string? - Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

text string? - Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

'type USCoreLocationAddressType? - Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

health.fhir.r4.uscore501: USCoreLocationHoursOfOperation

Closed record

FHIR USCoreLocationHoursOfOperation datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

allDay boolean? - The Location is open all day.

extension Extension[]? - May 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.

closingTime time? - Time that the Location closes.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

openingTime time? - Time that the Location opens.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

daysOfWeek USCoreLocationHoursOfOperationDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.

health.fhir.r4.uscore501: USCoreLocationPosition

Closed record

FHIR USCoreLocationPosition datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

altitude decimal? - Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

extension Extension[]? - May 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.

latitude decimal - Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

longitude decimal - Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

health.fhir.r4.uscore501: USCoreMedicationProfile

FHIR USCoreMedicationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREMEDICATIONPROFILE(default RESOURCE_NAME_USCOREMEDICATIONPROFILE) - The type of the resource describes

identifier Identifier[]? - Business identifier for this medication.

amount Ratio? - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

ingredient USCoreMedicationProfileIngredient[]? - Identifies a particular constituent of interest in the product.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

batch USCoreMedicationProfileBatch? - Information that only applies to packages (not products).

language code? - The base language in which the resource is written.

manufacturer Reference? - Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

form CodeableConcept? - Describes the form of the item. Powder; tablets; capsule.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status USCoreMedicationProfileStatus? - A code to indicate if the medication is in active use.

Element... - Rest field

health.fhir.r4.uscore501: USCoreMedicationProfileBatch

Closed record

FHIR USCoreMedicationProfileBatch datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

lotNumber string? - The assigned lot number of a batch of the specified product.

expirationDate dateTime? - When this specific batch of product will expire.

health.fhir.r4.uscore501: USCoreMedicationProfileIngredient

Closed record

FHIR USCoreMedicationProfileIngredient datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

itemReference Reference - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

extension Extension[]? - May 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.

strength Ratio? - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

isActive boolean? - Indication of whether this ingredient affects the therapeutic action of the drug.

health.fhir.r4.uscore501: USCoreMedicationRequestProfile

FHIR USCoreMedicationRequestProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREMEDICATIONREQUESTPROFILE(default RESOURCE_NAME_USCOREMEDICATIONREQUESTPROFILE) - The type of the resource describes

insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

note Annotation[]? - Extra information about the prescription that could not be conveyed by the other attributes.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

substitution USCoreMedicationRequestProfileSubstitution? - Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

courseOfTherapyType CodeableConcept? - The description of the overall patte3rn of the administration of the medication to the patient.

priorPrescription Reference? - A link to a resource representing an earlier order related order or prescription.

subject Reference - A link to a resource representing the person or set of individuals to whom the medication will be given.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reasonReference Reference[]? - Condition or observation that supports why the medication was ordered.

language code? - The base language in which the resource is written.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.

medicationReference Reference - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

reportedReference Reference? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

statusReason CodeableConcept? - Captures the reason for the current state of the MedicationRequest.

dispenseRequest USCoreMedicationRequestProfileDispenseRequest? - Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - The reason or the indication for ordering or not ordering the medication.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform boolean? - If true indicates that the provider is asking for the medication request not to occur.

basedOn Reference[]? - A plan or request that is fulfilled in whole or in part by this medication request.

requester Reference - The individual, organization, or device that initiated the request and has responsibility for its activation.

identifier Identifier[]? - Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

recorder Reference? - The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

reportedBoolean boolean? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

authoredOn dateTime? - The date (and perhaps time) when the prescription was initially written or authored on.

performer Reference? - The specified desired performer of the medication treatment (e.g. the performer of the medication administration).

detectedIssue Reference[]? - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.

supportingInformation Reference[]? - Include additional information (for example, patient height and weight) that supports the ordering of the medication.

encounter Reference? - The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.

medicationCodeableConcept CodeableConcept - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

priority USCoreMedicationRequestProfilePriority? - Indicates how quickly the Medication Request should be addressed with respect to other requests.

intent USCoreMedicationRequestProfileIntent - Whether the request is a proposal, plan, or an original order.

performerType CodeableConcept? - Indicates the type of performer of the administration of the medication.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

dosageInstruction USCoreMedicationRequestProfileDosageInstruction[]? - Indicates how the medication is to be used by the patient.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

eventHistory Reference[]? - Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- category Slicings
1. USCoreMedicationRequestProfileCategoryUs_core: Type of medication usage
- min = 0
- max = *

groupIdentifier Identifier? - A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.

status USCoreMedicationRequestProfileStatus - A code specifying the current state of the order. Generally, this will be active or completed state.

Element... - Rest field

health.fhir.r4.uscore501: USCoreMedicationRequestProfileCategoryUs_core

Closed record

FHIR USCoreMedicationRequestProfileCategoryUs_core datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

health.fhir.r4.uscore501: USCoreMedicationRequestProfileDispenseRequest

Closed record

FHIR USCoreMedicationRequestProfileDispenseRequest datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

validityPeriod Period? - This indicates the validity period of a prescription (stale dating the Prescription).

dispenseInterval Duration? - The minimum period of time that must occur between dispenses of the medication.

extension Extension[]? - May 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.

performer Reference? - Indicates the intended dispensing Organization specified by the prescriber.

quantity Quantity? - The amount that is to be dispensed for one fill.

numberOfRepeatsAllowed unsignedInt? - An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus '3 repeats', then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

initialFill USCoreMedicationRequestProfileDispenseRequestInitialFill? - Indicates the quantity or duration for the first dispense of the medication.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

expectedSupplyDuration Duration? - Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

health.fhir.r4.uscore501: USCoreMedicationRequestProfileDispenseRequestInitialFill

Closed record

FHIR USCoreMedicationRequestProfileDispenseRequestInitialFill datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

duration Duration? - The length of time that the first dispense is expected to last.

extension Extension[]? - May 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.

quantity Quantity? - The amount or quantity to provide as part of the first dispense.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreMedicationRequestProfileDosageInstruction

Closed record

FHIR USCoreMedicationRequestProfileDosageInstruction datatype record.

Fields

Fields Included from * Dosage

id string
extension Extension[]
modifierExtension Extension[]
sequence integer
text string
addtionalInstruction CodeableConcept[]
patientInstruction string
timing Timing
asNeededBoolean boolean
asNeededCodeableConcept CodeableConcept
site CodeableConcept
route CodeableConcept
method CodeableConcept
doseAndRate ElementDoseAndRate[]
maxDosePerPeriod Ratio
maxDosePerAdministration SimpleQuantity
maxDosePerLifetime SimpleQuantity
Element...

maxDosePerLifetime Quantity? - Upper limit on medication per lifetime of the patient.

additionalInstruction CodeableConcept[]? - Supplemental instructions to the patient on how to take the medication (e.g. 'with meals' or'take half to one hour before food') or warnings for the patient about the medication (e.g. 'may cause drowsiness' or 'avoid exposure of skin to direct sunlight or sunlamps').

extension Extension[]? - May 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.

method CodeableConcept? - Technique for administering medication.

timing Timing? - When medication should be administered.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

doseAndRate ElementDoseAndRate[]? - The amount of medication administered.

sequence integer? - Indicates the order in which the dosage instructions should be applied or interpreted.

site CodeableConcept? - Body site to administer to.

route CodeableConcept? - How drug should enter body.

asNeededBoolean boolean? - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

maxDosePerAdministration Quantity? - Upper limit on medication per administration.

maxDosePerPeriod Ratio? - Upper limit on medication per unit of time.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Free text dosage instructions e.g. SIG.

asNeededCodeableConcept CodeableConcept? - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

patientInstruction string? - Instructions in terms that are understood by the patient or consumer.

health.fhir.r4.uscore501: USCoreMedicationRequestProfileSubstitution

Closed record

FHIR USCoreMedicationRequestProfileSubstitution datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

allowedCodeableConcept CodeableConcept - True if the prescriber allows a different drug to be dispensed from what was prescribed.

reason CodeableConcept? - Indicates the reason for the substitution, or why substitution must or must not be performed.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

allowedBoolean boolean - True if the prescriber allows a different drug to be dispensed from what was prescribed.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreObservationClinicalTestResultProfile

FHIR USCoreObservationClinicalTestResultProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREOBSERVATIONCLINICALTESTRESULTPROFILE(default RESOURCE_NAME_USCOREOBSERVATIONCLINICALTESTRESULTPROFILE) - The type of the resource describes

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - The name of the non-imaging or non-laboratory test performed on a patient. A LOINC SHALL be used if the concept is present in LOINC.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - The 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.

effectiveTiming Timing? - The 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.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This 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.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreObservationClinicalTestResultProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreObservationClinicalTestResultProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime? - The 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.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreObservationClinicalTestResultProfileCategoryClinical_test: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - The 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.

status USCoreObservationClinicalTestResultProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreObservationClinicalTestResultProfileCategoryClinical_test

Closed record

FHIR USCoreObservationClinicalTestResultProfileCategoryClinical_test datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationClinicalTestResultProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationClinicalTestResultProfileCategoryCoding

Closed record

FHIR USCoreObservationClinicalTestResultProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/us-core-observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "clinical-test") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationClinicalTestResultProfileComponent

Closed record

FHIR USCoreObservationClinicalTestResultProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreObservationClinicalTestResultProfileReferenceRange

Closed record

FHIR USCoreObservationClinicalTestResultProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreObservationImagingResultProfile

FHIR USCoreObservationImagingResultProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREOBSERVATIONIMAGINGRESULTPROFILE(default RESOURCE_NAME_USCOREOBSERVATIONIMAGINGRESULTPROFILE) - The type of the resource describes

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - The name of the imaging test performed on a patient. A LOINC SHALL be used if the concept is present in LOINC.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - The 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.

effectiveTiming Timing? - The 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.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This 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.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreObservationImagingResultProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreObservationImagingResultProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime? - The 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.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreObservationImagingResultProfileCategoryImaging: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - The 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.

status USCoreObservationImagingResultProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreObservationImagingResultProfileCategoryCoding

Closed record

FHIR USCoreObservationImagingResultProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "imaging") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationImagingResultProfileCategoryImaging

Closed record

FHIR USCoreObservationImagingResultProfileCategoryImaging datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationImagingResultProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationImagingResultProfileComponent

Closed record

FHIR USCoreObservationImagingResultProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreObservationImagingResultProfileReferenceRange

Closed record

FHIR USCoreObservationImagingResultProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreObservationSDOHAssessment

FHIR USCoreObservationSDOHAssessment resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREOBSERVATIONSDOHASSESSMENT(default RESOURCE_NAME_USCOREOBSERVATIONSDOHASSESSMENT) - The type of the resource describes

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - Observations or QuestionnaireResponses from which this observation value is derived.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - The 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'.

effectiveTiming Timing? - The 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'.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Aggregate set of Observations that represent question answer pairs for both multi-question surveys and multi-select questions.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreObservationSDOHAssessmentComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreObservationSDOHAssessmentReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime? - The 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'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreObservationSDOHAssessmentCategorySdoh: Classification of type of observation
- min = 0
- max = 1
1. USCoreObservationSDOHAssessmentCategorySurvey: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - The 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'.

status USCoreObservationSDOHAssessmentStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentCategoryCoding

Closed record

FHIR USCoreObservationSDOHAssessmentCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/us-core-tags") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "sdoh") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentCategoryCodingOne

Closed record

FHIR USCoreObservationSDOHAssessmentCategoryCodingOne datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "survey") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentCategorySdoh

Closed record

FHIR USCoreObservationSDOHAssessmentCategorySdoh datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationSDOHAssessmentCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentCategorySurvey

Closed record

FHIR USCoreObservationSDOHAssessmentCategorySurvey datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationSDOHAssessmentCategoryCodingOne[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentComponent

Closed record

FHIR USCoreObservationSDOHAssessmentComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreObservationSDOHAssessmentReferenceRange

Closed record

FHIR USCoreObservationSDOHAssessmentReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreObservationSexualOrientationProfile

FHIR USCoreObservationSexualOrientationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREOBSERVATIONSEXUALORIENTATIONPROFILE(default RESOURCE_NAME_USCOREOBSERVATIONSEXUALORIENTATIONPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreObservationSexualOrientationProfileCode - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The Sexual Orientation value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - This records the time during which the patient had identified their emotional, romantic, sexual, or affectional attraction to another person.

effectiveTiming Timing? - This records the time during which the patient had identified their emotional, romantic, sexual, or affectional attraction to another person.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This 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.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreObservationSexualOrientationProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreObservationSexualOrientationProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime? - This records the time during which the patient had identified their emotional, romantic, sexual, or affectional attraction to another person.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - A code that classifies the general type of observation being made.

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - This records the time during which the patient had identified their emotional, romantic, sexual, or affectional attraction to another person.

status USCoreObservationSexualOrientationProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreObservationSexualOrientationProfileCode

Closed record

FHIR USCoreObservationSexualOrientationProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationSexualOrientationProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationSexualOrientationProfileCodeCoding

Closed record

FHIR USCoreObservationSexualOrientationProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "76690-7") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationSexualOrientationProfileComponent

Closed record

FHIR USCoreObservationSexualOrientationProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreObservationSexualOrientationProfileReferenceRange

Closed record

FHIR USCoreObservationSexualOrientationProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfile

FHIR USCoreObservationSocialHistoryProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREOBSERVATIONSOCIALHISTORYPROFILE(default RESOURCE_NAME_USCOREOBSERVATIONSOCIALHISTORYPROFILE) - The type of the resource describes

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - The 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'.

effectiveTiming Timing? - The 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'.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This 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.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreObservationSocialHistoryProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreObservationSocialHistoryProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime? - The 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'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreObservationSocialHistoryProfileCategorySdoh: Classification of type of observation
- min = 0
- max = 1
1. USCoreObservationSocialHistoryProfileCategoryUs_coresocial_history: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - The 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'.

status USCoreObservationSocialHistoryProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileCategoryCoding

Closed record

FHIR USCoreObservationSocialHistoryProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/us-core-tags") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "sdoh") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileCategoryCodingOne

Closed record

FHIR USCoreObservationSocialHistoryProfileCategoryCodingOne datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "social-history") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileCategorySdoh

Closed record

FHIR USCoreObservationSocialHistoryProfileCategorySdoh datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationSocialHistoryProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileCategoryUs_coresocial_history

Closed record

FHIR USCoreObservationSocialHistoryProfileCategoryUs_coresocial_history datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationSocialHistoryProfileCategoryCodingOne[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileComponent

Closed record

FHIR USCoreObservationSocialHistoryProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreObservationSocialHistoryProfileReferenceRange

Closed record

FHIR USCoreObservationSocialHistoryProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreObservationSurveyProfile

FHIR USCoreObservationSurveyProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREOBSERVATIONSURVEYPROFILE(default RESOURCE_NAME_USCOREOBSERVATIONSURVEYPROFILE) - The type of the resource describes

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - Observations or QuestionnaireResponses from which this observation value is derived.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - The 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'.

effectiveTiming Timing? - The 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'.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Aggregate set of Observations that represent question answer pairs for both multi-question surveys and multi-select questions.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreObservationSurveyProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreObservationSurveyProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime? - The 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'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreObservationSurveyProfileCategorySurvey: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - The 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'.

status USCoreObservationSurveyProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreObservationSurveyProfileCategoryCoding

Closed record

FHIR USCoreObservationSurveyProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "survey") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreObservationSurveyProfileCategorySurvey

Closed record

FHIR USCoreObservationSurveyProfileCategorySurvey datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreObservationSurveyProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreObservationSurveyProfileComponent

Closed record

FHIR USCoreObservationSurveyProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreObservationSurveyProfileReferenceRange

Closed record

FHIR USCoreObservationSurveyProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreOrganizationProfile

FHIR USCoreOrganizationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREORGANIZATIONPROFILE(default RESOURCE_NAME_USCOREORGANIZATIONPROFILE) - The type of the resource describes

identifier USCoreOrganizationProfileIdentifier[]? - Identifier for the organization that is used to identify the organization across multiple disparate systems.
- identifier Slicings
1. USCoreOrganizationProfileIdentifierNPI: National Provider Identifier (NPI)
- min = 0
- max = 1
1. USCoreOrganizationProfileIdentifierCLIA: Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
- min = 0
- max = 1

partOf Reference? - The organization of which this organization forms a part.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

address USCoreOrganizationProfileAddress[]? - An address for the organization.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active boolean - Whether the organization's record is still in active use.

language code? - The base language in which the resource is written.

'type CodeableConcept[]? - The kind(s) of organization that this is.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

endpoint Reference[]? - Technical endpoints providing access to services operated for the organization.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

contact USCoreOrganizationProfileContact[]? - Contact for the organization for a certain purpose.

name string - A name associated with the organization.

alias string[]? - A list of alternate names that the organization is known as, or was known as in the past.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom USCoreOrganizationProfileTelecom[]? - A contact detail for the organization.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r4.uscore501: USCoreOrganizationProfileAddress

Closed record

FHIR USCoreOrganizationProfileAddress datatype record.

Fields

Fields Included from * Address

id string
extension Extension[]
use AddressUse
type AddressType
text string
line string[]
city string
district string
state string
postalCode string
country string
period Period
Element...

country string? - Country - a nation as commonly understood or generally accepted.

extension Extension[]? - May 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.

period Period? - Time period when address was/is in use.

city string? - The name of the city, town, suburb, village or other community or delivery center.

line string[]? - This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

use USCoreOrganizationProfileAddressUse? - The purpose of this address.

district string? - The name of the administrative area (county).

postalCode string? - A postal code designating a region defined by the postal service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

state string? - Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

text string? - Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

'type USCoreOrganizationProfileAddressType? - Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

health.fhir.r4.uscore501: USCoreOrganizationProfileContact

Closed record

FHIR USCoreOrganizationProfileContact datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

address Address? - Visiting or postal addresses for the contact.

purpose CodeableConcept? - Indicates a purpose for which the contact can be reached.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name HumanName? - A name associated with the contact.

telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreOrganizationProfileIdentifier

Closed record

FHIR USCoreOrganizationProfileIdentifier datatype record.

Fields

Fields Included from * Identifier

id string
extension Extension[]
use IdentifierUse
type CodeableConcept
system uri
value string
period Period
assigner Reference
Element...

extension Extension[]? - May 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.

period Period? - Time period during which identifier is/was valid for use.

system uri? - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

use USCoreOrganizationProfileIdentifierUse? - The purpose of this identifier.

assigner Reference? - Organization that issued/manages the identifier.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

value string? - The portion of the identifier typically relevant to the user and which is unique within the context of the system.

health.fhir.r4.uscore501: USCoreOrganizationProfileIdentifierCLIA

Closed record

FHIR USCoreOrganizationProfileIdentifierCLIA datatype record.

Fields

Fields Included from * USCoreOrganizationProfileIdentifier

extension Extension[]
period Period
system uri
use USCoreOrganizationProfileIdentifierUse
assigner Reference
id string
type CodeableConcept
value string
Element...

system uri(default "urn:oid:2.16.840.1.113883.4.7") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

health.fhir.r4.uscore501: USCoreOrganizationProfileIdentifierNPI

Closed record

FHIR USCoreOrganizationProfileIdentifierNPI datatype record.

Fields

Fields Included from * USCoreOrganizationProfileIdentifier

extension Extension[]
period Period
system uri
use USCoreOrganizationProfileIdentifierUse
assigner Reference
id string
type CodeableConcept
value string
Element...

system uri(default "http://hl7.org/fhir/sid/us-npi") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

health.fhir.r4.uscore501: USCoreOrganizationProfileTelecom

Closed record

FHIR USCoreOrganizationProfileTelecom datatype record.

Fields

Fields Included from * ContactPoint

id string
extension Extension[]
system ContactPointSystem
value string
use ContactPointUse
rank positiveInt
period Period
Element...

extension Extension[]? - May 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.

period Period? - Time period when the contact point was/is in use.

system USCoreOrganizationProfileTelecomSystem? - Telecommunications form for contact point - what communications system is required to make use of the contact.

use USCoreOrganizationProfileTelecomUse? - Identifies the purpose for the contact point.

rank positiveInt? - Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string? - The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

health.fhir.r4.uscore501: USCorePatientProfile

FHIR USCorePatientProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPATIENTPROFILE(default RESOURCE_NAME_USCOREPATIENTPROFILE) - The type of the resource describes

extension Extension[]? - An Extension
- extension Slicings
1. Extension: US Core ethnicity Extension
- min = 0
- max = 1
1. Extension: Extension
- min = 0
- max = 1
1. Extension: US Core Race Extension
- min = 0
- max = 1
1. Extension: Extension
- min = 0
- max = 1

gender USCorePatientProfileGender - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

link USCorePatientProfileLink[]? - Link to another patient resource that concerns the same actual patient.

language code? - The base language in which the resource is written.

contact USCorePatientProfileContact[]? - A contact party (e.g. guardian, partner, friend) for the patient.

deceasedDateTime dateTime? - Indicates if the individual is deceased or not.

generalPractitioner Reference[]? - Patient's nominated care provider.

telecom USCorePatientProfileTelecom[]? - A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication USCorePatientProfileCommunication[]? - A language which may be used to communicate with the patient about his or her health.

identifier USCorePatientProfileIdentifier[] - An identifier for this patient.

address USCorePatientProfileAddress[]? - An address for the individual.

multipleBirthBoolean boolean? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

active boolean? - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

photo Attachment[]? - Image of the patient.

birthDate date? - The date of birth for the individual.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

deceasedBoolean boolean? - Indicates if the individual is deceased or not.

managingOrganization Reference? - Organization that is the custodian of the patient record.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

multipleBirthInteger integer? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

name USCorePatientProfileName[] - A name associated with the individual.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

maritalStatus CodeableConcept? - This field contains a patient's most recent marital (civil) status.

Element... - Rest field

health.fhir.r4.uscore501: USCorePatientProfileAddress

Closed record

FHIR USCorePatientProfileAddress datatype record.

Fields

Fields Included from * Address

id string
extension Extension[]
use AddressUse
type AddressType
text string
line string[]
city string
district string
state string
postalCode string
country string
period Period
Element...

country string? - Country - a nation as commonly understood or generally accepted.

extension Extension[]? - May 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.

period Period? - Time period when address was/is in use.

city string? - The name of the city, town, suburb, village or other community or delivery center.

line string[]? - This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

use USCorePatientProfileAddressUse? - The purpose of this address.

district string? - The name of the administrative area (county).

postalCode string? - A postal code designating a region defined by the postal service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

state string? - Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

text string? - Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

'type USCorePatientProfileAddressType? - Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

health.fhir.r4.uscore501: USCorePatientProfileCommunication

Closed record

FHIR USCorePatientProfileCommunication datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

preferred boolean? - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

health.fhir.r4.uscore501: USCorePatientProfileContact

Closed record

FHIR USCorePatientProfileContact datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

period Period? - The period during which this contact person or organization is valid to be contacted relating to this patient.

address Address? - Address for the contact person.

gender USCorePatientProfileContactGender? - Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

organization Reference? - Organization on behalf of which the contact is acting or for which the contact is working.

name HumanName? - A name associated with the contact person.

telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship CodeableConcept[]? - The nature of the relationship between the patient and the contact person.

health.fhir.r4.uscore501: USCorePatientProfileIdentifier

Closed record

FHIR USCorePatientProfileIdentifier datatype record.

Fields

Fields Included from * Identifier

id string
extension Extension[]
use IdentifierUse
type CodeableConcept
system uri
value string
period Period
assigner Reference
Element...

extension Extension[]? - May 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.

period Period? - Time period during which identifier is/was valid for use.

system uri - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

use USCorePatientProfileIdentifierUse? - The purpose of this identifier.

assigner Reference? - Organization that issued/manages the identifier.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.

health.fhir.r4.uscore501: USCorePatientProfileLink

Closed record

FHIR USCorePatientProfileLink datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

other Reference - The other patient resource that the link refers to.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type USCorePatientProfileLinkType - The type of link between this patient resource and another patient resource.

health.fhir.r4.uscore501: USCorePatientProfileName

Closed record

FHIR USCorePatientProfileName datatype record.

Fields

Fields Included from * HumanName

id string
extension Extension[]
use HumanNameUse
text string
family string
given string[]
prefix string[]
suffix string[]
period Period
Element...

given string[]? - Given name.

extension Extension[]? - May 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.

period Period? - Indicates the period of time when this name was valid for the named person.

prefix string[]? - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

use USCorePatientProfileNameUse? - Identifies the purpose for this name.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

family string? - The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

suffix string[]? - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

health.fhir.r4.uscore501: USCorePatientProfileTelecom

Closed record

FHIR USCorePatientProfileTelecom datatype record.

Fields

Fields Included from * ContactPoint

id string
extension Extension[]
system ContactPointSystem
value string
use ContactPointUse
rank positiveInt
period Period
Element...

extension Extension[]? - May 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.

period Period? - Time period when the contact point was/is in use.

system USCorePatientProfileTelecomSystem - Telecommunications form for contact point - what communications system is required to make use of the contact.

use USCorePatientProfileTelecomUse? - Identifies the purpose for the contact point.

rank positiveInt? - Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfile

FHIR USCorePediatricBMIforAgeObservationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE(default RESOURCE_NAME_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCorePediatricBMIforAgeObservationProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCorePediatricBMIforAgeObservationProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCorePediatricBMIforAgeObservationProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCorePediatricBMIforAgeObservationProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCorePediatricBMIforAgeObservationProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCorePediatricBMIforAgeObservationProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileCategoryCoding

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileCategoryVSCat

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePediatricBMIforAgeObservationProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileCode

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePediatricBMIforAgeObservationProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileCodeCoding

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "59576-9") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileComponent

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileReferenceRange

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfileValue

Closed record

FHIR USCorePediatricBMIforAgeObservationProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCorePediatricBMIforAgeObservationProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code(default "%") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfile

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPEDIATRICHEADOCCIPITALFRONTALCIRCUMFERENCEPERCENTILEPROFILE(default RESOURCE_NAME_USCOREPEDIATRICHEADOCCIPITALFRONTALCIRCUMFERENCEPERCENTILEPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCategoryCoding

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCategoryVSCat

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCode

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCodeCoding

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "8289-1") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileComponent

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileReferenceRange

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileValue

Closed record

FHIR USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code(default "%") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfile

FHIR USCorePediatricWeightForHeightObservationProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE(default RESOURCE_NAME_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCorePediatricWeightForHeightObservationProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCorePediatricWeightForHeightObservationProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCorePediatricWeightForHeightObservationProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCorePediatricWeightForHeightObservationProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCorePediatricWeightForHeightObservationProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCorePediatricWeightForHeightObservationProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileCategoryCoding

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileCategoryVSCat

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePediatricWeightForHeightObservationProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileCode

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePediatricWeightForHeightObservationProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileCodeCoding

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "77606-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileComponent

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileReferenceRange

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfileValue

Closed record

FHIR USCorePediatricWeightForHeightObservationProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCorePediatricWeightForHeightObservationProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code(default "%") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCorePractitionerProfile

FHIR USCorePractitionerProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPRACTITIONERPROFILE(default RESOURCE_NAME_USCOREPRACTITIONERPROFILE) - The type of the resource describes

identifier USCorePractitionerProfileIdentifier[] - An identifier that applies to this person in this role.
- identifier Slicings
1. USCorePractitionerProfileIdentifierNPI: An identifier for the person as this agent
- min = 0
- max = 1

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

address USCorePractitionerProfileAddress[]? - Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

gender USCorePractitionerProfileGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active boolean? - Whether this practitioner's record is in active use.

photo Attachment[]? - Image of the person.

language code? - The base language in which the resource is written.

birthDate date? - The date of birth for the practitioner.

qualification USCorePractitionerProfileQualification[]? - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name USCorePractitionerProfileName[] - The name(s) associated with the practitioner.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom USCorePractitionerProfileTelecom[]? - A contact detail for the practitioner, e.g. a telephone number or an email address.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication CodeableConcept[]? - A language the practitioner can use in patient communication.

Element... - Rest field

health.fhir.r4.uscore501: USCorePractitionerProfileAddress

Closed record

FHIR USCorePractitionerProfileAddress datatype record.

Fields

Fields Included from * Address

id string
extension Extension[]
use AddressUse
type AddressType
text string
line string[]
city string
district string
state string
postalCode string
country string
period Period
Element...

country string? - Country - a nation as commonly understood or generally accepted.

extension Extension[]? - May 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.

period Period? - Time period when address was/is in use.

city string? - The name of the city, town, suburb, village or other community or delivery center.

line string[]? - This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

use USCorePractitionerProfileAddressUse? - The purpose of this address.

district string? - The name of the administrative area (county).

postalCode string? - A postal code designating a region defined by the postal service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

state string? - Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

text string? - Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

'type USCorePractitionerProfileAddressType? - Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

health.fhir.r4.uscore501: USCorePractitionerProfileIdentifier

Closed record

FHIR USCorePractitionerProfileIdentifier datatype record.

Fields

Fields Included from * Identifier

id string
extension Extension[]
use IdentifierUse
type CodeableConcept
system uri
value string
period Period
assigner Reference
Element...

extension Extension[]? - May 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.

period Period? - Time period during which identifier is/was valid for use.

system uri - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

use USCorePractitionerProfileIdentifierUse? - The purpose of this identifier.

assigner Reference? - Organization that issued/manages the identifier.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.

health.fhir.r4.uscore501: USCorePractitionerProfileIdentifierNPI

Closed record

FHIR USCorePractitionerProfileIdentifierNPI datatype record.

Fields

Fields Included from * USCorePractitionerProfileIdentifier

extension Extension[]
period Period
system uri
use USCorePractitionerProfileIdentifierUse
assigner Reference
id string
type CodeableConcept
value string
Element...

system uri(default "http://hl7.org/fhir/sid/us-npi") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

health.fhir.r4.uscore501: USCorePractitionerProfileName

Closed record

FHIR USCorePractitionerProfileName datatype record.

Fields

Fields Included from * HumanName

id string
extension Extension[]
use HumanNameUse
text string
family string
given string[]
prefix string[]
suffix string[]
period Period
Element...

given string[]? - Given name.

extension Extension[]? - May 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.

period Period? - Indicates the period of time when this name was valid for the named person.

prefix string[]? - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

use USCorePractitionerProfileNameUse? - Identifies the purpose for this name.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

family string - The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

suffix string[]? - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

health.fhir.r4.uscore501: USCorePractitionerProfileQualification

Closed record

FHIR USCorePractitionerProfileQualification datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

identifier Identifier[]? - An identifier that applies to this person's qualification in this role.

extension Extension[]? - May 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.

period Period? - Period during which the qualification is valid.

code CodeableConcept - Coded representation of the qualification.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

issuer Reference? - Organization that regulates and issues the qualification.

health.fhir.r4.uscore501: USCorePractitionerProfileTelecom

Closed record

FHIR USCorePractitionerProfileTelecom datatype record.

Fields

Fields Included from * ContactPoint

id string
extension Extension[]
system ContactPointSystem
value string
use ContactPointUse
rank positiveInt
period Period
Element...

extension Extension[]? - May 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.

period Period? - Time period when the contact point was/is in use.

system USCorePractitionerProfileTelecomSystem? - Telecommunications form for contact point - what communications system is required to make use of the contact.

use USCorePractitionerProfileTelecomUse? - Identifies the purpose for the contact point.

rank positiveInt? - Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string? - The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

health.fhir.r4.uscore501: USCorePractitionerRoleProfile

FHIR USCorePractitionerRoleProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPRACTITIONERROLEPROFILE(default RESOURCE_NAME_USCOREPRACTITIONERROLEPROFILE) - The type of the resource describes

identifier Identifier[]? - Business Identifiers that are specific to a role/location.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

period Period? - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

specialty CodeableConcept[]? - Specific specialty of the practitioner.

code CodeableConcept[]? - Roles which this practitioner is authorized to perform for the organization.

practitioner Reference? - Practitioner that is able to provide the defined services for the organization.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active boolean? - Whether this practitioner role record is in active use.

language code? - The base language in which the resource is written.

notAvailable USCorePractitionerRoleProfileNotAvailable[]? - The practitioner is not available or performing this role during this period of time due to the provided reason.

availableTime USCorePractitionerRoleProfileAvailableTime[]? - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

endpoint Reference[]? - Technical endpoints providing access to services operated for the practitioner with this role.

healthcareService Reference[]? - The list of healthcare services that this worker provides for this role's Organization/Location(s).

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

organization Reference? - The organization where the Practitioner performs the roles associated.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference[]? - The location(s) at which this practitioner provides care.

telecom USCorePractitionerRoleProfileTelecom[]? - Contact details that are specific to the role/location/service.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

availabilityExceptions string? - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Element... - Rest field

health.fhir.r4.uscore501: USCorePractitionerRoleProfileAvailableTime

Closed record

FHIR USCorePractitionerRoleProfileAvailableTime datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

allDay boolean? - Is this always available? (hence times are irrelevant) e.g. 24 hour service.

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

availableEndTime time? - The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

daysOfWeek USCorePractitionerRoleProfileAvailableTimeDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.

availableStartTime time? - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

health.fhir.r4.uscore501: USCorePractitionerRoleProfileNotAvailable

Closed record

FHIR USCorePractitionerRoleProfileNotAvailable datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description string - The reason that can be presented to the user as to why this time is not available.

during Period? - Service is not available (seasonally or for a public holiday) from this date.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCorePractitionerRoleProfileTelecom

Closed record

FHIR USCorePractitionerRoleProfileTelecom datatype record.

Fields

Fields Included from * ContactPoint

id string
extension Extension[]
system ContactPointSystem
value string
use ContactPointUse
rank positiveInt
period Period
Element...

extension Extension[]? - May 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.

period Period? - Time period when the contact point was/is in use.

system USCorePractitionerRoleProfileTelecomSystem - Telecommunications form for contact point - what communications system is required to make use of the contact.

use USCorePractitionerRoleProfileTelecomUse? - Identifies the purpose for the contact point.

rank positiveInt? - Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

health.fhir.r4.uscore501: USCoreProcedureProfile

FHIR USCoreProcedureProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPROCEDUREPROFILE(default RESOURCE_NAME_USCOREPROCEDUREPROFILE) - The type of the resource describes

note Annotation[]? - Any other notes and comments about the procedure.

partOf Reference[]? - A larger event of which this particular procedure is a component or step.

complication CodeableConcept[]? - Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy').

subject Reference - The person, animal or group on which the procedure was performed.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reasonReference Reference[]? - The justification of why the procedure was performed.

language code? - The base language in which the resource is written.

performedRange Range? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedAge Age? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

performedPeriod Period? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedString string? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

followUp CodeableConcept[]? - If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

statusReason CodeableConcept? - Captures the reason for the current state of the procedure.

usedCode CodeableConcept[]? - Identifies coded items that were used as part of the procedure.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

performedDateTime dateTime? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

basedOn Reference[]? - A reference to a resource that contains details of the request for this procedure.

outcome CodeableConcept? - The outcome of the procedure - did it resolve the reasons for the procedure being performed?

identifier Identifier[]? - Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

complicationDetail Reference[]? - Any complications that occurred during the procedure, or in the immediate post-performance period.

performer USCoreProcedureProfilePerformer[]? - Limited to 'real' people rather than equipment.

usedReference Reference[]? - Identifies medications, devices and any other substance used as part of the procedure.

focalDevice USCoreProcedureProfileFocalDevice[]? - A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

encounter Reference? - The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

bodySite CodeableConcept[]? - Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

asserter Reference? - Individual who is making the procedure statement.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

report Reference[]? - This could be a histology result, pathology report, surgical report, etc.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.

category CodeableConcept? - A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure').

status USCoreProcedureProfileStatus - A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

Element... - Rest field

health.fhir.r4.uscore501: USCoreProcedureProfileFocalDevice

Closed record

FHIR USCoreProcedureProfileFocalDevice datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

action CodeableConcept? - The kind of change that happened to the device during the procedure.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

manipulated Reference - The device that was manipulated (changed) during the procedure.

health.fhir.r4.uscore501: USCoreProcedureProfilePerformer

Closed record

FHIR USCoreProcedureProfilePerformer datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

actor Reference - The practitioner who was involved in the procedure.

extension Extension[]? - May 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.

'function CodeableConcept? - Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

onBehalfOf Reference? - The organization the device or practitioner was acting on behalf of.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreProvenance

FHIR USCoreProvenance resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPROVENANCE(default RESOURCE_NAME_USCOREPROVENANCE) - The type of the resource describes

reason CodeableConcept[]? - The reason that the activity was taking place.

agent USCoreProvenanceAgent[] - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- agent Slicings
1. USCoreProvenanceAgentProvenanceAuthor: Actor involved
- min = 0
- max = *
1. USCoreProvenanceAgentProvenanceTransmitter: Actor involved
- min = 0
- max = *

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

activity CodeableConcept? - An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.

signature Signature[]? - A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language code? - The base language in which the resource is written.

occurredPeriod Period? - The period during which the activity occurred.

recorded instant - The instant of time at which the activity was recorded.

target USCoreProvenanceTarget[] - The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - Where the activity occurred, if relevant.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

entity USCoreProvenanceEntity[]? - An entity used in this activity.

occurredDateTime dateTime? - The period during which the activity occurred.

policy uri[]? - Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.

Element... - Rest field

health.fhir.r4.uscore501: USCoreProvenanceAgent

Closed record

FHIR USCoreProvenanceAgent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

role CodeableConcept[]? - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

onBehalfOf Reference? - The individual, device, or organization for whom the change was made.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The participation the agent had with respect to the activity.

who Reference - The individual, device or organization that participated in the event.

health.fhir.r4.uscore501: USCoreProvenanceAgentProvenanceAuthor

Closed record

FHIR USCoreProvenanceAgentProvenanceAuthor datatype record.

Fields

Fields Included from * USCoreProvenanceAgent

extension Extension[]
role CodeableConcept[]
modifierExtension Extension[]
onBehalfOf Reference
id string
type CodeableConcept
who Reference
Element...

extension Extension[]? - May 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.

role CodeableConcept[]? - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

onBehalfOf Reference? - The individual, device, or organization for whom the change was made.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type USCoreProvenanceAgentType - The participation the agent had with respect to the activity.

who Reference - The individual, device or organization that participated in the event.

health.fhir.r4.uscore501: USCoreProvenanceAgentProvenanceTransmitter

Closed record

FHIR USCoreProvenanceAgentProvenanceTransmitter datatype record.

Fields

Fields Included from * USCoreProvenanceAgent

extension Extension[]
role CodeableConcept[]
modifierExtension Extension[]
onBehalfOf Reference
id string
type CodeableConcept
who Reference
Element...

extension Extension[]? - May 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.

role CodeableConcept[]? - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

onBehalfOf Reference? - The individual, device, or organization for whom the change was made.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type USCoreProvenanceAgentTypeOne - The participation the agent had with respect to the activity.

who Reference - The individual, device or organization that participated in the event.

health.fhir.r4.uscore501: USCoreProvenanceAgentType

Closed record

FHIR USCoreProvenanceAgentType datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreProvenanceAgentTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreProvenanceAgentTypeCoding

Closed record

FHIR USCoreProvenanceAgentTypeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/provenance-participant-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "author") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreProvenanceAgentTypeCodingOne

Closed record

FHIR USCoreProvenanceAgentTypeCodingOne datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "transmitter") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreProvenanceAgentTypeOne

Closed record

FHIR USCoreProvenanceAgentTypeOne datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreProvenanceAgentTypeCodingOne[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreProvenanceEntity

Closed record

FHIR USCoreProvenanceEntity datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

role USCoreProvenanceEntityRole - How the entity was used during the activity.

what Reference - Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.uscore501: USCoreProvenanceTarget

Closed record

FHIR USCoreProvenanceTarget datatype record.

Fields

Fields Included from * Reference

id string
extension Extension[]
reference string
type string
identifier Identifier
display string
Element...

reference string? - A 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.

identifier Identifier? - An 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.

extension Extension[]? - May 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.

display string? - Plain text narrative that identifies the resource in addition to the resource reference.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type uri? - The 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).

health.fhir.r4.uscore501: USCorePulseOximetryProfile

FHIR USCorePulseOximetryProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREPULSEOXIMETRYPROFILE(default RESOURCE_NAME_USCOREPULSEOXIMETRYPROFILE) - The type of the resource describes

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type.

code USCorePulseOximetryProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCorePulseOximetryProfileComponent[]? - Used when reporting flow rates or oxygen concentration.
- component Slicings
1. USCorePulseOximetryProfileComponentFlowRate: Inhaled oxygen flow rate
- min = 0
- max = 1
1. USCorePulseOximetryProfileComponentConcentration: Inhaled oxygen concentration
- min = 0
- max = 1

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCorePulseOximetryProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - Vital Signs value are typically recorded using the Quantity data type.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCorePulseOximetryProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCorePulseOximetryProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCorePulseOximetryProfileCategoryCoding

Closed record

FHIR USCorePulseOximetryProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCorePulseOximetryProfileCategoryVSCat

Closed record

FHIR USCorePulseOximetryProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePulseOximetryProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCorePulseOximetryProfileCode

Closed record

FHIR USCorePulseOximetryProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding Coding[]? - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCorePulseOximetryProfileCodeCodingO2Sat

Closed record

FHIR USCorePulseOximetryProfileCodeCodingO2Sat datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "2708-6") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePulseOximetryProfileCodeCodingPulseOx

Closed record

FHIR USCorePulseOximetryProfileCodeCodingPulseOx datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "59408-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponent

Closed record

FHIR USCorePulseOximetryProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentCode

Closed record

FHIR USCorePulseOximetryProfileComponentCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePulseOximetryProfileComponentCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentCodeCoding

Closed record

FHIR USCorePulseOximetryProfileComponentCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "3151-8") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentCodeCodingOne

Closed record

FHIR USCorePulseOximetryProfileComponentCodeCodingOne datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "3150-0") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentCodeOne

Closed record

FHIR USCorePulseOximetryProfileComponentCodeOne datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCorePulseOximetryProfileComponentCodeCodingOne[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentConcentration

Closed record

FHIR USCorePulseOximetryProfileComponentConcentration datatype record.

Fields

Fields Included from * USCorePulseOximetryProfileComponent

valueBoolean boolean
dataAbsentReason CodeableConcept
extension Extension[]
valueTime time
code CodeableConcept
valueRange Range
modifierExtension Extension[]
valueCodeableConcept CodeableConcept
valueRatio Ratio
valueString string
interpretation CodeableConcept[]
valueSampledData SampledData
valuePeriod Period
valueDateTime dateTime
id string
valueInteger integer
valueQuantity Quantity
Element...

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

code USCorePulseOximetryProfileComponentCodeOne - Describes what was observed. Sometimes this is called the observation 'code'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity USCorePulseOximetryProfileComponentValue? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentFlowRate

Closed record

FHIR USCorePulseOximetryProfileComponentFlowRate datatype record.

Fields

Fields Included from * USCorePulseOximetryProfileComponent

valueBoolean boolean
dataAbsentReason CodeableConcept
extension Extension[]
valueTime time
code CodeableConcept
valueRange Range
modifierExtension Extension[]
valueCodeableConcept CodeableConcept
valueRatio Ratio
valueString string
interpretation CodeableConcept[]
valueSampledData SampledData
valuePeriod Period
valueDateTime dateTime
id string
valueInteger integer
valueQuantity Quantity
Element...

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

code USCorePulseOximetryProfileComponentCode - Describes what was observed. Sometimes this is called the observation 'code'.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity USCorePulseOximetryProfileComponentValue? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCorePulseOximetryProfileComponentValue

Closed record

FHIR USCorePulseOximetryProfileComponentValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCorePulseOximetryProfileComponentValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

unit string - A human-readable form of the unit.

code code(default "L/min") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCorePulseOximetryProfileReferenceRange

Closed record

FHIR USCorePulseOximetryProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfile

FHIR USCoreQuestionnaireResponseProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREQUESTIONNAIRERESPONSEPROFILE(default RESOURCE_NAME_USCOREQUESTIONNAIRERESPONSEPROFILE) - The type of the resource describes

authored dateTime - Identifies when this version of the answer set was created. Changes whenever the answers are updated.

identifier Identifier? - A business identifier assigned to a particular completed (or partially completed) questionnaire.

partOf Reference[]? - A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

extension Extension[]? - An Extension
- extension Slicings
1. Extension: A signature attesting to the content
- min = 0
- max = *
1. Extension: E.g. Verbal, written, electronic
- min = 0
- max = 1

item USCoreQuestionnaireResponseProfileItem[]? - A group or question item from the original questionnaire for which answers are provided.

questionnaire USCoreQuestionnaireResponseProfileQuestionnaire - The Questionnaire that defines and organizes the questions for which answers are being provided.

author Reference? - Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

subject Reference - The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language code? - The base language in which the resource is written.

encounter Reference? - The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

'source Reference? - The person who answered the questions about the subject.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

meta USCoreQuestionnaireResponseProfileMeta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

status USCoreQuestionnaireResponseProfileStatus - The position of the questionnaire response within its overall lifecycle.

Element... - Rest field

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfileItem

Closed record

FHIR USCoreQuestionnaireResponseProfileItem datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - An Extension

linkId string - The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

answer USCoreQuestionnaireResponseProfileItemAnswer[]? - The respondent's answer(s) to the question.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

definition uri? - A reference to an ElementDefinition that provides the details for the item.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text that is displayed above the contents of the group or as the text of the question being answered.

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfileItemAnswer

Closed record

FHIR USCoreQuestionnaireResponseProfileItemAnswer datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueQuestionnaireResponseReference Reference? - The answer (or one of the answers) provided by the respondent to the question.

extension Extension[]? - An Extension

valueQuestionnaireResponseAttachment Attachment? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseTime time? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseQuantity Quantity? - The answer (or one of the answers) provided by the respondent to the question.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueQuestionnaireResponseBoolean boolean? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseString string? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseUri uri? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseCoding Coding? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseDecimal decimal? - The answer (or one of the answers) provided by the respondent to the question.

ordinalValue Extension? - A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores.

itemAnswerMedia Extension? - Media to render/make available as an accompaniment to a specific answer option

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuestionnaireResponseInteger integer? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseDate date? - The answer (or one of the answers) provided by the respondent to the question.

valueQuestionnaireResponseDateTime dateTime? - The answer (or one of the answers) provided by the respondent to the question.

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfileMeta

Closed record

FHIR USCoreQuestionnaireResponseProfileMeta datatype record.

Fields

Fields Included from * Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

lastUpdated instant? - When the resource last changed - e.g. when the version changed.

extension Extension[]? - May 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.

security Coding[]? - Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

versionId id? - The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

profile canonical[]? - A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source uri? - A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

tag Coding[]? - Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfileMetaTagSdoh

Closed record

FHIR USCoreQuestionnaireResponseProfileMetaTagSdoh datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://hl7.org/fhir/us/core/CodeSystem/us-core-tags") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "sdoh") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreQuestionnaireResponseProfileQuestionnaire

Closed record

FHIR USCoreQuestionnaireResponseProfileQuestionnaire datatype record.

Fields

extension Extension[]? - An Extension

id string? - unique id for the element within a resource (for internal references)

value string? - Primitive value for canonical

health.fhir.r4.uscore501: UsCoreRace

Closed record

Fields

Fields Included from * Base64BinaryExtension

url uri
valueBase64Binary base64Binary
id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

valueCoding Coding -

valueString string -

url uri -

health.fhir.r4.uscore501: USCoreRelatedPersonProfile

FHIR USCoreRelatedPersonProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORERELATEDPERSONPROFILE(default RESOURCE_NAME_USCORERELATEDPERSONPROFILE) - The type of the resource describes

identifier Identifier[]? - Identifier for a person within a particular scope.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

period Period? - The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

address Address[]? - Address where the related person can be contacted or visited.

gender USCoreRelatedPersonProfileGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active boolean - Whether this related person record is in active use.

photo Attachment[]? - Image of the person.

language code? - The base language in which the resource is written.

birthDate date? - The date on which the related person was born.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient Reference - The patient this person is related to.

name HumanName[]? - A name associated with the person.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication USCoreRelatedPersonProfileCommunication[]? - A language which may be used to communicate with about the patient's health.

relationship CodeableConcept[]? - The nature of the relationship between a patient and the related person.

Element... - Rest field

health.fhir.r4.uscore501: USCoreRelatedPersonProfileCommunication

Closed record

FHIR USCoreRelatedPersonProfileCommunication datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

preferred boolean? - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

health.fhir.r4.uscore501: USCoreRespiratoryRateProfile

FHIR USCoreRespiratoryRateProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORERESPIRATORYRATEPROFILE(default RESOURCE_NAME_USCORERESPIRATORYRATEPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code USCoreRespiratoryRateProfileCode - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

valueQuantity USCoreRespiratoryRateProfileValue? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreRespiratoryRateProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreRespiratoryRateProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreRespiratoryRateProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreRespiratoryRateProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileCategoryCoding

Closed record

FHIR USCoreRespiratoryRateProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileCategoryVSCat

Closed record

FHIR USCoreRespiratoryRateProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreRespiratoryRateProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileCode

Closed record

FHIR USCoreRespiratoryRateProfileCode datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreRespiratoryRateProfileCodeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileCodeCoding

Closed record

FHIR USCoreRespiratoryRateProfileCodeCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "9279-1") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileComponent

Closed record

FHIR USCoreRespiratoryRateProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileReferenceRange

Closed record

FHIR USCoreRespiratoryRateProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreRespiratoryRateProfileValue

Closed record

FHIR USCoreRespiratoryRateProfileValue datatype record.

Fields

Fields Included from * Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

comparator USCoreRespiratoryRateProfileValueComparator? - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension Extension[]? - May 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.

unit string - A human-readable form of the unit.

code code(default "/min") - A computer processable form of the unit in some unit representation system.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r4.uscore501: USCoreServiceRequestProfile

FHIR USCoreServiceRequestProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORESERVICEREQUESTPROFILE(default RESOURCE_NAME_USCORESERVICEREQUESTPROFILE) - The type of the resource describes

insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.

note Annotation[]? - Any other notes and comments made about the service request. For example, internal billing notes.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

requisition Identifier? - A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

subject Reference - On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reasonReference Reference[]? - Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.

language code? - The base language in which the resource is written.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

relevantHistory Reference[]? - Key events in the history of the request.

supportingInfo Reference[]? - Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

specimen Reference[]? - One or more specimens that the laboratory procedure will use.

quantityQuantity Quantity? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

quantityRatio Ratio? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

asNeededBoolean boolean? - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

locationReference Reference[]? - A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.

reasonCode CodeableConcept[]? - An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInfo.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform boolean? - Set this to true if the record is saying that the service/procedure should NOT be performed.

basedOn Reference[]? - Plan/proposal/order fulfilled by this request.

asNeededCodeableConcept CodeableConcept? - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

requester Reference? - The individual who initiated the request and has responsibility for its activation.

identifier Identifier[]? - Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

authoredOn dateTime? - When the request transitioned to being actionable.

performer Reference[]? - The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.

replaces Reference[]? - The request takes the place of the referenced completed or terminated request(s).

encounter Reference? - An encounter that provides additional information about the healthcare context in which this request is made.

occurrenceTiming Timing? - The date/time at which the requested service should occur.

quantityRange Range? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

priority USCoreServiceRequestProfilePriority? - Indicates how quickly the ServiceRequest should be addressed with respect to other requests.

intent USCoreServiceRequestProfileIntent - Whether the request is a proposal, plan, an original order or a reflex order.

performerType CodeableConcept? - Desired type of performer for doing the requested service.

bodySite CodeableConcept[]? - Anatomic location where the procedure should be performed. This is the target site.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

occurrencePeriod Period? - The date/time at which the requested service should occur.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime dateTime? - The date/time at which the requested service should occur.

orderDetail CodeableConcept[]? - Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.

category CodeableConcept[] - A code that classifies the service for searching, sorting and display purposes (e.g. 'Surgical Procedure').
- category Slicings
1. USCoreServiceRequestProfileCategoryUs_core: Classification of service
- min = 0
- max = *

locationCode CodeableConcept[]? - The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.

patientInstruction string? - Instructions in terms that are understood by the patient or consumer.

status USCoreServiceRequestProfileStatus - The status of the order.

Element... - Rest field

health.fhir.r4.uscore501: USCoreServiceRequestProfileCategoryUs_core

Closed record

FHIR USCoreServiceRequestProfileCategoryUs_core datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

health.fhir.r4.uscore501: USCoreSmokingStatusProfile

FHIR USCoreSmokingStatusProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCORESMOKINGSTATUSPROFILE(default RESOURCE_NAME_USCORESMOKINGSTATUSPROFILE) - The type of the resource describes

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn Reference[]? - A 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.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This 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.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreSmokingStatusProfileComponent[]? - Some 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.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreSmokingStatusProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

effectiveDateTime dateTime - The 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.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreSmokingStatusProfileCategorySocialHistory: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreSmokingStatusProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreSmokingStatusProfileCategoryCoding

Closed record

FHIR USCoreSmokingStatusProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "social-history") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r4.uscore501: USCoreSmokingStatusProfileCategorySocialHistory

Closed record

FHIR USCoreSmokingStatusProfileCategorySocialHistory datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreSmokingStatusProfileCategoryCoding[] - A reference to a code defined by a terminology system.

health.fhir.r4.uscore501: USCoreSmokingStatusProfileComponent

Closed record

FHIR USCoreSmokingStatusProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4.uscore501: USCoreSmokingStatusProfileReferenceRange

Closed record

FHIR USCoreSmokingStatusProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

health.fhir.r4.uscore501: USCoreVitalSignsProfile

FHIR USCoreVitalSignsProfile resource record.

Fields

Fields Included from * DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_USCOREVITALSIGNSPROFILE(default RESOURCE_NAME_USCOREVITALSIGNSPROFILE) - The type of the resource describes

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type.

code CodeableConcept - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The 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 focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus Reference[]? - The 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.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The 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.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type.

basedOn Reference[]? - A 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.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component USCoreVitalSignsProfileComponent[]? - Used when reporting component observation such as systolic and diastolic blood pressure.

contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

referenceRange USCoreVitalSignsProfileReferenceRange[]? - Guidance 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 referenceRange elements would be used.

valueString string? - Vital Signs value are typically recorded using the Quantity data type.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. USCoreVitalSignsProfileCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device Reference? - The device used to generate the observation data.

status USCoreVitalSignsProfileStatus - The status of the result value.

Element... - Rest field

health.fhir.r4.uscore501: USCoreVitalSignsProfileCategoryCoding

Closed record

FHIR USCoreVitalSignsProfileCategoryCoding datatype record.

Fields

Fields Included from * Coding

id string
extension Extension[]
system uri
version string
code code
display string
userSelected boolean
Element...

extension Extension[]? - May 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.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected boolean? - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display string? - A representation of the meaning of the code in the system, following the rules of the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r4.uscore501: USCoreVitalSignsProfileCategoryVSCat

Closed record

FHIR USCoreVitalSignsProfileCategoryVSCat datatype record.

Fields

Fields Included from * CodeableConcept

id string
extension Extension[]
coding Coding[]
text string
Element...

coding USCoreVitalSignsProfileCategoryCoding[] - A reference to a code defined by a terminology system.

extension Extension[]? - May 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.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r4.uscore501: USCoreVitalSignsProfileComponent

Closed record

FHIR USCoreVitalSignsProfileComponent datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - May 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.

valueTime time? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept CodeableConcept? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueString string? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueDateTime dateTime? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

valueQuantity Quantity? - Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.

health.fhir.r4.uscore501: USCoreVitalSignsProfileReferenceRange

Closed record

FHIR USCoreVitalSignsProfileReferenceRange datatype record.

Fields

Fields Included from * BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

extension Extension[]? - May 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.

high Quantity? - The 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).

low Quantity? - The 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).

modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo CodeableConcept[]? - Codes 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 appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text 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'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The 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.

Import

import ballerinax/health.fhir.r4.uscore501;

Metadata

Released date: 5 months ago

Version: 1.3.1

Compatibility

Platform: any

Ballerina version: 2201.8.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 356

Weekly downloads

Source repository

Keywords

Healthcare

FHIR

USCore

Contributors

Other versions

1.3.1

1.3.0 1.2.0 1.1.0 1.0.7

Cookie policy

Delete policy

functions

constants

enums

variables

records

ballerinax/health.fhir.r4.uscore501 Ballerina library

FHIR R4 US Core Implementation Guide - 5.0.1 - STU5 Release US

Sample Usage

Prerequisites

1. Parse JSON FHIR resource to FHIR resource model

2. Creating FHIR Resource models and serializing to JSON wire formats

Functions

initialize

Constants

health.fhir.r4.uscore501: PROFILE_BASE_USCOREALLERGYINTOLERANCE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBLOODPRESSUREPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBMIPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBODYHEIGHTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBODYTEMPERATUREPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREBODYWEIGHTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORECAREPLANPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORECARETEAM

health.fhir.r4.uscore501: PROFILE_BASE_USCORECONDITION

health.fhir.r4.uscore501: PROFILE_BASE_USCORECONDITIONENCOUNTERDIAGNOSISPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORECONDITIONPROBLEMSHEALTHCONCERNSPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING

health.fhir.r4.uscore501: PROFILE_BASE_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREDOCUMENTREFERENCEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREENCOUNTERPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREGOALPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREHEADCIRCUMFERENCEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREHEARTRATEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREIMMUNIZATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREIMPLANTABLEDEVICEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORELABORATORYRESULTOBSERVATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORELOCATION

health.fhir.r4.uscore501: PROFILE_BASE_USCOREMEDICATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREMEDICATIONREQUESTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONCLINICALTESTRESULTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONIMAGINGRESULTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSDOHASSESSMENT

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSEXUALORIENTATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSOCIALHISTORYPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREOBSERVATIONSURVEYPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREORGANIZATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPATIENTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICHEADOCCIPITALFRONTALCIRCUMFERENCEPERCENTILEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPRACTITIONERPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPRACTITIONERROLEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPROCEDUREPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPROVENANCE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREPULSEOXIMETRYPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREQUESTIONNAIRERESPONSEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORERELATEDPERSONPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORERESPIRATORYRATEPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORESERVICEREQUESTPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCORESMOKINGSTATUSPROFILE

health.fhir.r4.uscore501: PROFILE_BASE_USCOREVITALSIGNSPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREALLERGYINTOLERANCE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBLOODPRESSUREPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBMIPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBODYHEIGHTPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBODYTEMPERATUREPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREBODYWEIGHTPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECAREPLANPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECARETEAM

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECONDITION

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECONDITIONENCOUNTERDIAGNOSISPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCORECONDITIONPROBLEMSHEALTHCONCERNSPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREDOCUMENTREFERENCEPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREENCOUNTERPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREGOALPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREHEADCIRCUMFERENCEPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREHEARTRATEPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREIMMUNIZATIONPROFILE

health.fhir.r4.uscore501: RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE