Module health.fhir.r4.uscore501

ballerinax/health.fhir.r4.uscore501 Ballerina library

1.3.4

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

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