health.fhir.r4.uscore501
Module health.fhir.r4.uscore501
API
Declarations
Definitions
ballerinax/health.fhir.r4.uscore501 Ballerina library
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
function initialize()
This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.uscore501: PROFILE_BASE_USCOREALLERGYINTOLERANCE
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_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_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_USCOREORGANIZATIONPROFILE
health.fhir.r4.uscore501: PROFILE_BASE_USCOREPATIENTPROFILE
health.fhir.r4.uscore501: PROFILE_BASE_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE
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_USCORESMOKINGSTATUSPROFILE
health.fhir.r4.uscore501: PROFILE_BASE_USCOREVITALSIGNSPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREALLERGYINTOLERANCE
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_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_USCOREIMMUNIZATIONPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCORELABORATORYRESULTOBSERVATIONPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCORELOCATION
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREMEDICATIONPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREMEDICATIONREQUESTPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREORGANIZATIONPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPATIENTPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPRACTITIONERPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPRACTITIONERROLEPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPROCEDUREPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPROVENANCE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREPULSEOXIMETRYPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCORESMOKINGSTATUSPROFILE
health.fhir.r4.uscore501: RESOURCE_NAME_USCOREVITALSIGNSPROFILE
Enums
health.fhir.r4.uscore501: AllergyIntoleranceCategory
AllergyIntoleranceCategory enum
Members
health.fhir.r4.uscore501: AllergyIntoleranceCriticality
AllergyIntoleranceCriticality enum
Members
health.fhir.r4.uscore501: AllergyIntoleranceReactionSeverity
AllergyIntoleranceReactionSeverity enum
Members
health.fhir.r4.uscore501: AllergyIntoleranceType
AllergyIntoleranceType enum
Members
health.fhir.r4.uscore501: CarePlanActivityDetailKind
CarePlanActivityDetailKind enum
Members
health.fhir.r4.uscore501: CarePlanActivityDetailStatus
CarePlanActivityDetailStatus enum
Members
health.fhir.r4.uscore501: CarePlanIntent
CarePlanIntent enum
Members
health.fhir.r4.uscore501: CarePlanStatus
CarePlanStatus enum
Members
health.fhir.r4.uscore501: CarePlanTextStatus
CarePlanTextStatus enum
Members
health.fhir.r4.uscore501: CareTeamStatus
CareTeamStatus enum
Members
health.fhir.r4.uscore501: DeviceDeviceNameType
DeviceDeviceNameType enum
Members
health.fhir.r4.uscore501: DeviceStatus
DeviceStatus enum
Members
health.fhir.r4.uscore501: DeviceUdiCarrierEntryType
DeviceUdiCarrierEntryType enum
Members
health.fhir.r4.uscore501: DiagnosticReportStatus
DiagnosticReportStatus enum
Members
health.fhir.r4.uscore501: DiagnosticReportStatusOne
DiagnosticReportStatusOne enum
Members
health.fhir.r4.uscore501: DocumentReferenceDocStatus
DocumentReferenceDocStatus enum
Members
health.fhir.r4.uscore501: DocumentReferenceRelatesToCode
DocumentReferenceRelatesToCode enum
Members
health.fhir.r4.uscore501: DocumentReferenceStatus
DocumentReferenceStatus enum
Members
health.fhir.r4.uscore501: EncounterIdentifierUse
EncounterIdentifierUse enum
Members
health.fhir.r4.uscore501: EncounterLocationStatus
EncounterLocationStatus enum
Members
health.fhir.r4.uscore501: EncounterStatus
EncounterStatus enum
Members
health.fhir.r4.uscore501: EncounterStatusHistoryStatus
EncounterStatusHistoryStatus enum
Members
health.fhir.r4.uscore501: GoalLifecycleStatus
GoalLifecycleStatus enum
Members
health.fhir.r4.uscore501: ImmunizationStatus
ImmunizationStatus enum
Members
health.fhir.r4.uscore501: LocationAddressType
LocationAddressType enum
Members
health.fhir.r4.uscore501: LocationAddressUse
LocationAddressUse enum
Members
health.fhir.r4.uscore501: LocationHoursOfOperationDaysOfWeek
LocationHoursOfOperationDaysOfWeek enum
Members
health.fhir.r4.uscore501: LocationMode
LocationMode enum
Members
health.fhir.r4.uscore501: LocationStatus
LocationStatus enum
Members
health.fhir.r4.uscore501: MedicationRequestIntent
MedicationRequestIntent enum
Members
health.fhir.r4.uscore501: MedicationRequestPriority
MedicationRequestPriority enum
Members
health.fhir.r4.uscore501: MedicationRequestStatus
MedicationRequestStatus enum
Members
health.fhir.r4.uscore501: MedicationStatus
MedicationStatus enum
Members
health.fhir.r4.uscore501: ObservationComponentValueComparator
ObservationComponentValue[x]Comparator enum
Members
health.fhir.r4.uscore501: ObservationStatus
ObservationStatus enum
Members
health.fhir.r4.uscore501: ObservationStatusFive
ObservationStatusFive enum
Members
health.fhir.r4.uscore501: ObservationStatusFour
ObservationStatusFour enum
Members
health.fhir.r4.uscore501: ObservationStatusOne
ObservationStatusOne enum
Members
health.fhir.r4.uscore501: ObservationStatusThree
ObservationStatusThree enum
Members
health.fhir.r4.uscore501: ObservationStatusTwo
ObservationStatusTwo enum
Members
health.fhir.r4.uscore501: OrganizationAddressType
OrganizationAddressType enum
Members
health.fhir.r4.uscore501: OrganizationAddressUse
OrganizationAddressUse enum
Members
health.fhir.r4.uscore501: OrganizationIdentifierUse
OrganizationIdentifierUse enum
Members
health.fhir.r4.uscore501: PatientAddressType
PatientAddressType enum
Members
health.fhir.r4.uscore501: PatientAddressUse
PatientAddressUse enum
Members
health.fhir.r4.uscore501: PatientContactGender
PatientContactGender enum
Members
health.fhir.r4.uscore501: PatientGender
PatientGender enum
Members
health.fhir.r4.uscore501: PatientIdentifierUse
PatientIdentifierUse enum
Members
health.fhir.r4.uscore501: PatientLinkType
PatientLinkType enum
Members
health.fhir.r4.uscore501: PatientNameUse
PatientNameUse enum
Members
health.fhir.r4.uscore501: PatientTelecomSystem
PatientTelecomSystem enum
Members
health.fhir.r4.uscore501: PatientTelecomUse
PatientTelecomUse enum
Members
health.fhir.r4.uscore501: PractitionerGender
PractitionerGender enum
Members
health.fhir.r4.uscore501: PractitionerIdentifierUse
PractitionerIdentifierUse enum
Members
health.fhir.r4.uscore501: PractitionerNameUse
PractitionerNameUse enum
Members
health.fhir.r4.uscore501: PractitionerRoleAvailableTimeDaysOfWeek
PractitionerRoleAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.uscore501: PractitionerRoleTelecomSystem
PractitionerRoleTelecomSystem enum
Members
health.fhir.r4.uscore501: PractitionerRoleTelecomUse
PractitionerRoleTelecomUse enum
Members
health.fhir.r4.uscore501: ProcedureStatus
ProcedureStatus enum
Members
health.fhir.r4.uscore501: ProvenanceEntityRole
ProvenanceEntityRole enum
Members
Variables
health.fhir.r4.uscore501: terminologyProcessor
Terminology processor instance
health.fhir.r4.uscore501: fhirRegistry
FHIR registry instance
health.fhir.r4.uscore501: FHIR_VALUE_SETS
health.fhir.r4.uscore501: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.uscore501: AllergyIntoleranceReaction
FHIR AllergyIntoleranceReaction datatype record.
Fields
- severity AllergyIntoleranceReactionSeverity? - 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: BaseUSCoreAllergyIntoleranceMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreCarePlanProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreCareTeamMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreConditionMeta
Fields
- Fields Included from *Meta
- 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: BaseUSCoreDiagnosticReportProfileLaboratoryReportingMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreDiagnosticReportProfileNoteExchangeMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreDocumentReferenceProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreEncounterProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreGoalProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreImmunizationProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreImplantableDeviceProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreLaboratoryResultObservationProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreLocationMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreMedicationProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreMedicationRequestProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreOrganizationProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCorePatientProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCorePediatricBMIforAgeObservationProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCorePediatricWeightForHeightObservationProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCorePractitionerProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCorePractitionerRoleProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreProcedureProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreProvenanceMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCorePulseOximetryProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreSmokingStatusProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: BaseUSCoreVitalSignsProfileMeta
Fields
- Fields Included from *Meta
- id string? -
- extension Extension[]? -
- versionId id? -
- lastUpdated instant? -
- 'source uri? -
- profile canonical[](default ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs"]) -
- security Coding[]? -
- tag Coding[]? -
health.fhir.r4.uscore501: CarePlanActivity
FHIR CarePlanActivity datatype record.
Fields
- 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 CarePlanActivityDetail? - 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: CarePlanActivityDetail
FHIR CarePlanActivityDetail datatype record.
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.
- 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 CarePlanActivityDetailKind? - 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.
- productReference Reference? - 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.
- 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.
- 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.
- scheduledString string? - The period, timing or frequency upon which the described activity is to occur.
- statusReason CodeableConcept? - Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
- scheduledTiming Timing? - The period, timing or frequency upon which the described activity is to occur.
- scheduledPeriod Period? - The period, timing or frequency upon which the described activity is to occur.
- 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.
- productCodeableConcept CodeableConcept? - Identifies the food, drug or other product to be consumed or supplied in the activity.
- status CarePlanActivityDetailStatus - Identifies what progress is being made for the specific activity.
health.fhir.r4.uscore501: CareTeamParticipant
FHIR CareTeamParticipant datatype record.
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.
- 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: ConditionEvidence
FHIR ConditionEvidence datatype record.
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.
- 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: ConditionStage
FHIR ConditionStage datatype record.
Fields
- 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: DeviceDeviceName
FHIR DeviceDeviceName datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- name string - The name of the device.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type DeviceDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
health.fhir.r4.uscore501: DeviceProperty
FHIR DeviceProperty datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCode CodeableConcept[]? - Property value as a code, e.g., NTP4 (synced to NTP).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept - Code that specifies the property DeviceDefinitionPropetyCode (Extensible).
- valueQuantity Quantity[]? - Property value as a quantity.
health.fhir.r4.uscore501: DeviceSpecialization
FHIR DeviceSpecialization datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- systemType CodeableConcept - The standard that is used to operate and communicate.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version string? - The version of the standard that is used to operate and communicate.
health.fhir.r4.uscore501: DeviceUdiCarrier
FHIR DeviceUdiCarrier datatype record.
Fields
- entryType DeviceUdiCarrierEntryType? - A coded entry to indicate how the data was entered.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- deviceIdentifier string - The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
- carrierHRF string? - The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
- jurisdiction uri? - The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- carrierAIDC base64Binary? - The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
- issuer uri? - Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
health.fhir.r4.uscore501: DeviceVersion
FHIR DeviceVersion datatype record.
Fields
- component Identifier? - A single component of the device version.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept? - The type of the device version.
- value string - The version text.
health.fhir.r4.uscore501: DiagnosticReportMedia
FHIR DiagnosticReportMedia datatype record.
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.
- 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: DiagnosticReportMediaOne
FHIR DiagnosticReportMediaOne datatype record.
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.
- 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: DocumentReferenceContent
FHIR DocumentReferenceContent datatype record.
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.
- 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: DocumentReferenceContext
FHIR DocumentReferenceContext datatype record.
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.
- period Period? - The time period over which the service that is described by the document was provided.
- related Reference[]? - Related identifiers or resources associated with the DocumentReference.
- 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: DocumentReferenceRelatesTo
FHIR DocumentReferenceRelatesTo datatype record.
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.
- code DocumentReferenceRelatesToCode - 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: EncounterClassHistory
FHIR EncounterClassHistory datatype record.
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.
- 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: EncounterDiagnosis
FHIR EncounterDiagnosis datatype record.
Fields
- 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: EncounterHospitalization
FHIR EncounterHospitalization datatype record.
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.
- 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: EncounterLocation
FHIR EncounterLocation datatype record.
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.
- 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 EncounterLocationStatus? - 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: EncounterParticipant
FHIR EncounterParticipant datatype record.
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.
- 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: EncounterStatusHistory
FHIR EncounterStatusHistory datatype record.
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.
- 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 EncounterStatusHistoryStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
health.fhir.r4.uscore501: GoalTarget
FHIR GoalTarget datatype record.
Fields
- 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.
- 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.
- 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.
- 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).
- 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.
- due date? - Indicates either the date or the duration after start by which the goal should be met.
- 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.
- 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: ImmunizationEducation
FHIR ImmunizationEducation datatype record.
Fields
- reference uri? - Reference pointer to the educational material given to the patient if the information was on line.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- documentType string? - Identifier of the material presented to the patient.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- presentationDate dateTime? - Date the educational material was given to the patient.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- publicationDate dateTime? - Date the educational material was published.
health.fhir.r4.uscore501: ImmunizationPerformer
FHIR ImmunizationPerformer datatype record.
Fields
- actor Reference - The practitioner or organization who performed the action.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 'function CodeableConcept? - Describes the type of performance (e.g. ordering provider, administering provider, etc.).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: ImmunizationProtocolApplied
FHIR ImmunizationProtocolApplied datatype record.
Fields
- doseNumberString string - Nominal position in a series.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.
- series string? - One possible path to achieve presumed immunity against a disease - within the context of an authority.
- authority Reference? - Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
- doseNumberPositiveInt positiveInt - Nominal position in a series.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- targetDisease CodeableConcept[]? - The vaccine preventable disease the dose is being administered against.
- seriesDosesString string? - The recommended number of doses to achieve immunity.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: ImmunizationReaction
FHIR ImmunizationReaction datatype record.
Fields
- date dateTime? - Date of reaction to the immunization.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reported boolean? - Self-reported indicator.
- detail Reference? - Details of the reaction.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: LocationHoursOfOperation
FHIR LocationHoursOfOperation datatype record.
Fields
- allDay boolean? - The Location is open all day.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- closingTime time? - Time that the Location closes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- openingTime time? - Time that the Location opens.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- daysOfWeek LocationHoursOfOperationDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.
health.fhir.r4.uscore501: LocationPosition
FHIR LocationPosition datatype record.
Fields
- altitude decimal? - Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- latitude decimal - Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- longitude decimal - Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
health.fhir.r4.uscore501: MedicationBatch
FHIR MedicationBatch datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- lotNumber string? - The assigned lot number of a batch of the specified product.
- expirationDate dateTime? - When this specific batch of product will expire.
health.fhir.r4.uscore501: MedicationIngredient
FHIR MedicationIngredient datatype record.
Fields
- itemReference Reference - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- strength Ratio? - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
- itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- isActive boolean? - Indication of whether this ingredient affects the therapeutic action of the drug.
health.fhir.r4.uscore501: MedicationRequestDispenseRequest
FHIR MedicationRequestDispenseRequest datatype record.
Fields
- validityPeriod Period? - This indicates the validity period of a prescription (stale dating the Prescription).
- dispenseInterval Duration? - The minimum period of time that must occur between dispenses of the medication.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- performer Reference? - Indicates the intended dispensing Organization specified by the prescriber.
- quantity Quantity? - The amount that is to be dispensed for one fill.
- numberOfRepeatsAllowed unsignedInt? - An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus '3 repeats', then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- initialFill MedicationRequestDispenseRequestInitialFill? - Indicates the quantity or duration for the first dispense of the medication.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- expectedSupplyDuration Duration? - Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
health.fhir.r4.uscore501: MedicationRequestDispenseRequestInitialFill
FHIR MedicationRequestDispenseRequestInitialFill datatype record.
Fields
- duration Duration? - The length of time that the first dispense is expected to last.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- quantity Quantity? - The amount or quantity to provide as part of the first dispense.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: MedicationRequestSubstitution
FHIR MedicationRequestSubstitution datatype record.
Fields
- allowedCodeableConcept CodeableConcept - True if the prescriber allows a different drug to be dispensed from what was prescribed.
- reason CodeableConcept? - Indicates the reason for the substitution, or why substitution must or must not be performed.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- allowedBoolean boolean - True if the prescriber allows a different drug to be dispensed from what was prescribed.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: ObservationComponent
FHIR ObservationComponent datatype record.
Fields
- valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.
- valueString string? - The information determined as a result of making the observation, if the information has a simple value.
- interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.
- valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.
- valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.uscore501: ObservationComponentFive
FHIR ObservationComponentFive datatype record.
Fields
- valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.
- valueString string? - The information determined as a result of making the observation, if the information has a simple value.
- interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.
- valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.
- valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.uscore501: ObservationComponentFour
FHIR ObservationComponentFour datatype record.
Fields
- 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: ObservationComponentOne
FHIR ObservationComponentOne datatype record.
Fields
- valueBoolean boolean? - Vital Sign Value recorded with UCUM.
- 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 Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - Vital Sign Value recorded with UCUM.
- 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 Sign Value recorded with UCUM.
- valueRatio Ratio? - Vital Sign Value recorded with UCUM.
- valueString string? - Vital Sign Value recorded with UCUM.
- interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData SampledData? - Vital Sign Value recorded with UCUM.
- valuePeriod Period? - Vital Sign Value recorded with UCUM.
- valueDateTime dateTime? - Vital Sign Value recorded with UCUM.
- 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 Sign Value recorded with UCUM.
- valueQuantity Quantity? - Vital Sign Value recorded with UCUM.
health.fhir.r4.uscore501: ObservationComponentThree
FHIR ObservationComponentThree datatype record.
Fields
- 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.
- value 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.
- 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: ObservationComponentTwo
FHIR ObservationComponentTwo datatype record.
Fields
- valueBoolean boolean? - Vital Sign Value recorded with UCUM.
- 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 Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - Vital Sign Value recorded with UCUM.
- 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 Sign Value recorded with UCUM.
- valueRatio Ratio? - Vital Sign Value recorded with UCUM.
- valueString string? - Vital Sign Value recorded with UCUM.
- interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData SampledData? - Vital Sign Value recorded with UCUM.
- valuePeriod Period? - Vital Sign Value recorded with UCUM.
- valueDateTime dateTime? - Vital Sign Value recorded with UCUM.
- 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 Sign Value recorded with UCUM.
- valueQuantity Quantity? - Vital Sign Value recorded with UCUM.
health.fhir.r4.uscore501: ObservationReferenceRange
FHIR ObservationReferenceRange datatype record.
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.
- 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: ObservationReferenceRangeFive
FHIR ObservationReferenceRangeFive datatype record.
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.
- 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: ObservationReferenceRangeFour
FHIR ObservationReferenceRangeFour datatype record.
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.
- 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: ObservationReferenceRangeOne
FHIR ObservationReferenceRangeOne datatype record.
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.
- 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: ObservationReferenceRangeThree
FHIR ObservationReferenceRangeThree datatype record.
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.
- 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: ObservationReferenceRangeTwo
FHIR ObservationReferenceRangeTwo datatype record.
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.
- 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: OrganizationContact
FHIR OrganizationContact datatype record.
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.
- address Address? - Visiting or postal addresses for the contact.
- purpose CodeableConcept? - Indicates a purpose for which the contact can be reached.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- name HumanName? - A name associated with the contact.
- telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: PatientCommunication
FHIR PatientCommunication datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- preferred boolean? - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
health.fhir.r4.uscore501: PatientContact
FHIR PatientContact datatype record.
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.
- period Period? - The period during which this contact person or organization is valid to be contacted relating to this patient.
- address Address? - Address for the contact person.
- gender PatientContactGender? - Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- organization Reference? - Organization on behalf of which the contact is acting or for which the contact is working.
- name HumanName? - A name associated with the contact person.
- telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- relationship CodeableConcept[]? - The nature of the relationship between the patient and the contact person.
health.fhir.r4.uscore501: PatientLink
FHIR PatientLink datatype record.
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.
- other Reference - The other patient resource that the link refers to.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type PatientLinkType - The type of link between this patient resource and another patient resource.
health.fhir.r4.uscore501: PractitionerQualification
FHIR PractitionerQualification datatype record.
Fields
- identifier Identifier[]? - An identifier that applies to this person's qualification in this role.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - Period during which the qualification is valid.
- code CodeableConcept - Coded representation of the qualification.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- issuer Reference? - Organization that regulates and issues the qualification.
health.fhir.r4.uscore501: PractitionerRoleAvailableTime
FHIR PractitionerRoleAvailableTime datatype record.
Fields
- allDay boolean? - Is this always available? (hence times are irrelevant) e.g. 24 hour service.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- availableEndTime time? - The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- daysOfWeek PractitionerRoleAvailableTimeDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.
- availableStartTime time? - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
health.fhir.r4.uscore501: PractitionerRoleNotAvailable
FHIR PractitionerRoleNotAvailable datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string - The reason that can be presented to the user as to why this time is not available.
- during Period? - Service is not available (seasonally or for a public holiday) from this date.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: ProcedureFocalDevice
FHIR ProcedureFocalDevice datatype record.
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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- action CodeableConcept? - The kind of change that happened to the device during the procedure.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- manipulated Reference - The device that was manipulated (changed) during the procedure.
health.fhir.r4.uscore501: ProcedurePerformer
FHIR ProcedurePerformer datatype record.
Fields
- actor Reference - The practitioner who was involved in the procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 'function CodeableConcept? - Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- onBehalfOf Reference? - The organization the device or practitioner was acting on behalf of.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: ProvenanceAgent
FHIR ProvenanceAgent datatype record.
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.
- role CodeableConcept[]? - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- onBehalfOf Reference? - The individual, device, or organization for whom the change was made.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept? - The participation the agent had with respect to the activity.
- who Reference - The individual, device or organization that participated in the event.
health.fhir.r4.uscore501: ProvenanceEntity
FHIR ProvenanceEntity datatype record.
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.
- role ProvenanceEntityRole - How the entity was used during the activity.
- what Reference - Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.uscore501: USCoreAllergyIntolerance
FHIR USCoreAllergyIntolerance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREALLERGYINTOLERANCE(default RESOURCE_NAME_USCOREALLERGYINTOLERANCE) - The type of the resource describes
- meta BaseUSCoreAllergyIntoleranceMeta(default { profile : [PROFILE_BASE_USCOREALLERGYINTOLERANCE] }) - 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 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 AllergyIntoleranceCriticality? - 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 AllergyIntoleranceType? - 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 AllergyIntoleranceReaction[]? - 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.
- 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 AllergyIntoleranceCategory[]? - Category of the identified substance.
- never... - Rest field
health.fhir.r4.uscore501: USCoreCarePlanProfile
FHIR USCoreCarePlanProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCORECAREPLANPROFILE(default RESOURCE_NAME_USCORECAREPLANPROFILE) - The type of the resource describes
- meta BaseUSCoreCarePlanProfileMeta(default { profile : [PROFILE_BASE_USCORECAREPLANPROFILE] }) - 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[]? - 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 CarePlanActivity[]? - 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 Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- basedOn Reference[]? - 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 CarePlanIntent - 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.
- 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.
- status CarePlanStatus - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
- never... - Rest field
health.fhir.r4.uscore501: USCoreCareTeam
FHIR USCoreCareTeam resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCORECARETEAM(default RESOURCE_NAME_USCORECARETEAM) - The type of the resource describes
- meta BaseUSCoreCareTeamMeta(default { profile : [PROFILE_BASE_USCORECARETEAM] }) - 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.
- 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 CareTeamParticipant[] - 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.
- 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 CareTeamStatus? - Indicates the current state of the care team.
- never... - Rest field
health.fhir.r4.uscore501: USCoreCondition
FHIR USCoreCondition resource record.
Fields
- Fields Included from *DomainResource
- 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 ConditionEvidence[]? - 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 ConditionStage[]? - 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: USCoreDiagnosticReportProfileLaboratoryReporting
FHIR USCoreDiagnosticReportProfileLaboratoryReporting resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING(default RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING) - The type of the resource describes
- meta BaseUSCoreDiagnosticReportProfileLaboratoryReportingMeta(default { profile : [PROFILE_BASE_USCOREDIAGNOSTICREPORTPROFILELABORATORYREPORTING] }) - 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.
- 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 DiagnosticReportMediaOne[]? - 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 - This is the Specimen Collection Datetime or Period which is the physically relevent dateTime for laboratory tests.
- 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 - This is the Specimen Collection Datetime or Period which is the physically relevent dateTime for laboratory tests.
- 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.
- 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 DiagnosticReportStatusOne - The status of the diagnostic report.
- never... - Rest field
health.fhir.r4.uscore501: USCoreDiagnosticReportProfileNoteExchange
FHIR USCoreDiagnosticReportProfileNoteExchange resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE(default RESOURCE_NAME_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE) - The type of the resource describes
- meta BaseUSCoreDiagnosticReportProfileNoteExchangeMeta(default { profile : [PROFILE_BASE_USCOREDIAGNOSTICREPORTPROFILENOTEEXCHANGE] }) - 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.
- 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 DiagnosticReportMedia[]? - 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 - This is the Datetime or Period when the report or note was written.
- 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 - This is the Datetime or Period when the report or note was written.
- 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.
- 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 DiagnosticReportStatus - The status of the diagnostic report.
- never... - Rest field
health.fhir.r4.uscore501: USCoreDocumentReferenceProfile
FHIR USCoreDocumentReferenceProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREDOCUMENTREFERENCEPROFILE(default RESOURCE_NAME_USCOREDOCUMENTREFERENCEPROFILE) - The type of the resource describes
- meta BaseUSCoreDocumentReferenceProfileMeta(default { profile : [PROFILE_BASE_USCOREDOCUMENTREFERENCEPROFILE] }) - 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.
- 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.
- 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.
- 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).
- 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.
- 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.
- '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.
- content DocumentReferenceContent - 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 DocumentReferenceDocStatus? - The status of the underlying document.
- context DocumentReferenceContext? - 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.
- 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.
- relatesTo DocumentReferenceRelatesTo[]? - Relationships that this document has with other document references that already exist.
- authenticator Reference? - Which person or organization authenticates that this document is valid.
- status DocumentReferenceStatus - The status of this document reference.
- never... - Rest field
health.fhir.r4.uscore501: USCoreEncounterProfile
FHIR USCoreEncounterProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREENCOUNTERPROFILE(default RESOURCE_NAME_USCOREENCOUNTERPROFILE) - The type of the resource describes
- meta BaseUSCoreEncounterProfileMeta(default { profile : [PROFILE_BASE_USCOREENCOUNTERPROFILE] }) - 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.
- 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 EncounterParticipant[]? - 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 Identifier[]? - Identifier(s) by which this encounter is known.
- period Period? - The start and end time of the encounter.
- classHistory EncounterClassHistory[]? - 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 EncounterHospitalization? - 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 EncounterDiagnosis[]? - 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 EncounterStatusHistory[]? - 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.
- 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 EncounterLocation[]? - 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 EncounterStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
- never... - Rest field
health.fhir.r4.uscore501: USCoreGoalProfile
FHIR USCoreGoalProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREGOALPROFILE(default RESOURCE_NAME_USCOREGOALPROFILE) - The type of the resource describes
- meta BaseUSCoreGoalProfileMeta(default { profile : [PROFILE_BASE_USCOREGOALPROFILE] }) - 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.
- 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 GoalLifecycleStatus - Type of plan.
- outcomeReference Reference[]? - Details of what's changed (or not changed).
- 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 CodeableConcept - proposed | draft | active | completed | cancelled.
- 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 GoalTarget[]? - 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.
- 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.
- never... - Rest field
health.fhir.r4.uscore501: USCoreImmunizationProfile
FHIR USCoreImmunizationProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREIMMUNIZATIONPROFILE(default RESOURCE_NAME_USCOREIMMUNIZATIONPROFILE) - The type of the resource describes
- meta BaseUSCoreImmunizationProfileMeta(default { profile : [PROFILE_BASE_USCOREIMMUNIZATIONPROFILE] }) - 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[]? - Extra information about the immunization that is not conveyed by the other attributes.
- primarySource boolean - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- education ImmunizationEducation[]? - Educational material presented to the patient (or guardian) at the time of vaccine administration.
- doseQuantity Quantity? - The quantity of vaccine product that was administered.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Condition, Observation or DiagnosticReport that supports why the immunization was administered.
- language code? - The base language in which the resource is written.
- manufacturer Reference? - Name of vaccine manufacturer.
- programEligibility CodeableConcept[]? - Indicates a patient's eligibility for a funding program.
- statusReason CodeableConcept? - Indicates the reason the immunization event was not performed.
- isSubpotent boolean? - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
- patient Reference - The patient who either received or did not receive the immunization.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - Reasons why the vaccine was administered.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- vaccineCode CodeableConcept - Vaccine that was administered or was to be administered.
- expirationDate date? - Date vaccine batch expires.
- identifier Identifier[]? - A unique identifier assigned to this immunization record.
- performer ImmunizationPerformer[]? - Indicates who performed the immunization event.
- reaction ImmunizationReaction[]? - Categorical data indicating that an adverse event is associated in time to an immunization.
- subpotentReason CodeableConcept[]? - Reason why a dose is considered to be subpotent.
- encounter Reference? - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
- lotNumber string? - Lot number of the vaccine product.
- recorded dateTime? - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- site CodeableConcept? - Body site where vaccine was administered.
- route CodeableConcept? - The path by which the vaccine product is taken into the body.
- protocolApplied ImmunizationProtocolApplied[]? - The protocol (set of recommendations) being followed by the provider who administered the dose.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- reportOrigin CodeableConcept? - The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
- location Reference? - The service delivery location where the vaccine administration occurred.
- occurrenceDateTime dateTime - Date vaccine administered or was to be administered.
- occurrenceString string - Date vaccine administered or was to be administered.
- fundingSource CodeableConcept? - Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
- status ImmunizationStatus - Indicates the current status of the immunization event.
- never... - Rest field
health.fhir.r4.uscore501: USCoreImplantableDeviceProfile
FHIR USCoreImplantableDeviceProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE(default RESOURCE_NAME_USCOREIMPLANTABLEDEVICEPROFILE) - The type of the resource describes
- meta BaseUSCoreImplantableDeviceProfileMeta(default { profile : [PROFILE_BASE_USCOREIMPLANTABLEDEVICEPROFILE] }) - 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[]? - Descriptive information, usage information or implantation information that is not captured in an existing element.
- parent Reference? - The parent device.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- distinctIdentifier string? - The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
- 'type CodeableConcept - The kind or type of device.
- deviceName DeviceDeviceName[]? - This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
- manufacturer string? - A name of the manufacturer.
- statusReason CodeableConcept[]? - Reason for the dtatus of the Device availability.
- patient Reference - Patient information, If the device is affixed to a person.
- safety CodeableConcept[]? - Provides additional safety characteristics about a medical device. For example devices containing latex.
- contact ContactPoint[]? - Contact details for an organization or a particular human that is responsible for the device.
- property DeviceProperty[]? - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
- manufactureDate dateTime? - The date and time when the device was manufactured.
- definition Reference? - The reference to the definition for the device.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- expirationDate dateTime? - The date and time beyond which this device is no longer valid or should not be used (if applicable).
- owner Reference? - An organization that is responsible for the provision and ongoing maintenance of the device.
- identifier Identifier[]? - Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
- serialNumber string? - The serial number assigned by the organization when the device was manufactured.
- lotNumber string? - Lot number assigned by the manufacturer.
- 'version DeviceVersion[]? - The actual design of the device or software version running on the device.
- url uri? - A network address on which the device may be contacted directly.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- udiCarrier DeviceUdiCarrier? - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- specialization DeviceSpecialization[]? - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
- location Reference? - The place where the device can be found.
- modelNumber string? - The model number for the device.
- partNumber string? - The part number of the device.
- status DeviceStatus? - Status of the Device availability.
- never... - Rest field
health.fhir.r4.uscore501: USCoreLaboratoryResultObservationProfile
FHIR USCoreLaboratoryResultObservationProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCORELABORATORYRESULTOBSERVATIONPROFILE(default RESOURCE_NAME_USCORELABORATORYRESULTOBSERVATIONPROFILE) - The type of the resource describes
- meta BaseUSCoreLaboratoryResultObservationProfileMeta(default { profile : [PROFILE_BASE_USCORELABORATORYRESULTOBSERVATIONPROFILE] }) - 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.
- valueBoolean boolean? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- code CodeableConcept - The test that was performed. A LOINC SHALL be used if the concept is present in LOINC.
- subject Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focus
element or thecode
itself specifies the actual focus of the observation.
- valueRange Range? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus Reference[]? - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language code? - The base language in which the resource is written.
- valueCodeableConcept CodeableConcept? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- valueRatio Ratio? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- specimen Reference? - The specimen that was used when this observation was made.
- derivedFrom Reference[]? - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime dateTime? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger integer? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity Quantity? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- identifier Identifier[]? - A unique identifier assigned to this observation.
- performer Reference[]? - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod Period? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
- effectiveTiming Timing? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
- method CodeableConcept? - Indicates the mechanism used to perform the observation.
- hasMember Reference[]? - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component ObservationComponent[]? - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- referenceRange ObservationReferenceRange[]? - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString string? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- effectiveDateTime dateTime? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
- interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData SampledData? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- valuePeriod Period? - The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[] - A code that classifies the general type of observation being made.
- device Reference? - The device used to generate the observation data.
- effectiveInstant instant? - For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
- status ObservationStatus - The status of the result value.
- never... - Rest field
health.fhir.r4.uscore501: USCoreLocation
FHIR USCoreLocation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCORELOCATION(default RESOURCE_NAME_USCORELOCATION) - The type of the resource describes
- meta BaseUSCoreLocationMeta(default { profile : [PROFILE_BASE_USCORELOCATION] }) - 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.
- operationalStatus Coding? - The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
- partOf Reference? - Another Location of which this Location is physically a part of.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - Description of the Location, which helps in finding or referencing the place.
- hoursOfOperation LocationHoursOfOperation[]? - What days/times during a week is this location usually open.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept[]? - Indicates the type of function performed at the location.
- mode LocationMode? - Indicates whether a resource instance represents a specific location or a class of locations.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the location.
- alias string[]? - A list of alternate names that the location is known as, or was known as, in the past.
- telecom ContactPoint[]? - The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- identifier Identifier[]? - Unique code or number identifying the location to its users.
- address Address? - Physical location.
- physicalType CodeableConcept? - Physical form of the location, e.g. building, room, vehicle, road.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- managingOrganization Reference? - The organization responsible for the provisioning and upkeep of the location.
- name string - Name of the location as used by humans. Does not need to be unique.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- position LocationPosition? - The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
- availabilityExceptions string? - A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
- status LocationStatus? - The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
- never... - Rest field
health.fhir.r4.uscore501: USCoreMedicationProfile
FHIR USCoreMedicationProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREMEDICATIONPROFILE(default RESOURCE_NAME_USCOREMEDICATIONPROFILE) - The type of the resource describes
- meta BaseUSCoreMedicationProfileMeta(default { profile : [PROFILE_BASE_USCOREMEDICATIONPROFILE] }) - 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.
- identifier Identifier[]? - Business identifier for this medication.
- amount Ratio? - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
- ingredient MedicationIngredient[]? - Identifies a particular constituent of interest in the product.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- batch MedicationBatch? - Information that only applies to packages (not products).
- language code? - The base language in which the resource is written.
- manufacturer Reference? - Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- form CodeableConcept? - Describes the form of the item. Powder; tablets; capsule.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- status MedicationStatus? - A code to indicate if the medication is in active use.
- never... - Rest field
health.fhir.r4.uscore501: USCoreMedicationRequestProfile
FHIR USCoreMedicationRequestProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREMEDICATIONREQUESTPROFILE(default RESOURCE_NAME_USCOREMEDICATIONREQUESTPROFILE) - The type of the resource describes
- meta BaseUSCoreMedicationRequestProfileMeta(default { profile : [PROFILE_BASE_USCOREMEDICATIONREQUESTPROFILE] }) - 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.
- insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
- note Annotation[]? - Extra information about the prescription that could not be conveyed by the other attributes.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- substitution MedicationRequestSubstitution? - Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
- courseOfTherapyType CodeableConcept? - The description of the overall patte3rn of the administration of the medication to the patient.
- priorPrescription Reference? - A link to a resource representing an earlier order related order or prescription.
- subject Reference - A link to a resource representing the person or set of individuals to whom the medication will be given.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Condition or observation that supports why the medication was ordered.
- language code? - The base language in which the resource is written.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
- medicationReference Reference - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- reportedReference Reference? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- statusReason CodeableConcept? - Captures the reason for the current state of the MedicationRequest.
- dispenseRequest MedicationRequestDispenseRequest? - Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - The reason or the indication for ordering or not ordering the medication.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- doNotPerform boolean? - If true indicates that the provider is asking for the medication request not to occur.
- basedOn Reference[]? - A plan or request that is fulfilled in whole or in part by this medication request.
- requester Reference - The individual, organization, or device that initiated the request and has responsibility for its activation.
- identifier Identifier[]? - Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
- reportedBoolean boolean? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- authoredOn dateTime - The date (and perhaps time) when the prescription was initially written or authored on.
- performer Reference? - The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
- detectedIssue Reference[]? - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
- supportingInformation Reference[]? - Include additional information (for example, patient height and weight) that supports the ordering of the medication.
- encounter Reference? - The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
- instantiatesCanonical canonical[]? - The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
- medicationCodeableConcept CodeableConcept - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- priority MedicationRequestPriority? - Indicates how quickly the Medication Request should be addressed with respect to other requests.
- intent MedicationRequestIntent - Whether the request is a proposal, plan, or an original order.
- performerType CodeableConcept? - Indicates the type of performer of the administration of the medication.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- dosageInstruction Dosage[]? - Indicates how the medication is to be used by the patient.
- eventHistory Reference[]? - Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[]? - Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- groupIdentifier Identifier? - A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
- status MedicationRequestStatus - A code specifying the current state of the order. Generally, this will be active or completed state.
- never... - Rest field
health.fhir.r4.uscore501: USCoreOrganizationProfile
FHIR USCoreOrganizationProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREORGANIZATIONPROFILE(default RESOURCE_NAME_USCOREORGANIZATIONPROFILE) - The type of the resource describes
- meta BaseUSCoreOrganizationProfileMeta(default { profile : [PROFILE_BASE_USCOREORGANIZATIONPROFILE] }) - 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.
- identifier Identifier[]? - Identifier for the organization that is used to identify the organization across multiple disparate systems.
- partOf Reference? - The organization of which this organization forms a part.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- address Address[]? - An address for the organization.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active boolean - Whether the organization's record is still in active use.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept[]? - The kind(s) of organization that this is.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the organization.
- contact OrganizationContact[]? - Contact for the organization for a certain purpose.
- name string - A name associated with the organization.
- alias string[]? - A list of alternate names that the organization is known as, or was known as in the past.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A contact detail for the organization.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- never... - Rest field
health.fhir.r4.uscore501: USCorePatientProfile
FHIR USCorePatientProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPATIENTPROFILE(default RESOURCE_NAME_USCOREPATIENTPROFILE) - The type of the resource describes
- meta BaseUSCorePatientProfileMeta(default { profile : [PROFILE_BASE_USCOREPATIENTPROFILE] }) - 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.
- extension Extension[]? - An Extension
- gender PatientGender - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- link PatientLink[]? - Link to another patient resource that concerns the same actual patient.
- language code? - The base language in which the resource is written.
- contact PatientContact[]? - A contact party (e.g. guardian, partner, friend) for the patient.
- deceasedDateTime dateTime? - Indicates if the individual is deceased or not.
- generalPractitioner Reference[]? - Patient's nominated care provider.
- telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- communication PatientCommunication[]? - A language which may be used to communicate with the patient about his or her health.
- identifier Identifier[] - An identifier for this patient.
- address Address[]? - An address for the individual.
- multipleBirthBoolean boolean? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- active boolean? - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- photo Attachment[]? - Image of the patient.
- birthDate date? - The date of birth for the individual.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- deceasedBoolean boolean? - Indicates if the individual is deceased or not.
- managingOrganization Reference? - Organization that is the custodian of the patient record.
- multipleBirthInteger integer? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- name HumanName[] - A name associated with the individual.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- maritalStatus CodeableConcept? - This field contains a patient's most recent marital (civil) status.
- never... - Rest field
health.fhir.r4.uscore501: USCorePediatricBMIforAgeObservationProfile
FHIR USCorePediatricBMIforAgeObservationProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE(default RESOURCE_NAME_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE) - The type of the resource describes
- meta BaseUSCorePediatricBMIforAgeObservationProfileMeta(default { profile : [PROFILE_BASE_USCOREPEDIATRICBMIFORAGEOBSERVATIONPROFILE] }) - 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.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - 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 thecode
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.
- value Quantity? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- identifier Identifier[]? - A unique identifier assigned to this observation.
- performer Reference[]? - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod Period - 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 ObservationComponentTwo[]? - Used when reporting 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 ObservationReferenceRangeTwo[]? - 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.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[] - A code that classifies the general type of observation being made.
- device Reference? - The device used to generate the observation data.
- status ObservationStatusTwo - The status of the result value.
- never... - Rest field
health.fhir.r4.uscore501: USCorePediatricWeightForHeightObservationProfile
FHIR USCorePediatricWeightForHeightObservationProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE(default RESOURCE_NAME_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE) - The type of the resource describes
- meta BaseUSCorePediatricWeightForHeightObservationProfileMeta(default { profile : [PROFILE_BASE_USCOREPEDIATRICWEIGHTFORHEIGHTOBSERVATIONPROFILE] }) - 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.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - 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 thecode
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.
- value Quantity? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- identifier Identifier[]? - A unique identifier assigned to this observation.
- performer Reference[]? - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod Period - 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 ObservationComponentOne[]? - Used when reporting 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 ObservationReferenceRangeOne[]? - 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.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[] - A code that classifies the general type of observation being made.
- device Reference? - The device used to generate the observation data.
- status ObservationStatusOne - The status of the result value.
- never... - Rest field
health.fhir.r4.uscore501: USCorePractitionerProfile
FHIR USCorePractitionerProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPRACTITIONERPROFILE(default RESOURCE_NAME_USCOREPRACTITIONERPROFILE) - The type of the resource describes
- meta BaseUSCorePractitionerProfileMeta(default { profile : [PROFILE_BASE_USCOREPRACTITIONERPROFILE] }) - 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.
- identifier Identifier[] - An identifier that applies to this person in this role.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- address Address[]? - Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
- gender PractitionerGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active boolean? - Whether this practitioner's record is in active use.
- photo Attachment[]? - Image of the person.
- language code? - The base language in which the resource is written.
- birthDate date? - The date of birth for the practitioner.
- qualification PractitionerQualification[]? - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- name HumanName[] - The name(s) associated with the practitioner.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A contact detail for the practitioner, e.g. a telephone number or an email address.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- communication CodeableConcept[]? - A language the practitioner can use in patient communication.
- never... - Rest field
health.fhir.r4.uscore501: USCorePractitionerRoleProfile
FHIR USCorePractitionerRoleProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPRACTITIONERROLEPROFILE(default RESOURCE_NAME_USCOREPRACTITIONERROLEPROFILE) - The type of the resource describes
- meta BaseUSCorePractitionerRoleProfileMeta(default { profile : [PROFILE_BASE_USCOREPRACTITIONERROLEPROFILE] }) - 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.
- identifier Identifier[]? - Business Identifiers that are specific to a role/location.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
- specialty CodeableConcept[]? - Specific specialty of the practitioner.
- code CodeableConcept[]? - Roles which this practitioner is authorized to perform for the organization.
- practitioner Reference - Practitioner that is able to provide the defined services for the organization.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active boolean? - Whether this practitioner role record is in active use.
- language code? - The base language in which the resource is written.
- notAvailable PractitionerRoleNotAvailable[]? - The practitioner is not available or performing this role during this period of time due to the provided reason.
- availableTime PractitionerRoleAvailableTime[]? - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the practitioner with this role.
- healthcareService Reference[]? - The list of healthcare services that this worker provides for this role's Organization/Location(s).
- organization Reference - The organization where the Practitioner performs the roles associated.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location Reference[]? - The location(s) at which this practitioner provides care.
- telecom ContactPoint[]? - Contact details that are specific to the role/location/service.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- availabilityExceptions string? - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
- never... - Rest field
health.fhir.r4.uscore501: USCoreProcedureProfile
FHIR USCoreProcedureProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPROCEDUREPROFILE(default RESOURCE_NAME_USCOREPROCEDUREPROFILE) - The type of the resource describes
- meta BaseUSCoreProcedureProfileMeta(default { profile : [PROFILE_BASE_USCOREPROCEDUREPROFILE] }) - 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[]? - Any other notes and comments about the procedure.
- partOf Reference[]? - A larger event of which this particular procedure is a component or step.
- complication CodeableConcept[]? - Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy').
- subject Reference - The person, animal or group on which the procedure was performed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - The justification of why the procedure was performed.
- language code? - The base language in which the resource is written.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- performedPeriod Period - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- followUp CodeableConcept[]? - If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
- statusReason CodeableConcept? - Captures the reason for the current state of the procedure.
- usedCode CodeableConcept[]? - Identifies coded items that were used as part of the procedure.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- performedDateTime dateTime - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- basedOn Reference[]? - A reference to a resource that contains details of the request for this procedure.
- outcome CodeableConcept? - The outcome of the procedure - did it resolve the reasons for the procedure being performed?
- identifier Identifier[]? - Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
- recorder Reference? - Individual who recorded the record and takes responsibility for its content.
- complicationDetail Reference[]? - Any complications that occurred during the procedure, or in the immediate post-performance period.
- performer ProcedurePerformer[]? - Limited to 'real' people rather than equipment.
- usedReference Reference[]? - Identifies medications, devices and any other substance used as part of the procedure.
- focalDevice ProcedureFocalDevice[]? - A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
- encounter Reference? - The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- bodySite CodeableConcept[]? - Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- asserter Reference? - Individual who is making the procedure statement.
- report Reference[]? - This could be a histology result, pathology report, surgical report, etc.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location Reference? - The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
- category CodeableConcept? - A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure').
- status ProcedureStatus - A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
- never... - Rest field
health.fhir.r4.uscore501: USCoreProvenance
FHIR USCoreProvenance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPROVENANCE(default RESOURCE_NAME_USCOREPROVENANCE) - The type of the resource describes
- meta BaseUSCoreProvenanceMeta(default { profile : [PROFILE_BASE_USCOREPROVENANCE] }) - 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.
- reason CodeableConcept[]? - The reason that the activity was taking place.
- agent ProvenanceAgent[] - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- activity CodeableConcept? - An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
- signature Signature[]? - A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- occurredPeriod Period? - The period during which the activity occurred.
- recorded instant - The instant of time at which the activity was recorded.
- target Reference[] - The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location Reference? - Where the activity occurred, if relevant.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- entity ProvenanceEntity[]? - An entity used in this activity.
- occurredDateTime dateTime? - The period during which the activity occurred.
- policy uri[]? - Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
- never... - Rest field
health.fhir.r4.uscore501: USCorePulseOximetryProfile
FHIR USCorePulseOximetryProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREPULSEOXIMETRYPROFILE(default RESOURCE_NAME_USCOREPULSEOXIMETRYPROFILE) - The type of the resource describes
- meta BaseUSCorePulseOximetryProfileMeta(default { profile : [PROFILE_BASE_USCOREPULSEOXIMETRYPROFILE] }) - 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.
- valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - Vital Signs value are typically recorded using the Quantity data type.
- code CodeableConcept - Coded Responses from C-CDA Vital Sign Results.
- subject Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focus
element or thecode
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 ObservationComponentThree[]? - Used when reporting flow rates or oxygen concentration.
- 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 ObservationReferenceRangeThree[]? - 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.
- 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.
- device Reference? - The device used to generate the observation data.
- status ObservationStatusThree - The status of the result value.
- never... - Rest field
health.fhir.r4.uscore501: USCoreSmokingStatusProfile
FHIR USCoreSmokingStatusProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCORESMOKINGSTATUSPROFILE(default RESOURCE_NAME_USCORESMOKINGSTATUSPROFILE) - The type of the resource describes
- meta BaseUSCoreSmokingStatusProfileMeta(default { profile : [PROFILE_BASE_USCORESMOKINGSTATUSPROFILE] }) - 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.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.
- subject Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focus
element or thecode
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.
- value CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.
- basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- identifier Identifier[]? - A unique identifier assigned to this observation.
- performer Reference[]? - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod Period? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- effectiveTiming Timing? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method CodeableConcept? - Indicates the mechanism used to perform the observation.
- hasMember Reference[]? - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component ObservationComponentFive[]? - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- referenceRange ObservationReferenceRangeFive[]? - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- effectiveDateTime dateTime? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[]? - A code that classifies the general type of observation being made.
- device Reference? - The device used to generate the observation data.
- effectiveInstant instant? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- status ObservationStatusFive - The status of the result value.
- never... - Rest field
health.fhir.r4.uscore501: USCoreVitalSignsProfile
FHIR USCoreVitalSignsProfile resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_USCOREVITALSIGNSPROFILE(default RESOURCE_NAME_USCOREVITALSIGNSPROFILE) - The type of the resource describes
- meta BaseUSCoreVitalSignsProfileMeta(default { profile : [PROFILE_BASE_USCOREVITALSIGNSPROFILE] }) - 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.
- valueBoolean boolean? - Vital Signs value are typically recorded using the Quantity data type.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - Vital Signs value are typically recorded using the Quantity data type.
- code CodeableConcept - Coded Responses from C-CDA Vital Sign Results.
- subject Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focus
element or thecode
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 ObservationComponentFour[]? - 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 ObservationReferenceRangeFour[]? - 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.
- 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.
- device Reference? - The device used to generate the observation data.
- status ObservationStatusFour - The status of the result value.
- never... - Rest field
Import
import ballerinax/health.fhir.r4.uscore501;
Metadata
Released date: over 1 year ago
Version: 1.0.7
Compatibility
Platform: any
Ballerina version: 2201.7.0
Pull count
Total: 2082
Current verison: 30
Weekly downloads
Keywords
Healthcare
FHIR
R4
USCore
Contributors