health.fhir.r4.ips
Module health.fhir.r4.ips
Declarations
Definitions
ballerinax/health.fhir.r4.ips Ballerina library
Ballerina package containing FHIR resource data models compliant with http://hl7.org/fhir/uv/ips/ implementation guide.
FHIR R4 ips package
Package Overview
FHIR version | R4 |
Implementation Guide | http://hl7.org/fhir/uv/ips/ |
Sample usage
import ballerina/io; import ballerinax/health.fhir.r4; import ballerinax/health.fhir.r4.ips; public function main() returns error? { json bundleJson = { "resourceType": "Bundle", "id": "IPS-examples-Bundle-01", "language": "en-GB", "identifier": { "system": "urn:oid:2.16.724.4.8.10.200.10", "value": "175bd032-8b00-4728-b2dc-748bb1501aed" }, "type": "document", "timestamp": "2017-12-11T14:30:00+01:00", "entry": [ { "fullUrl": "urn:uuid:2b90dd2b-2dab-4c75-9bb9-a355e07401e8", "resource": { "resourceType": "Patient", "id": "2b90dd2b-2dab-4c75-9bb9-a355e07401e8", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>identifier</b>: id: 574687583</p><p><b>active</b>: true</p><p><b>name</b>: Martha DeLarosa </p><p><b>telecom</b>: <a href=\"tel:+31788700800\">+31788700800</a></p><p><b>gender</b>: female</p><p><b>birthDate</b>: 1972-05-01</p><p><b>address</b>: Laan Van Europa 1600 Dordrecht 3317 DB Netherlands </p><h3>Contacts</h3><table class=\"grid\"><tr><td>-</td><td><b>Relationship</b></td><td><b>Name</b></td><td><b>Telecom</b></td><td><b>Address</b></td></tr><tr><td>*</td><td><span title=\"Codes: {http://terminology.hl7.org/CodeSystem/v3-RoleCode MTH}\">mother</span></td><td>Martha Mum </td><td><a href=\"tel:+33-555-20036\">+33-555-20036</a></td><td>Promenade des Anglais 111 Lyon 69001 France </td></tr></table></div>" }, "identifier": [ { "system": "urn:oid:2.16.840.1.113883.2.4.6.3", "value": "574687583" } ], "active": true, "name": [ { "family": "DeLarosa", "given": [ "Martha" ] } ], "telecom": [ { "system": "phone", "value": "+31788700800", "use": "home" } ], "gender": "female", "birthDate": "1972-05-01", "address": [ { "line": [ "Laan Van Europa 1600" ], "city": "Dordrecht", "postalCode": "3317 DB", "country": "Netherlands" } ] } } ] }; // Accepts a FHIR R4 Bundle or IpsData record and returns constructed IPS Bundle r4:Bundle|error ipsBundle = ips:getIpsBundle(check bundleJson.cloneWithType(r4:Bundle)); if ipsBundle is r4:Bundle { io:println("IPS Bundle: " + ipsBundle.toString()); } else { io:println("Error: " + ipsBundle.toString()); } }
Capabilities and features
Supported FHIR resource types
Functions
getIpsBundle
function getIpsBundle(Bundle|IpsBundleData bundleData) returns Bundle|error
Construct the IPS Bundle from the given IPS Bundle data.
Parameters
- bundleData Bundle|IpsBundleData - IPS Bundle data as in standard FHIR Bundle or IPS Bundle data holder.
initialize
function initialize()
This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.ips: PROFILE_BASE_ALLERGYINTOLERANCEUVIPS
health.fhir.r4.ips: PROFILE_BASE_COMPOSITIONUVIPS
health.fhir.r4.ips: PROFILE_BASE_CONDITIONUVIPS
health.fhir.r4.ips: PROFILE_BASE_DEVICEOBSERVERUVIPS
health.fhir.r4.ips: PROFILE_BASE_DEVICEUSESTATEMENTUVIPS
health.fhir.r4.ips: PROFILE_BASE_DEVICEUVIPS
health.fhir.r4.ips: PROFILE_BASE_DIAGNOSTICREPORTUVIPS
health.fhir.r4.ips: PROFILE_BASE_IMAGINGSTUDYUVIPS
health.fhir.r4.ips: PROFILE_BASE_IMMUNIZATIONUVIPS
health.fhir.r4.ips: PROFILE_BASE_MEDIAOBSERVATIONUVIPS
health.fhir.r4.ips: PROFILE_BASE_MEDICATIONIPS
health.fhir.r4.ips: PROFILE_BASE_MEDICATIONREQUESTIPS
health.fhir.r4.ips: PROFILE_BASE_MEDICATIONSTATEMENTIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONALCOHOLUSEUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONPREGNANCYEDDUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONPREGNANCYOUTCOMEUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONPREGNANCYSTATUSUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONRESULTSLABORATORYUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONRESULTSPATHOLOGYUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONRESULTSRADIOLOGYUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONRESULTSUVIPS
health.fhir.r4.ips: PROFILE_BASE_OBSERVATIONTOBACCOUSEUVIPS
health.fhir.r4.ips: PROFILE_BASE_ORGANIZATIONUVIPS
health.fhir.r4.ips: PROFILE_BASE_PATIENTUVIPS
health.fhir.r4.ips: PROFILE_BASE_PRACTITIONERROLEUVIPS
health.fhir.r4.ips: PROFILE_BASE_PRACTITIONERUVIPS
health.fhir.r4.ips: PROFILE_BASE_PROCEDUREUVIPS
health.fhir.r4.ips: PROFILE_BASE_SPECIMENUVIPS
health.fhir.r4.ips: RESOURCE_NAME_ALLERGYINTOLERANCEUVIPS
health.fhir.r4.ips: RESOURCE_NAME_COMPOSITIONUVIPS
health.fhir.r4.ips: RESOURCE_NAME_CONDITIONUVIPS
health.fhir.r4.ips: RESOURCE_NAME_DEVICEOBSERVERUVIPS
health.fhir.r4.ips: RESOURCE_NAME_DEVICEUSESTATEMENTUVIPS
health.fhir.r4.ips: RESOURCE_NAME_DEVICEUVIPS
health.fhir.r4.ips: RESOURCE_NAME_DIAGNOSTICREPORTUVIPS
health.fhir.r4.ips: RESOURCE_NAME_IMAGINGSTUDYUVIPS
health.fhir.r4.ips: RESOURCE_NAME_IMMUNIZATIONUVIPS
health.fhir.r4.ips: RESOURCE_NAME_MEDIAOBSERVATIONUVIPS
health.fhir.r4.ips: RESOURCE_NAME_MEDICATIONIPS
health.fhir.r4.ips: RESOURCE_NAME_MEDICATIONREQUESTIPS
health.fhir.r4.ips: RESOURCE_NAME_MEDICATIONSTATEMENTIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONALCOHOLUSEUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONPREGNANCYEDDUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONPREGNANCYOUTCOMEUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONPREGNANCYSTATUSUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONRESULTSLABORATORYUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONRESULTSPATHOLOGYUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONRESULTSRADIOLOGYUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONRESULTSUVIPS
health.fhir.r4.ips: RESOURCE_NAME_OBSERVATIONTOBACCOUSEUVIPS
health.fhir.r4.ips: RESOURCE_NAME_ORGANIZATIONUVIPS
health.fhir.r4.ips: RESOURCE_NAME_PATIENTUVIPS
health.fhir.r4.ips: RESOURCE_NAME_PRACTITIONERROLEUVIPS
health.fhir.r4.ips: RESOURCE_NAME_PRACTITIONERUVIPS
health.fhir.r4.ips: RESOURCE_NAME_PROCEDUREUVIPS
health.fhir.r4.ips: RESOURCE_NAME_SPECIMENUVIPS
Enums
health.fhir.r4.ips: AllergyIntoleranceUvIpsCategory
AllergyIntoleranceUvIpsCategory enum
Members
health.fhir.r4.ips: AllergyIntoleranceUvIpsCriticality
AllergyIntoleranceUvIpsCriticality enum
Members
health.fhir.r4.ips: AllergyIntoleranceUvIpsReactionSeverity
AllergyIntoleranceUvIpsReactionSeverity enum
Members
health.fhir.r4.ips: AllergyIntoleranceUvIpsType
AllergyIntoleranceUvIpsType enum
Members
health.fhir.r4.ips: CompositionUvIpsAttesterMode
CompositionUvIpsAttesterMode enum
Members
health.fhir.r4.ips: CompositionUvIpsRelatesToCode
CompositionUvIpsRelatesToCode enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionMode
CompositionUvIpsSectionMode enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeEight
CompositionUvIpsSectionModeEight enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeEleven
CompositionUvIpsSectionModeEleven enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeFive
CompositionUvIpsSectionModeFive enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeFour
CompositionUvIpsSectionModeFour enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeFourteen
CompositionUvIpsSectionModeFourteen enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeNine
CompositionUvIpsSectionModeNine enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeOne
CompositionUvIpsSectionModeOne enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeSeven
CompositionUvIpsSectionModeSeven enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeSix
CompositionUvIpsSectionModeSix enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeTen
CompositionUvIpsSectionModeTen enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeThirteen
CompositionUvIpsSectionModeThirteen enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeThree
CompositionUvIpsSectionModeThree enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeTwelve
CompositionUvIpsSectionModeTwelve enum
Members
health.fhir.r4.ips: CompositionUvIpsSectionModeTwo
CompositionUvIpsSectionModeTwo enum
Members
health.fhir.r4.ips: CompositionUvIpsStatus
CompositionUvIpsStatus enum
Members
health.fhir.r4.ips: DeviceObserverUvIpsDeviceNameType
DeviceObserverUvIpsDeviceNameType enum
Members
health.fhir.r4.ips: DeviceObserverUvIpsStatus
DeviceObserverUvIpsStatus enum
Members
health.fhir.r4.ips: DeviceObserverUvIpsUdiCarrierEntryType
DeviceObserverUvIpsUdiCarrierEntryType enum
Members
health.fhir.r4.ips: DeviceUseStatementUvIpsStatus
DeviceUseStatementUvIpsStatus enum
Members
health.fhir.r4.ips: DeviceUvIpsDeviceNameType
DeviceUvIpsDeviceNameType enum
Members
health.fhir.r4.ips: DeviceUvIpsStatus
DeviceUvIpsStatus enum
Members
health.fhir.r4.ips: DeviceUvIpsUdiCarrierEntryType
DeviceUvIpsUdiCarrierEntryType enum
Members
health.fhir.r4.ips: DiagnosticReportUvIpsStatus
DiagnosticReportUvIpsStatus enum
Members
health.fhir.r4.ips: ImagingStudyUvIpsStatus
ImagingStudyUvIpsStatus enum
Members
health.fhir.r4.ips: ImmunizationUvIpsStatus
ImmunizationUvIpsStatus enum
Members
health.fhir.r4.ips: MediaObservationUvIpsStatus
MediaObservationUvIpsStatus enum
Members
health.fhir.r4.ips: MedicationIPSStatus
MedicationIPSStatus enum
Members
health.fhir.r4.ips: MedicationRequestIPSIntent
MedicationRequestIPSIntent enum
Members
health.fhir.r4.ips: MedicationRequestIPSPriority
MedicationRequestIPSPriority enum
Members
health.fhir.r4.ips: MedicationRequestIPSStatus
MedicationRequestIPSStatus enum
Members
health.fhir.r4.ips: MedicationStatementIPSStatus
MedicationStatementIPSStatus enum
Members
health.fhir.r4.ips: ObservationAlcoholUseUvIpsStatus
ObservationAlcoholUseUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationPregnancyEddUvIpsStatus
ObservationPregnancyEddUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationPregnancyOutcomeUvIpsStatus
ObservationPregnancyOutcomeUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationPregnancyStatusUvIpsStatus
ObservationPregnancyStatusUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationResultsLaboratoryUvIpsStatus
ObservationResultsLaboratoryUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationResultsPathologyUvIpsStatus
ObservationResultsPathologyUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsStatus
ObservationResultsRadiologyUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationResultsUvIpsStatus
ObservationResultsUvIpsStatus enum
Members
health.fhir.r4.ips: ObservationTobaccoUseUvIpsStatus
ObservationTobaccoUseUvIpsStatus enum
Members
health.fhir.r4.ips: PatientUvIpsContactGender
PatientUvIpsContactGender enum
Members
health.fhir.r4.ips: PatientUvIpsGender
PatientUvIpsGender enum
Members
health.fhir.r4.ips: PatientUvIpsLinkType
PatientUvIpsLinkType enum
Members
health.fhir.r4.ips: PatientUvIpsNameUse
PatientUvIpsNameUse enum
Members
health.fhir.r4.ips: PractitionerRoleUvIpsAvailableTimeDaysOfWeek
PractitionerRoleUvIpsAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.ips: PractitionerUvIpsGender
PractitionerUvIpsGender enum
Members
health.fhir.r4.ips: PractitionerUvIpsNameUse
PractitionerUvIpsNameUse enum
Members
health.fhir.r4.ips: ProcedureUvIpsStatus
ProcedureUvIpsStatus enum
Members
health.fhir.r4.ips: QuantityUvIpsComparator
Members
health.fhir.r4.ips: SimpleQuantityUvIpsComparator
Members
health.fhir.r4.ips: SpecimenUvIpsStatus
SpecimenUvIpsStatus enum
Members
Variables
health.fhir.r4.ips: terminologyProcessor
Terminology processor instance
health.fhir.r4.ips: fhirRegistry
FHIR registry instance
health.fhir.r4.ips: FHIR_VALUE_SETS
health.fhir.r4.ips: FHIR_CODE_SYSTEMS
Configurables
health.fhir.r4.ips: ips_bundle_identifier_system
health.fhir.r4.ips: ips_composition_status
health.fhir.r4.ips: ips_composition_title
health.fhir.r4.ips: ips_composition_problem_section_title
health.fhir.r4.ips: ips_composition_allergy_section_title
health.fhir.r4.ips: ips_composition_medication_section_title
health.fhir.r4.ips: ips_composition_immunization_section_title
health.fhir.r4.ips: ips_composition_procedure_section_title
health.fhir.r4.ips: ips_composition_diagnostic_report_section_title
health.fhir.r4.ips: attesters
health.fhir.r4.ips: custodian
health.fhir.r4.ips: author
Records
health.fhir.r4.ips: AllergyIntoleranceUvIps
FHIR AllergyIntoleranceUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ALLERGYINTOLERANCEUVIPS(default RESOURCE_NAME_ALLERGYINTOLERANCEUVIPS) - The type of the resource describes
- note? Annotation[] - Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
- extension? Extension[] - An Extension
- code? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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? AllergyIntoleranceUvIpsCriticality - 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? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- onsetDateTime? dateTime - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- 'type? AllergyIntoleranceUvIpsType - 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 AllergyIntoleranceUvIpsPatient - 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? AllergyIntoleranceUvIpsReaction[] - Details about each adverse reaction event linked to exposure to the identified substance.
- verificationStatus? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- recordedDate? dateTime - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
- encounter? Reference - The encounter when the allergy or intolerance was asserted.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- asserter? Reference - The source of the information about the allergy that is recorded.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? AllergyIntoleranceUvIpsCategory[] - Category of the identified substance.
- Element... - Rest field
health.fhir.r4.ips: AllergyIntoleranceUvIpsPatient
FHIR AllergyIntoleranceUvIpsPatient datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: AllergyIntoleranceUvIpsReaction
FHIR AllergyIntoleranceUvIpsReaction datatype record.
Fields
- Fields Included from *BackboneElement
- severity? AllergyIntoleranceUvIpsReactionSeverity - 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[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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.ips: CodeableConceptUvIps
Fields
- Fields Included from *CodeableConcept
- id? string -
- extension? Extension[] -
- coding? Coding[] -
- text? string -
health.fhir.r4.ips: CodingUvIps
Fields
- Fields Included from *Coding
- id? string -
- extension? Extension[] -
- system? uri -
- 'version? string -
- code? code -
- userSelected? boolean -
- display? string -
- value? string -
health.fhir.r4.ips: CompositionUvIps
FHIR CompositionUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COMPOSITIONUVIPS(default RESOURCE_NAME_COMPOSITIONUVIPS) - The type of the resource describes
- date dateTime - The composition editing time, when the composition was last logically changed by the author.
- identifier? Identifier - A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
- extension? Extension[] - An Extension
- custodian? Reference - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
- subject CompositionUvIpsSubject - Who or what the composition is about. In general a composition 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 livestock, or a set of patients that share a common exposure). For the IPS the subject is always the patient.
- author Reference[] - Identifies who is responsible for the information in the IPS, not necessarily who typed it in. The type of author(s) contribute to determine the 'nature'of the Patient Summary: e.g. a 'human-curated' IPS Vs. an 'automatically generated' IPS.
- confidentiality? code - The code specifying the level of confidentiality of the Composition.
- 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.
- section CompositionUvIpsSection[] - The root of the sections that make up the IPS composition.
- section Slicings
- CompositionUvIpsSectionSectionResults: IPS Results Section
- min = 0
- max = 1
- encounter? Reference - Describes the clinical encounter or type of care this documentation is associated with.
- title string - Official human-readable label for the composition. For this document should be 'International Patient Summary' or any equivalent translation
- 'type CodeableConceptUvIps - Specifies that this composition refers to a Patient Summary (Loinc '60591-5')
- attester? CompositionUvIpsAttester[] - A participant who has attested to the accuracy of the composition/document.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- 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.
- event? CompositionUvIpsEvent[] - The main activity being described by a IPS is the provision of healthcare over a period of time. In the CDA representation of the IPS this is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. In the FHIR representation at least one event should be used to record this information. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the start value should represent the date when the treatment relationship between the patient and the GP started; and the end value the date of the latest care event.
- event Slicings
- CompositionUvIpsEventCareProvisioningEvent: The care provisioning being documented
- min = 0
- max = 1
- relatesTo? CompositionUvIpsRelatesTo[] - Relationships that this composition has with other compositions or documents that already exist.
- category? CodeableConcept[] - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
- status CompositionUvIpsStatus - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
- Element... - Rest field
health.fhir.r4.ips: CompositionUvIpsAttester
FHIR CompositionUvIpsAttester datatype record.
Fields
- Fields Included from *BackboneElement
- mode CompositionUvIpsAttesterMode - The type of attestation the authenticator offers.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- time? dateTime - When the composition was attested by the party.
- party? Reference - Who attested the composition in the specified way.
health.fhir.r4.ips: CompositionUvIpsEvent
FHIR CompositionUvIpsEvent datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
- code? 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 typeCode, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.
- 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[] - The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
- 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.ips: CompositionUvIpsEventCareProvisioningEvent
FHIR CompositionUvIpsEventCareProvisioningEvent datatype record.
Fields
- Fields Included from *CompositionUvIpsEvent
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
- code CompositionUvIpsEventCode[] - 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 typeCode, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.
- 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[] - The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
- 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.ips: CompositionUvIpsEventCode
FHIR CompositionUvIpsEventCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsEventCodeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsEventCodeCoding
FHIR CompositionUvIpsEventCodeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://terminology.hl7.org/CodeSystem/v3-ActClass") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "PCPR") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsRelatesTo
FHIR CompositionUvIpsRelatesTo datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- targetIdentifier Identifier - The target composition/document of this relationship.
- code CompositionUvIpsRelatesToCode - The type of relationship that this composition has with anther composition or 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.
- targetReference Reference - The target composition/document of this relationship.
health.fhir.r4.ips: CompositionUvIpsSection
FHIR CompositionUvIpsSection datatype record.
Fields
- Fields Included from *BackboneElement
- mode? CompositionUvIpsSectionMode - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - A reference to the actual resource from which the narrative in the section is derived.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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 Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title? string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionCode
FHIR CompositionUvIpsSectionCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeCoding
FHIR CompositionUvIpsSectionCodeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "30954-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingEight
FHIR CompositionUvIpsSectionCodeCodingEight datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "48765-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingEleven
FHIR CompositionUvIpsSectionCodeCodingEleven datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "10160-0") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingFive
FHIR CompositionUvIpsSectionCodeCodingFive datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "47519-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingFour
FHIR CompositionUvIpsSectionCodeCodingFour datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "46264-8") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingNine
FHIR CompositionUvIpsSectionCodeCodingNine datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "8716-3") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingOne
FHIR CompositionUvIpsSectionCodeCodingOne datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "29762-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingSeven
FHIR CompositionUvIpsSectionCodeCodingSeven datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "11450-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingSix
FHIR CompositionUvIpsSectionCodeCodingSix datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "11369-6") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingTen
FHIR CompositionUvIpsSectionCodeCodingTen datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "47420-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingThirteen
FHIR CompositionUvIpsSectionCodeCodingThirteen datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "42348-3") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingThree
FHIR CompositionUvIpsSectionCodeCodingThree datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "18776-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingTwelve
FHIR CompositionUvIpsSectionCodeCodingTwelve datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "11348-0") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeCodingTwo
FHIR CompositionUvIpsSectionCodeCodingTwo datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "10162-6") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: CompositionUvIpsSectionCodeEight
FHIR CompositionUvIpsSectionCodeEight datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingEight[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeEleven
FHIR CompositionUvIpsSectionCodeEleven datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingEleven[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeFive
FHIR CompositionUvIpsSectionCodeFive datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingFive[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeFour
FHIR CompositionUvIpsSectionCodeFour datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingFour[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeNine
FHIR CompositionUvIpsSectionCodeNine datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingNine[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeOne
FHIR CompositionUvIpsSectionCodeOne datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingOne[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeSeven
FHIR CompositionUvIpsSectionCodeSeven datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingSeven[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeSix
FHIR CompositionUvIpsSectionCodeSix datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingSix[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeTen
FHIR CompositionUvIpsSectionCodeTen datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingTen[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeThirteen
FHIR CompositionUvIpsSectionCodeThirteen datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingThirteen[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeThree
FHIR CompositionUvIpsSectionCodeThree datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingThree[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeTwelve
FHIR CompositionUvIpsSectionCodeTwelve datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingTwelve[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionCodeTwo
FHIR CompositionUvIpsSectionCodeTwo datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsSectionCodeCodingTwo[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsSectionSectionAdvanceDirectives
FHIR CompositionUvIpsSectionSectionAdvanceDirectives datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeFourteen - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - Contains a narrative description or a Consent entry with information about the patient's advance directive.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeThirteen - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionAllergies
FHIR CompositionUvIpsSectionSectionAllergies datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeNine - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - It lists the relevant allergies or intolerances (conditions) for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. This entry shall be used to document that no information about allergies is available, or that no allergies are known .
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeEight - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionFunctionalStatus
FHIR CompositionUvIpsSectionSectionFunctionalStatus datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeEleven - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - It describes capabilities of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeTen - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionImmunizations
FHIR CompositionUvIpsSectionSectionImmunizations datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeSeven - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - It defines the patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. It may contain the entire immunization history that is relevant to the period of time being summarized. This entry shall be used to document that no information about immunizations is available, or that no immunizations are known.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeSix - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionMedicalDevices
FHIR CompositionUvIpsSectionSectionMedicalDevices datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeFive - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - It describes the patient history of medical device use. This entry shall be used to document that no information about medical device use is available, or that no relevant medical device use is known.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeFour - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionMedications
FHIR CompositionUvIpsSectionSectionMedications datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeTwelve - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - This list the medications relevant for the scope of the patient summary or it is used to indicate that the subject is known not to be on any relevant medication; either that no information is available about medications.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeEleven - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. Medication Summary
health.fhir.r4.ips: CompositionUvIpsSectionSectionPastIllnessHx
FHIR CompositionUvIpsSectionSectionPastIllnessHx datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeThirteen - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - It contains a description of the conditions the patient suffered in the past.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeTwelve - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionPlanOfCare
FHIR CompositionUvIpsSectionSectionPlanOfCare datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeFour - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - Dynamic, personalized plan including identified needed healthcare activity, health objectives and healthcare goals, relating to one or more specified health issues in a healthcare process [Source EN ISO 13940]
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeThree - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionPregnancyHx
FHIR CompositionUvIpsSectionSectionPregnancyHx datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeThree - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeTwo - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionProblems
FHIR CompositionUvIpsSectionSectionProblems datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeEight - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - It lists and describes clinical problems or conditions currently being monitored for the patient. This entry shall be used to document that no information about problems is available, or that no relevant problems are known.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeSeven - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionProceduresHx
FHIR CompositionUvIpsSectionSectionProceduresHx datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeSix - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: 1. Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) 2. Therapeutic procedure: e.g. dialysis; 3. Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeFive - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionResults
FHIR CompositionUvIpsSectionSectionResults datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeOne - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[] - Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCode - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionSocialHistory
FHIR CompositionUvIpsSectionSectionSocialHistory datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeTwo - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - Description of the person’s Health related “lifestyle factors' or 'lifestyle observations' (e.g. smoke habits; alcohol consumption; diets, risky habits.)
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeOne - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSectionSectionVitalSigns
FHIR CompositionUvIpsSectionSectionVitalSigns datatype record.
Fields
- Fields Included from *CompositionUvIpsSection
- mode CompositionUvIpsSectionMode
- entry Reference[]
- extension Extension[]
- code CodeableConcept
- emptyReason CodeableConcept
- orderedBy CodeableConcept
- author Reference[]
- modifierExtension Extension[]
- focus Reference
- id string
- text Narrative
- title string
- Element...
- mode? CompositionUvIpsSectionModeTen - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry? Reference[] - Notable vital signs or physical findings as: blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CompositionUvIpsSectionCodeNine - A code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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? Narrative - A human-readable narrative that contains the attested content of the section, 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.
- title string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.ips: CompositionUvIpsSubject
FHIR CompositionUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: CompositionUvIpsType
FHIR CompositionUvIpsType datatype record.
Fields
- Fields Included from *CodeableConcept
- coding CompositionUvIpsTypeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: CompositionUvIpsTypeCoding
FHIR CompositionUvIpsTypeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "60591-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ConditionUvIps
FHIR ConditionUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CONDITIONUVIPS(default RESOURCE_NAME_CONDITIONUVIPS) - The type of the resource describes
- note? Annotation[] - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
- extension? Extension[] - 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 CodeableConceptUvIps - Identification of the condition, problem or diagnosis or recording of 'problem absent' or of 'problems unknown'.
- evidence? ConditionUvIpsEvidence[] - 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 ConditionUvIpsSubject - 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 CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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? CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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? ConditionUvIpsStage[] - Clinical stage or grade of a condition. May include formal severity assessments.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConceptUvIps[] - A category assigned to the condition. In this profile, a health problem of the patient, therefore a 'problem-list-item'.
- abatementAge? Age - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- Element... - Rest field
health.fhir.r4.ips: ConditionUvIpsEvidence
FHIR ConditionUvIpsEvidence datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ConditionUvIpsStage
FHIR ConditionUvIpsStage datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ConditionUvIpsSubject
FHIR ConditionUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: DeviceObserverUvIps
FHIR DeviceObserverUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEOBSERVERUVIPS(default RESOURCE_NAME_DEVICEOBSERVERUVIPS) - The type of the resource describes
- note? Annotation[] - Descriptive information, usage information or implantation information that is not captured in an existing element.
- parent? Reference - The parent device.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language? code - The base language in which the resource is written.
- distinctIdentifier? string - The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
- 'type? CodeableConcept - The kind or type of device.
- deviceName? DeviceObserverUvIpsDeviceName[] - 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? DeviceObserverUvIpsProperty[] - 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? DeviceObserverUvIpsVersion[] - 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? DeviceObserverUvIpsUdiCarrier[] - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- specialization? DeviceObserverUvIpsSpecialization[] - 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? DeviceObserverUvIpsStatus - Status of the Device availability.
- Element... - Rest field
health.fhir.r4.ips: DeviceObserverUvIpsDeviceName
FHIR DeviceObserverUvIpsDeviceName datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 DeviceObserverUvIpsDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
health.fhir.r4.ips: DeviceObserverUvIpsProperty
FHIR DeviceObserverUvIpsProperty datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: DeviceObserverUvIpsSpecialization
FHIR DeviceObserverUvIpsSpecialization datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: DeviceObserverUvIpsUdiCarrier
FHIR DeviceObserverUvIpsUdiCarrier datatype record.
Fields
- Fields Included from *BackboneElement
- entryType? DeviceObserverUvIpsUdiCarrierEntryType - 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.ips: DeviceObserverUvIpsVersion
FHIR DeviceObserverUvIpsVersion datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: DeviceUseStatementUvIps
FHIR DeviceUseStatementUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEUSESTATEMENTUVIPS(default RESOURCE_NAME_DEVICEUSESTATEMENTUVIPS) - The type of the resource describes
- identifier? Identifier[] - An external identifier for this statement such as an IRI.
- note? Annotation[] - Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
- 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.
- timingTiming Timing - How often the device was used.
- timingPeriod Period - How often the device was used.
- subject DeviceUseStatementUvIpsSubject - The patient using the device.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference? Reference[] - Indicates another resource whose existence justifies this DeviceUseStatement.
- language? code - The base language in which the resource is written.
- 'source? Reference - Who reported the device was being used by the patient.
- bodySite? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- derivedFrom? Reference[] - Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.
- 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.
- recordedOn? dateTime - The time at which the statement was made/recorded.
- 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 or justification for the use of the device.
- 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.
- device Reference - The details of the device used.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.
- status DeviceUseStatementUvIpsStatus - A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
- timingDateTime dateTime - How often the device was used.
- Element... - Rest field
health.fhir.r4.ips: DeviceUseStatementUvIpsSubject
FHIR DeviceUseStatementUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: DeviceUvIps
FHIR DeviceUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEUVIPS(default RESOURCE_NAME_DEVICEUVIPS) - The type of the resource describes
- note? Annotation[] - Descriptive information, usage information or implantation information that is not captured in an existing element.
- parent? Reference - The parent device.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language? code - The base language in which the resource is written.
- distinctIdentifier? string - The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
- 'type? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- deviceName? DeviceUvIpsDeviceName[] - 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 DeviceUvIpsPatient - 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? DeviceUvIpsProperty[] - 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? DeviceUvIpsVersion[] - 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? DeviceUvIpsUdiCarrier[] - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- specialization? DeviceUvIpsSpecialization[] - 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? DeviceUvIpsStatus - Status of the Device availability.
- Element... - Rest field
health.fhir.r4.ips: DeviceUvIpsDeviceName
FHIR DeviceUvIpsDeviceName datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 DeviceUvIpsDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
health.fhir.r4.ips: DeviceUvIpsPatient
FHIR DeviceUvIpsPatient datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: DeviceUvIpsProperty
FHIR DeviceUvIpsProperty datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: DeviceUvIpsSpecialization
FHIR DeviceUvIpsSpecialization datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: DeviceUvIpsUdiCarrier
FHIR DeviceUvIpsUdiCarrier datatype record.
Fields
- Fields Included from *BackboneElement
- entryType? DeviceUvIpsUdiCarrierEntryType - 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.ips: DeviceUvIpsVersion
FHIR DeviceUvIpsVersion datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: DiagnosticReportUvIps
FHIR DiagnosticReportUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DIAGNOSTICREPORTUVIPS(default RESOURCE_NAME_DIAGNOSTICREPORTUVIPS) - The type of the resource describes
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject DiagnosticReportUvIpsSubject - 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? DiagnosticReportUvIpsMedia[] - 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[] - Observation results included in the diagnostic report.
- result Slicings
- DiagnosticReportUvIpsResultObservation_results: Observations
- min = 0
- max = *
- specimen? Reference[] - Details about the specimens on which this diagnostic report is based.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
- basedOn? Reference[] - Details concerning a service requested.
- identifier? Identifier[] - Identifiers assigned to this report by the performer or other systems.
- performer? Reference[] - The diagnostic service that is responsible for issuing the report.
- effectivePeriod Period - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- resultsInterpreter? Reference[] - The practitioner or organization that is responsible for the report's conclusions and interpretations.
- conclusionCode? CodeableConcept[] - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
- encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- effectiveDateTime dateTime - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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 DiagnosticReportUvIpsStatus - The status of the diagnostic report.
- Element... - Rest field
health.fhir.r4.ips: DiagnosticReportUvIpsMedia
FHIR DiagnosticReportUvIpsMedia datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: DiagnosticReportUvIpsResultObservation_results
FHIR DiagnosticReportUvIpsResultObservation_results datatype record.
Fields
- Fields Included from *Reference
health.fhir.r4.ips: DiagnosticReportUvIpsSubject
FHIR DiagnosticReportUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ImagingStudyUvIps
FHIR ImagingStudyUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMAGINGSTUDYUVIPS(default RESOURCE_NAME_IMAGINGSTUDYUVIPS) - The type of the resource describes
- note? Annotation[] - Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
- 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.
- modality? Coding[] - A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
- procedureCode? CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ImagingStudyUvIpsSubject - The subject, typically a patient, of the imaging study.
- 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 - The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
- reasonReference? Reference[] - Indicates another resource whose existence justifies this Study.
- language? code - The base language in which the resource is written.
- endpoint? Reference[] - The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
- numberOfInstances? unsignedInt - Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by 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.
- basedOn? Reference[] - A list of the diagnostic requests that resulted in this imaging study being performed.
- identifier? Identifier[] - Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
- numberOfSeries? unsignedInt - Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
- interpreter? Reference[] - Who read the study and interpreted the images or other content.
- started? dateTime - Date and time the study started.
- encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
- referrer? Reference - The requesting/referring physician.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- series? ImagingStudyUvIpsSeries[] - Each study has one or more series of images or other content.
- procedureReference? Reference - The procedure which this ImagingStudy was part of.
- 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 principal physical location where the ImagingStudy was performed.
- status ImagingStudyUvIpsStatus - The current state of the ImagingStudy.
- Element... - Rest field
health.fhir.r4.ips: ImagingStudyUvIpsSeries
FHIR ImagingStudyUvIpsSeries datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- instance? ImagingStudyUvIpsSeriesInstance[] - A single SOP instance within the series, e.g. an image, or presentation state.
- modality Coding - The modality of this series sequence.
- performer? ImagingStudyUvIpsSeriesPerformer[] - Indicates who or what performed the series and how they were involved.
- 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 - A description of the series.
- started? dateTime - The date and time the series was started.
- laterality? Coding - The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
- number? unsignedInt - The numeric identifier of this series in the study.
- uid id - The DICOM Series Instance UID for the series.
- bodySite? Coding - The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
- endpoint? Reference[] - The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.
- numberOfInstances? unsignedInt - Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
- specimen? Reference[] - The specimen imaged, e.g., for whole slide imaging of a biopsy.
- 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.ips: ImagingStudyUvIpsSeriesInstance
FHIR ImagingStudyUvIpsSeriesInstance datatype record.
Fields
- Fields Included from *BackboneElement
- number? unsignedInt - The number of instance in the series.
- uid id - The DICOM SOP Instance UID for this image or other DICOM content.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- sopClass Coding - DICOM instance 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.
- title? string - The description of the instance.
health.fhir.r4.ips: ImagingStudyUvIpsSeriesPerformer
FHIR ImagingStudyUvIpsSeriesPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - Indicates who or what performed the 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.
- 'function? CodeableConcept - Distinguishes the type of involvement of the performer in the 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).
- 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.ips: ImagingStudyUvIpsSubject
FHIR ImagingStudyUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ImmunizationUvIps
FHIR ImmunizationUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMMUNIZATIONUVIPS(default RESOURCE_NAME_IMMUNIZATIONUVIPS) - The type of the resource describes
- note? Annotation[] - Extra information about the immunization that is not conveyed by the other attributes.
- primarySource? boolean - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- education? ImmunizationUvIpsEducation[] - Educational material presented to the patient (or guardian) at the time of vaccine administration.
- doseQuantity? SimpleQuantity - The quantity of vaccine product that was administered.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference? Reference[] - Condition, Observation or DiagnosticReport that supports why the immunization was administered.
- language? code - The base language in which the resource is written.
- manufacturer? Reference - Name of vaccine manufacturer.
- programEligibility? CodeableConcept[] - Indicates a patient's eligibility for a funding program.
- statusReason? CodeableConcept - Indicates the reason the immunization event was not performed.
- isSubpotent? boolean - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
- patient ImmunizationUvIpsPatient - 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 CodeableConceptUvIps - Vaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunized is provided; or the known absent / unknown. Other coded information can be provided as well as: - The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept. - The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. - The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. - Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class). The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.
- expirationDate? date - Date vaccine batch expires.
- identifier? Identifier[] - A unique identifier assigned to this immunization record.
- performer? ImmunizationUvIpsPerformer[] - Indicates who performed the immunization event.
- reaction? ImmunizationUvIpsReaction[] - 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? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- route? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- protocolApplied? ImmunizationUvIpsProtocolApplied[] - 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 ImmunizationUvIpsStatus - Indicates the current status of the immunization event.
- Element... - Rest field
health.fhir.r4.ips: ImmunizationUvIpsEducation
FHIR ImmunizationUvIpsEducation datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ImmunizationUvIpsPatient
FHIR ImmunizationUvIpsPatient datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ImmunizationUvIpsPerformer
FHIR ImmunizationUvIpsPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ImmunizationUvIpsProtocolApplied
FHIR ImmunizationUvIpsProtocolApplied datatype record.
Fields
- Fields Included from *BackboneElement
- 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 particular disease against which the patient has been immunized. Additional conformance bindings provided for use for this element in specific (jurisdictional or other) contexts include (these bindings are represented in the StructureDefinition as instances of the elementdefinition-additionalBinding extension): - targetDiseases-uv-ips
- 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.ips: ImmunizationUvIpsReaction
FHIR ImmunizationUvIpsReaction datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: IpsBundleData
The IPS Bundle record which is used to store the International Patient Summary (IPS) data.
Fields
- composition CompositionUvIps - Summary of the patient's health information.
- patient PatientUvIps - Patient demographic and identifier details.
- allergyIntolerance? AllergyIntoleranceUvIps[] - Recorded allergies and intolerances.
- condition? ConditionUvIps[] - Diagnosed conditions and clinical problems.
- device? DeviceUvIps[] - Medical devices used by the patient.
- deviceUseStatement? DeviceUseStatementUvIps[] - Patient's usage of medical devices.
- diagnosticReport? DiagnosticReportUvIps[] - Diagnostic test results and reports.
- imagingStudy? ImagingStudyUvIps[] - Imaging procedures like X-ray, MRI, CT.
- immunization? ImmunizationUvIps[] - Vaccination records.
- mediaObservation? MediaObservationUvIps[] - Clinical media like images and videos.
- medication? MedicationIPS[] - Medication details, including formulation.
- medicationRequest? MedicationRequestIPS[] - Prescribed medication orders.
- medicationStatement? MedicationStatementIPS[] - Patient’s medication usage history.
- practitioner? PractitionerUvIps[] - Healthcare provider details.
- practitionerRole? PractitionerRoleUvIps[] - Roles and responsibilities of practitioners.
- procedure? ProcedureUvIps[] - Medical or surgical procedures performed.
- organization? OrganizationUvIps[] - Healthcare organizations involved in care.
- observationPregnancyEdd? ObservationPregnancyEddUvIps[] - Estimated due date of pregnancy.
- observationPregnancyOutcome? ObservationPregnancyOutcomeUvIps[] - Pregnancy outcome details.
- observationPregnancyStatus? ObservationPregnancyStatusUvIps[] - Current pregnancy status.
- observationAlcoholUse? ObservationAlcoholUseUvIps[] - Patient’s alcohol consumption data.
- observationTobaccoUse? ObservationTobaccoUseUvIps[] - Tobacco usage history and status.
- observationResults? ObservationResultsUvIps[] - General clinical observations.
- specimen? SpecimenUvIps[] - Collected biological specimens.
health.fhir.r4.ips: MediaObservationUvIps
FHIR MediaObservationUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDIAOBSERVATIONUVIPS(default RESOURCE_NAME_MEDIAOBSERVATIONUVIPS) - The type of the resource describes
- note? Annotation[] - Comments made about the media by the performer, subject or other participants.
- partOf? Reference[] - A larger event of which this particular event is a component or step.
- 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.
- modality? CodeableConcept - Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
- subject MediaObservationUvIpsSubject - Who/What this Media is a record of.
- 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).
- createdDateTime? dateTime - The date and time(s) at which the media was collected.
- language? code - The base language in which the resource is written.
- 'type? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- deviceName? string - The name of the device / manufacturer of the device that was used to make the recording.
- content Attachment - The actual content of the media - inline or by direct reference to the media source file.
- operator? Reference - The person who administered the collection of the image.
- duration? decimal - The duration of the recording in seconds - for audio and video.
- view? CodeableConcept - The name of the imaging view e.g. Lateral or Antero-posterior (AP).
- 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 event occurred in coded or textual form.
- 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 media was made available to providers, typically after having been reviewed.
- basedOn? Reference[] - A procedure that is fulfilled in whole or in part by the creation of this media.
- height? positiveInt - Height of the image in pixels (photo/video).
- identifier? Identifier[] - Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
- frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
- encounter? Reference - The encounter that establishes the context for this media.
- createdPeriod? Period - The date and time(s) at which the media was collected.
- bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- width? positiveInt - Width of the image in pixels (photo/video).
- 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.
- device? Reference - The device used to collect the media.
- status MediaObservationUvIpsStatus - The status of the result value. Only final observations are eligible to be included in the international patient summary.
- Element... - Rest field
health.fhir.r4.ips: MediaObservationUvIpsSubject
FHIR MediaObservationUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: MedicationIPS
FHIR MedicationIPS resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONIPS(default RESOURCE_NAME_MEDICATIONIPS) - The type of the resource describes
- identifier? Identifier[] - Business identifier for this medication.
- amount? Ratio - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConceptUvIps - Medication that was administered or was to be administered. Several kinds of medication coding could be provided as: 1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept; 2. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept; 3. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept; 4. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept 5. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. 6. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. 7. Any other kind of code that that identifies, classifies or cluster the administered product (e.g. the medicinal product or the product class) The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.
- ingredient? MedicationIPSIngredient[] - 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? MedicationIPSBatch - 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? CodeableConceptUvIps - Describes the form of the item. Powder; tablets; capsule. Administrable Pharmaceutical Dose Form. This code represents the form of the medication (e.g. tablet, capsule, liquid) Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration. It is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- status? MedicationIPSStatus - A code to indicate if the medication is in active use.
- Element... - Rest field
health.fhir.r4.ips: MedicationIPSBatch
FHIR MedicationIPSBatch datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: MedicationIPSIngredient
FHIR MedicationIPSIngredient datatype record.
Fields
- Fields Included from *BackboneElement
- 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 - A relationship of two Quantity values - expressed as a numerator and a denominator.
- 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.ips: MedicationRequestIPS
FHIR MedicationRequestIPS resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONREQUESTIPS(default RESOURCE_NAME_MEDICATIONREQUESTIPS) - The type of the resource describes
- insurance? Reference[] - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
- note? Annotation[] - Extra information about the prescription that could not be conveyed by the other attributes.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- substitution? MedicationRequestIPSSubstitution - 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 MedicationRequestIPSSubject - 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 administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code. To improve global interoperability is strongly encouraged that the reference to a medication resource is used, limiting the usage of the medicationCodeableConcept only to the cases in which no other information than a simple code is available.
- 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? MedicationRequestIPSDispenseRequest - 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 administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code. To improve global interoperability is strongly encouraged that the reference to a medication resource is used, limiting the usage of the medicationCodeableConcept only to the cases in which no other information than a simple code is available.
- priority? MedicationRequestIPSPriority - Indicates how quickly the Medication Request should be addressed with respect to other requests.
- intent MedicationRequestIPSIntent - 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? MedicationRequestIPSDosageInstruction[] - Indicates how the medication is to be used by the patient.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- eventHistory? Reference[] - Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- 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 MedicationRequestIPSStatus - A code specifying the current state of the order. Generally, this will be active or completed state.
- Element... - Rest field
health.fhir.r4.ips: MedicationRequestIPSDispenseRequest
FHIR MedicationRequestIPSDispenseRequest datatype record.
Fields
- Fields Included from *BackboneElement
- 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? MedicationRequestIPSDispenseRequestInitialFill - 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.ips: MedicationRequestIPSDispenseRequestInitialFill
FHIR MedicationRequestIPSDispenseRequestInitialFill datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: MedicationRequestIPSDosageInstruction
FHIR MedicationRequestIPSDosageInstruction datatype record.
Fields
- Fields Included from *Dosage
- id string
- extension Extension[]
- modifierExtension Extension[]
- sequence integer
- text string
- addtionalInstruction CodeableConcept[]
- patientInstruction string
- timing Timing
- asNeededBoolean boolean
- asNeededCodeableConcept CodeableConcept
- site CodeableConcept
- route CodeableConcept
- method CodeableConcept
- doseAndRate ElementDoseAndRate[]
- maxDosePerPeriod Ratio
- maxDosePerAdministration SimpleQuantity
- maxDosePerLifetime SimpleQuantity
- Element...
- maxDosePerLifetime? Quantity - Upper limit on medication per lifetime of the patient.
- additionalInstruction? CodeableConcept[] - Supplemental instructions to the patient on how to take the medication (e.g. 'with meals' or'take half to one hour before food') or warnings for the patient about the medication (e.g. 'may cause drowsiness' or 'avoid exposure of skin to direct sunlight or sunlamps').
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- method? CodeableConcept - Technique for administering medication.
- timing? Timing - When medication should be administered.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- doseAndRate? ElementDoseAndRate[] - The amount of medication administered.
- sequence? integer - Indicates the order in which the dosage instructions should be applied or interpreted.
- site? CodeableConcept - Body site to administer to.
- route? CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- asNeededBoolean? boolean - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
- maxDosePerAdministration? Quantity - Upper limit on medication per administration.
- maxDosePerPeriod? Ratio - Upper limit on medication per unit of time.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Free text dosage instructions e.g. SIG.
- asNeededCodeableConcept? CodeableConcept - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
- patientInstruction? string - Instructions in terms that are understood by the patient or consumer.
health.fhir.r4.ips: MedicationRequestIPSSubject
FHIR MedicationRequestIPSSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: MedicationRequestIPSSubstitution
FHIR MedicationRequestIPSSubstitution datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: MedicationStatementIPS
FHIR MedicationStatementIPS resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONSTATEMENTIPS(default RESOURCE_NAME_MEDICATIONSTATEMENTIPS) - The type of the resource describes
- dosage? MedicationStatementIPSDosage[] - Indicates how the medication is/was or should be taken by the patient.
- note? Annotation[] - Provides extra information about the medication statement that is not conveyed by the other attributes.
- partOf? Reference[] - A larger event of which this particular event is a component or step.
- 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 MedicationStatementIPSSubject - The person, animal or group who is/was taking the medication.
- 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 is being/was taken.
- language? code - The base language in which the resource is written.
- medicationReference Reference - Identifies the medication being administered or the reason for absent or unknown Medication. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code. To improve global interoperability is strongly encouraged that the reference to a medication resource is used, limiting the usage of the medicationCodeableConcept only to the cases in which no other information than a simple code is available.
- statusReason? CodeableConcept[] - Captures the reason for the current state of the MedicationStatement.
- informationSource? Reference - The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.
- context? Reference - The encounter or episode of care that establishes the context for this MedicationStatement.
- derivedFrom? Reference[] - Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - A reason for why the medication is being/was taken.
- 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.
- dateAsserted? dateTime - The date when the medication statement was asserted by the information source.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event.
- identifier? Identifier[] - Identifiers associated with this Medication Statement 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.
- effectivePeriod Period - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).
- medicationCodeableConcept CodeableConceptUvIps - Identifies the medication being administered or the reason for absent or unknown Medication. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code. To improve global interoperability is strongly encouraged that the reference to a medication resource is used, limiting the usage of the medicationCodeableConcept only to the cases in which no other information than a simple code is available.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- effectiveDateTime dateTime - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept - Indicates where the medication is expected to be consumed or administered.
- status MedicationStatementIPSStatus - A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.
- Element... - Rest field
health.fhir.r4.ips: MedicationStatementIPSDosage
FHIR MedicationStatementIPSDosage datatype record.
Fields
- Fields Included from *Dosage
- id string
- extension Extension[]
- modifierExtension Extension[]
- sequence integer
- text string
- addtionalInstruction CodeableConcept[]
- patientInstruction string
- timing Timing
- asNeededBoolean boolean
- asNeededCodeableConcept CodeableConcept
- site CodeableConcept
- route CodeableConcept
- method CodeableConcept
- doseAndRate ElementDoseAndRate[]
- maxDosePerPeriod Ratio
- maxDosePerAdministration SimpleQuantity
- maxDosePerLifetime SimpleQuantity
- Element...
- maxDosePerLifetime? Quantity - Upper limit on medication per lifetime of the patient.
- additionalInstruction? CodeableConcept[] - Supplemental instructions to the patient on how to take the medication (e.g. 'with meals' or'take half to one hour before food') or warnings for the patient about the medication (e.g. 'may cause drowsiness' or 'avoid exposure of skin to direct sunlight or sunlamps').
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- method? CodeableConcept - Technique for administering medication.
- timing? Timing - When medication should be administered.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- doseAndRate? ElementDoseAndRate[] - The amount of medication administered.
- sequence? integer - Indicates the order in which the dosage instructions should be applied or interpreted.
- site? CodeableConcept - Body site to administer to.
- route? CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- asNeededBoolean? boolean - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
- maxDosePerAdministration? Quantity - Upper limit on medication per administration.
- maxDosePerPeriod? Ratio - Upper limit on medication per unit of time.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Free text dosage instructions e.g. SIG.
- asNeededCodeableConcept? CodeableConcept - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
- patientInstruction? string - Instructions in terms that are understood by the patient or consumer.
health.fhir.r4.ips: MedicationStatementIPSSubject
FHIR MedicationStatementIPSSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationAlcoholUseUvIps
FHIR ObservationAlcoholUseUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONALCOHOLUSEUVIPS(default RESOURCE_NAME_OBSERVATIONALCOHOLUSEUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ObservationAlcoholUseUvIpsSubject - 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 information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? QuantityUvIps - A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component? ObservationAlcoholUseUvIpsComponent[] - 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? ObservationAlcoholUseUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- status ObservationAlcoholUseUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationAlcoholUseUvIpsCode
FHIR ObservationAlcoholUseUvIpsCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding ObservationAlcoholUseUvIpsCodeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: ObservationAlcoholUseUvIpsCodeCoding
FHIR ObservationAlcoholUseUvIpsCodeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "74013-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ObservationAlcoholUseUvIpsComponent
FHIR ObservationAlcoholUseUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationAlcoholUseUvIpsReferenceRange
FHIR ObservationAlcoholUseUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationAlcoholUseUvIpsSubject
FHIR ObservationAlcoholUseUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationPregnancyEddUvIps
FHIR ObservationPregnancyEddUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONPREGNANCYEDDUVIPS(default RESOURCE_NAME_OBSERVATIONPREGNANCYEDDUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ObservationPregnancyEddUvIpsSubject - 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 information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- 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? ObservationPregnancyEddUvIpsComponent[] - 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? ObservationPregnancyEddUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- status ObservationPregnancyEddUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationPregnancyEddUvIpsComponent
FHIR ObservationPregnancyEddUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationPregnancyEddUvIpsReferenceRange
FHIR ObservationPregnancyEddUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationPregnancyEddUvIpsSubject
FHIR ObservationPregnancyEddUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationPregnancyOutcomeUvIps
FHIR ObservationPregnancyOutcomeUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONPREGNANCYOUTCOMEUVIPS(default RESOURCE_NAME_OBSERVATIONPREGNANCYOUTCOMEUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ObservationPregnancyOutcomeUvIpsSubject - 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 information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- 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? ObservationPregnancyOutcomeUvIpsComponent[] - 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? ObservationPregnancyOutcomeUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- status ObservationPregnancyOutcomeUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationPregnancyOutcomeUvIpsComponent
FHIR ObservationPregnancyOutcomeUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationPregnancyOutcomeUvIpsReferenceRange
FHIR ObservationPregnancyOutcomeUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationPregnancyOutcomeUvIpsSubject
FHIR ObservationPregnancyOutcomeUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationPregnancyStatusUvIps
FHIR ObservationPregnancyStatusUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONPREGNANCYSTATUSUVIPS(default RESOURCE_NAME_OBSERVATIONPREGNANCYSTATUSUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ObservationPregnancyStatusUvIpsSubject - 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 information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? ObservationPregnancyStatusUvIpsHasMember[] - A reference to the Expected Delivery Date Observation.
- 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? ObservationPregnancyStatusUvIpsComponent[] - 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? ObservationPregnancyStatusUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- status ObservationPregnancyStatusUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationPregnancyStatusUvIpsCode
FHIR ObservationPregnancyStatusUvIpsCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding ObservationPregnancyStatusUvIpsCodeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: ObservationPregnancyStatusUvIpsCodeCoding
FHIR ObservationPregnancyStatusUvIpsCodeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "82810-3") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ObservationPregnancyStatusUvIpsComponent
FHIR ObservationPregnancyStatusUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationPregnancyStatusUvIpsHasMember
FHIR ObservationPregnancyStatusUvIpsHasMember datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationPregnancyStatusUvIpsReferenceRange
FHIR ObservationPregnancyStatusUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationPregnancyStatusUvIpsSubject
FHIR ObservationPregnancyStatusUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationResultsLaboratoryUvIps
FHIR ObservationResultsLaboratoryUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONRESULTSLABORATORYUVIPS(default RESOURCE_NAME_OBSERVATIONRESULTSLABORATORYUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - Describes what was observed. Sometimes this is called the observation 'name'. In this profile this code represents either a simple laboratory test or a laboratory study with multiple child observations
- 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? RangeUvIps - A set of ordered Quantities defined by a low and high limit.
- 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? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- valueRatio? RatioUvIps - A relationship of two Quantity values - expressed as a numerator and a denominator.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? QuantityUvIps - A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.
- 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.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? ObservationResultsLaboratoryUvIpsHasMember[] - A reference to another Observation profiled by Observation-results-laboratory-uv-ips. The target observation (for instance an individual test member of a panel) is considered as a sub-observation of the current one, which plays the role of a grouper.
- 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? ObservationResultsLaboratoryUvIpsComponent[] - 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? ObservationResultsLaboratoryUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConceptUvIps[] - A code that classifies the general type of observation being made. In this profile, fixed to 'laboratory'.
- category Slicings
- ObservationResultsLaboratoryUvIpsCategoryLaboratory: Concept - reference to a terminology or just text
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status ObservationResultsLaboratoryUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationResultsLaboratoryUvIpsCategoryCoding
FHIR ObservationResultsLaboratoryUvIpsCategoryCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "laboratory") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ObservationResultsLaboratoryUvIpsCategoryLaboratory
FHIR ObservationResultsLaboratoryUvIpsCategoryLaboratory datatype record.
Fields
- Fields Included from *CodeableConcept
- coding ObservationResultsLaboratoryUvIpsCategoryCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: ObservationResultsLaboratoryUvIpsComponent
FHIR ObservationResultsLaboratoryUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationResultsLaboratoryUvIpsHasMember
FHIR ObservationResultsLaboratoryUvIpsHasMember datatype record.
Fields
- Fields Included from *Reference
- reference? string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationResultsLaboratoryUvIpsReferenceRange
FHIR ObservationResultsLaboratoryUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationResultsPathologyUvIps
FHIR ObservationResultsPathologyUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONRESULTSPATHOLOGYUVIPS(default RESOURCE_NAME_OBSERVATIONRESULTSPATHOLOGYUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - Describes what was observed. Sometimes this is called the observation 'name'. In this profile this code represents either a simple laboratory test or a laboratory study with multiple child observations
- subject Reference - The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject. In this profile is constrained to the patient
- valueRange? RangeUvIps - A set of ordered Quantities defined by a low and high limit.
- 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? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- valueRatio? RatioUvIps - A relationship of two Quantity values - expressed as a numerator and a denominator.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? QuantityUvIps - A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.
- 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.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? ObservationResultsPathologyUvIpsHasMember[] - A reference to another Observation profiled by Observation-results-pathology-uv-ips. The target observation is considered as a sub-observation of the current one, which plays the role of a grouper
- 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? ObservationResultsPathologyUvIpsComponent[] - 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? ObservationResultsPathologyUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConceptUvIps[] - A code that classifies the general type of observation being made. In this profile, fixed to 'laboratory'.
- category Slicings
- ObservationResultsPathologyUvIpsCategoryLaboratory: Concept - reference to a terminology or just text
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status ObservationResultsPathologyUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationResultsPathologyUvIpsCategoryCoding
FHIR ObservationResultsPathologyUvIpsCategoryCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "laboratory") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ObservationResultsPathologyUvIpsCategoryLaboratory
FHIR ObservationResultsPathologyUvIpsCategoryLaboratory datatype record.
Fields
- Fields Included from *CodeableConcept
- coding ObservationResultsPathologyUvIpsCategoryCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: ObservationResultsPathologyUvIpsComponent
FHIR ObservationResultsPathologyUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationResultsPathologyUvIpsHasMember
FHIR ObservationResultsPathologyUvIpsHasMember datatype record.
Fields
- Fields Included from *Reference
- reference? string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationResultsPathologyUvIpsReferenceRange
FHIR ObservationResultsPathologyUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationResultsRadiologyUvIps
FHIR ObservationResultsRadiologyUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONRESULTSRADIOLOGYUVIPS(default RESOURCE_NAME_OBSERVATIONRESULTSRADIOLOGYUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- note? Annotation[] - Comments about the observation or the results.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- 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 CodeableConceptUvIps - Describes what was observed. Sometimes this is called the observation 'name'. In this profile the code of the containing observation (the organizer result in the CDA implementation) may correspond to the procedure code (e.g. Chest X-Ray).
- subject Reference - The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject. In this profile is constrained to the patient
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer Reference[] - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? ObservationResultsRadiologyUvIpsHasMember[] - 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.
- referenceRange? ObservationResultsRadiologyUvIpsReferenceRange[] - 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.
- bodySite? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- component? ObservationResultsRadiologyUvIpsComponent[] - 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.
- component Slicings
- ObservationResultsRadiologyUvIpsComponentObservationCode: Observation Code
- min = 0
- max = *
- 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.
- 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.
- 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.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConceptUvIps[] - A code that classifies the general type of observation being made. In this profile, fixed to 'imaging'.
- category Slicings
- ObservationResultsRadiologyUvIpsCategoryRadiology: Concept - reference to a terminology or just text
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status ObservationResultsRadiologyUvIpsStatus - The status of the result value. Only final results feed patient summaries.
- Element... - Rest field
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsCategoryCoding
FHIR ObservationResultsRadiologyUvIpsCategoryCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "imaging") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsCategoryRadiology
FHIR ObservationResultsRadiologyUvIpsCategoryRadiology datatype record.
Fields
- Fields Included from *CodeableConcept
- coding ObservationResultsRadiologyUvIpsCategoryCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsComponent
FHIR ObservationResultsRadiologyUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationResultsRadiologyUvIpsComponentNumericQuantityMeasurement
FHIR ObservationResultsRadiologyUvIpsComponentNumericQuantityMeasurement datatype record.
Fields
- Fields Included from *ObservationResultsRadiologyUvIpsComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element...
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueQuantity Quantity - A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsComponentNumericRangeMeasurement
FHIR ObservationResultsRadiologyUvIpsComponentNumericRangeMeasurement datatype record.
Fields
- Fields Included from *ObservationResultsRadiologyUvIpsComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element...
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueRange Range - A set of ordered Quantities defined by a low and high limit.
- 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.ips: ObservationResultsRadiologyUvIpsComponentNumericRatioMeasurement
FHIR ObservationResultsRadiologyUvIpsComponentNumericRatioMeasurement datatype record.
Fields
- Fields Included from *ObservationResultsRadiologyUvIpsComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element...
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- valueRatio Ratio - A relationship of two Quantity values - expressed as a numerator and a denominator.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsComponentNumericSampledDataMeasurement
FHIR ObservationResultsRadiologyUvIpsComponentNumericSampledDataMeasurement datatype record.
Fields
- Fields Included from *ObservationResultsRadiologyUvIpsComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element...
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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.
- 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.ips: ObservationResultsRadiologyUvIpsComponentObservationCode
FHIR ObservationResultsRadiologyUvIpsComponentObservationCode datatype record.
Fields
- Fields Included from *ObservationResultsRadiologyUvIpsComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element...
- valueCodeableConcept CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsComponentObservationText
FHIR ObservationResultsRadiologyUvIpsComponentObservationText datatype record.
Fields
- Fields Included from *ObservationResultsRadiologyUvIpsComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element...
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- 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.
- 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.ips: ObservationResultsRadiologyUvIpsHasMember
FHIR ObservationResultsRadiologyUvIpsHasMember datatype record.
Fields
- Fields Included from *Reference
- reference? string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationResultsRadiologyUvIpsReferenceRange
FHIR ObservationResultsRadiologyUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationResultsUvIps
FHIR ObservationResultsUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONRESULTSUVIPS(default RESOURCE_NAME_OBSERVATIONRESULTSUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ObservationResultsUvIpsSubject - 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 information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- 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? ObservationResultsUvIpsComponent[] - 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? ObservationResultsUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- device? Reference - The device used to generate the observation data.
- status ObservationResultsUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationResultsUvIpsComponent
FHIR ObservationResultsUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationResultsUvIpsReferenceRange
FHIR ObservationResultsUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationResultsUvIpsSubject
FHIR ObservationResultsUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: ObservationTobaccoUseUvIps
FHIR ObservationTobaccoUseUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONTOBACCOUSEUVIPS(default RESOURCE_NAME_OBSERVATIONTOBACCOUSEUVIPS) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- subject ObservationTobaccoUseUvIpsSubject - 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 information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- 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? ObservationTobaccoUseUvIpsComponent[] - 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? ObservationTobaccoUseUvIpsReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- status ObservationTobaccoUseUvIpsStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.ips: ObservationTobaccoUseUvIpsCode
FHIR ObservationTobaccoUseUvIpsCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding ObservationTobaccoUseUvIpsCodeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.ips: ObservationTobaccoUseUvIpsCodeCoding
FHIR ObservationTobaccoUseUvIpsCodeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "72166-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.ips: ObservationTobaccoUseUvIpsComponent
FHIR ObservationTobaccoUseUvIpsComponent datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ObservationTobaccoUseUvIpsReferenceRange
FHIR ObservationTobaccoUseUvIpsReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ObservationTobaccoUseUvIpsSubject
FHIR ObservationTobaccoUseUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: OrganizationUvIps
FHIR OrganizationUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ORGANIZATIONUVIPS(default RESOURCE_NAME_ORGANIZATIONUVIPS) - The type of the resource describes
- 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.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- contact? OrganizationUvIpsContact[] - 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.
- Element... - Rest field
health.fhir.r4.ips: OrganizationUvIpsContact
FHIR OrganizationUvIpsContact datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: PatientUvIps
FHIR PatientUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PATIENTUVIPS(default RESOURCE_NAME_PATIENTUVIPS) - The type of the resource describes
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- gender? PatientUvIpsGender - 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? PatientUvIpsLink[] - Link to another patient resource that concerns the same actual patient.
- language? code - The base language in which the resource is written.
- contact? PatientUvIpsContact[] - 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? PatientUvIpsCommunication[] - 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.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- multipleBirthInteger? integer - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- name PatientUvIpsName[] - A name associated with the individual.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- maritalStatus? CodeableConcept - This field contains a patient's most recent marital (civil) status.
- Element... - Rest field
health.fhir.r4.ips: PatientUvIpsCommunication
FHIR PatientUvIpsCommunication datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: PatientUvIpsContact
FHIR PatientUvIpsContact datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? PatientUvIpsContactGender - 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[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
health.fhir.r4.ips: PatientUvIpsLink
FHIR PatientUvIpsLink datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 PatientUvIpsLinkType - The type of link between this patient resource and another patient resource.
health.fhir.r4.ips: PatientUvIpsName
FHIR PatientUvIpsName datatype record.
Fields
- Fields Included from *HumanName
- given? string[] - Given name.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period? Period - Indicates the period of time when this name was valid for the named person.
- prefix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
- use? PatientUvIpsNameUse - Identifies the purpose for this name.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Text representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element
- family? string - The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
- suffix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
health.fhir.r4.ips: PractitionerRoleUvIps
FHIR PractitionerRoleUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PRACTITIONERROLEUVIPS(default RESOURCE_NAME_PRACTITIONERROLEUVIPS) - The type of the resource describes
- identifier? Identifier[] - Business Identifiers that are specific to a role/location.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period? Period - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
- specialty? CodeableConcept[] - Specific specialty of the practitioner.
- code? CodeableConceptUvIps[] - 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? PractitionerRoleUvIpsNotAvailable[] - The practitioner is not available or performing this role during this period of time due to the provided reason.
- availableTime? PractitionerRoleUvIpsAvailableTime[] - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- endpoint? Reference[] - Technical endpoints providing access to services operated for the practitioner with this role.
- healthcareService? Reference[] - The list of healthcare services that this worker provides for this role's Organization/Location(s).
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- organization? Reference - The organization where the Practitioner performs the roles associated.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location? Reference[] - The location(s) at which this practitioner provides care.
- telecom? 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.
- Element... - Rest field
health.fhir.r4.ips: PractitionerRoleUvIpsAvailableTime
FHIR PractitionerRoleUvIpsAvailableTime datatype record.
Fields
- Fields Included from *BackboneElement
- 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? PractitionerRoleUvIpsAvailableTimeDaysOfWeek[] - 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.ips: PractitionerRoleUvIpsNotAvailable
FHIR PractitionerRoleUvIpsNotAvailable datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: PractitionerUvIps
FHIR PractitionerUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PRACTITIONERUVIPS(default RESOURCE_NAME_PRACTITIONERUVIPS) - The type of the resource describes
- 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? PractitionerUvIpsGender - 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? PractitionerUvIpsQualification[] - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- name PractitionerUvIpsName[] - 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.
- Element... - Rest field
health.fhir.r4.ips: PractitionerUvIpsName
FHIR PractitionerUvIpsName datatype record.
Fields
- Fields Included from *HumanName
- given? string[] - Given name.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period? Period - Indicates the period of time when this name was valid for the named person.
- prefix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
- use? PractitionerUvIpsNameUse - Identifies the purpose for this name.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
- family? string - The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
- suffix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
health.fhir.r4.ips: PractitionerUvIpsQualification
FHIR PractitionerUvIpsQualification datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ProcedureUvIps
FHIR ProcedureUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PROCEDUREUVIPS(default RESOURCE_NAME_PROCEDUREUVIPS) - The type of the resource describes
- note? Annotation[] - Any other notes and comments about the procedure.
- partOf? Reference[] - A larger event of which this particular procedure is a component or step.
- complication? CodeableConcept[] - Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConceptUvIps - Identification of the procedure or recording of 'absence of relevant procedures' or of 'procedures unknown'.
- subject ProcedureUvIpsSubject - The person on which the procedure was performed.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference? Reference[] - The justification of why the procedure was performed.
- language? code - The base language in which the resource is written.
- performedRange Range - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performedAge Age - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- performedPeriod Period - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performedString string - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- followUp? CodeableConcept[] - If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
- statusReason? CodeableConcept - Captures the reason for the current state of the procedure.
- usedCode? CodeableConcept[] - Identifies coded items that were used as part of the procedure.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- performedDateTime dateTime - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- basedOn? Reference[] - A reference to a resource that contains details of the request for this procedure.
- outcome? CodeableConcept - The outcome of the procedure - did it resolve the reasons for the procedure being performed?
- identifier? Identifier[] - Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
- recorder? Reference - Individual who recorded the record and takes responsibility for its content.
- complicationDetail? Reference[] - Any complications that occurred during the procedure, or in the immediate post-performance period.
- performer? ProcedureUvIpsPerformer[] - Limited to 'real' people rather than equipment.
- usedReference? Reference[] - Identifies medications, devices and any other substance used as part of the procedure.
- focalDevice? ProcedureUvIpsFocalDevice[] - 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? CodeableConceptUvIps[] - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- asserter? Reference - Individual who is making the procedure statement.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- report? Reference[] - This could be a histology result, pathology report, surgical report, etc.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location? Reference - The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
- category? CodeableConcept - A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure').
- status ProcedureUvIpsStatus - A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
- Element... - Rest field
health.fhir.r4.ips: ProcedureUvIpsFocalDevice
FHIR ProcedureUvIpsFocalDevice datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.ips: ProcedureUvIpsPerformer
FHIR ProcedureUvIpsPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- 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.ips: ProcedureUvIpsSubject
FHIR ProcedureUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
health.fhir.r4.ips: QuantityUvIps
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- comparator? QuantityComparatorCode -
- unit? string -
- system uri -
- code code -
- value? decimal -
health.fhir.r4.ips: RangeUvIps
Fields
- Fields Included from *Range
- id string
- extension Extension[]
- low SimpleQuantity
- high SimpleQuantity
- Element...
- id? string -
- extension? Extension[] -
- high? Quantity -
- low? Quantity -
health.fhir.r4.ips: RatioUvIps
Fields
- Fields Included from *Ratio
- id string
- extension Extension[]
- numerator SimpleQuantity
- denominator SimpleQuantity
- Element...
- id? string -
- extension? Extension[] -
- numerator? Quantity -
- denominator? Quantity -
health.fhir.r4.ips: SimpleQuantityUvIps
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- unit? string -
- system uri -
- code code -
- value? decimal -
health.fhir.r4.ips: SpecimenUvIps
FHIR SpecimenUvIps resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SPECIMENUVIPS(default RESOURCE_NAME_SPECIMENUVIPS) - The type of the resource describes
- container? SpecimenUvIpsContainer[] - The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
- accessionIdentifier? Identifier - The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
- identifier? Identifier[] - Id for specimen.
- note? Annotation[] - To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
- parent? Reference[] - Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
- request? Reference[] - Details concerning a service request that required a specimen to be collected.
- 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? SpecimenUvIpsSubject - Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
- 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.
- collection? SpecimenUvIpsCollection - Details concerning the specimen collection.
- 'type CodeableConceptUvIps - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- condition? CodeableConcept[] - A mode or state of being that describes the nature of the specimen.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- receivedTime? dateTime - Time when specimen was received for processing or testing.
- 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.
- processing? SpecimenUvIpsProcessing[] - Details concerning processing and processing steps for the specimen.
- 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? SpecimenUvIpsStatus - The availability of the specimen.
- Element... - Rest field
health.fhir.r4.ips: SpecimenUvIpsCollection
FHIR SpecimenUvIpsCollection datatype record.
Fields
- Fields Included from *BackboneElement
- duration? Duration - The span of time over which the collection of a specimen occurred.
- bodySite? CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- fastingStatusDuration? Duration - Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
- quantity? Quantity - The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
- collectedPeriod? Period - Time when specimen was collected from subject - the physiologically relevant time.
- method? CodeableConcept - A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- collectedDateTime? dateTime - Time when specimen was collected from subject - the physiologically relevant time.
- 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).
- fastingStatusCodeableConcept? CodeableConcept - Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- collector? Reference - Person who collected the specimen.
health.fhir.r4.ips: SpecimenUvIpsContainer
FHIR SpecimenUvIpsContainer datatype record.
Fields
- Fields Included from *BackboneElement
- identifier? Identifier[] - Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.
- specimenQuantity? Quantity - The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Textual description of the container.
- 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 container associated with the specimen (e.g. slide, aliquot, etc.).
- additiveReference? Reference - Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- additiveCodeableConcept? CodeableConcept - Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- capacity? Quantity - The capacity (volume or other measure) the container may contain.
health.fhir.r4.ips: SpecimenUvIpsProcessing
FHIR SpecimenUvIpsProcessing datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- timePeriod? Period - A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
- description? string - Textual description of 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.
- procedure? CodeableConcept - A coded value specifying the procedure used to process the specimen.
- timeDateTime? dateTime - A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
- additive? Reference[] - Material used in the processing step.
health.fhir.r4.ips: SpecimenUvIpsSubject
FHIR SpecimenUvIpsSubject datatype record.
Fields
- Fields Included from *Reference
- reference string - A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
- identifier? Identifier - An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? uri - The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. 'Patient' is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Import
import ballerinax/health.fhir.r4.ips;
Metadata
Released date: 4 days ago
Version: 1.0.2
Compatibility
Platform: any
Ballerina version: 2201.10.2
GraalVM compatible: Yes
Pull count
Total: 18
Current verison: 0
Weekly downloads
Keywords
Healthcare
FHIR
R4
ips
Contributors