health.fhir.r4.international401
Module health.fhir.r4.international401
API
Declarations
Definitions
ballerinax/health.fhir.r4.international401 Ballerina library
FHIR R4 Base Module
Sample Usage
This section focuses on samples depicting how to use this package to implement FHIR related integrations
Prerequisites
- Install Ballerina 2201.6.0 or later
1. Parse JSON FHIR resource to FHIR resource model
Sample below is using the Patient resource in health.fhir.r4.international401
package.
import ballerina/log; import ballerinax/health.fhir.r4.international401; import ballerinax/health.fhir.r4.parser; public function main() { json payload = { "resourceType": "Patient", "id": "1", "meta": { "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, "active":true, "name":[ { "use":"official", "family":"Chalmers", "given":[ "Peter", "James" ] } ], "gender":"male", "birthDate":"1974-12-25", "managingOrganization":{ "reference":"Organization/1" } }; do { anydata parsedResult = check parser:parse(patientPayload, international401:Patient); international401:Patient patientModel = check parsedResult.ensureType(); log:printInfo(string `Patient name : ${patientModel.name.toString()}`); } on fail error parseError { log:printError(string `Error occurred while parsing : ${parseError.message()}`, parseError); } }
2. Creating FHIR Resource models and serializing to JSON wire formats
import ballerina/log; import ballerina/time; import ballerinax/health.fhir.r4; import ballerinax/health.fhir.r4.international401; public function main() { international401:Patient patient = { meta: { lastUpdated: time:utcToString(time:utcNow()), profile: [international401:PROFILE_BASE_PATIENT] }, active: true, name: [{ family: "Doe", given: ["Jhon"], use: r4:official, prefix: ["Mr"] }], address: [{ line: ["652 S. Lantern Dr."], city: "New York", country: "United States", postalCode: "10022", 'type: r4:physical, use: r4:home }] }; r4:FHIRResourceEntity fhirEntity = new(patient); // Serialize FHIR resource record to Json payload json|r4:FHIRSerializerError jsonResult = fhirEntity.toJson(); if jsonResult is json { log:printInfo(string `Patient resource JSON payload : ${jsonResult.toString()}`); } else { log:printError(string `Error occurred while serializing to JSON payload : ${jsonResult.message()}`, jsonResult); } }
Functions
initialize
function initialize()
This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.international401: PROFILE_BASE_ACCOUNT
health.fhir.r4.international401: PROFILE_BASE_ACTIVITYDEFINITION
health.fhir.r4.international401: PROFILE_BASE_ADVERSEEVENT
health.fhir.r4.international401: PROFILE_BASE_ALLERGYINTOLERANCE
health.fhir.r4.international401: PROFILE_BASE_APPOINTMENT
health.fhir.r4.international401: PROFILE_BASE_APPOINTMENTRESPONSE
health.fhir.r4.international401: PROFILE_BASE_AUDITEVENT
health.fhir.r4.international401: PROFILE_BASE_BASIC
health.fhir.r4.international401: PROFILE_BASE_BINARY
health.fhir.r4.international401: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCT
health.fhir.r4.international401: PROFILE_BASE_BODYSTRUCTURE
health.fhir.r4.international401: PROFILE_BASE_CAPABILITYSTATEMENT
health.fhir.r4.international401: PROFILE_BASE_CAREPLAN
health.fhir.r4.international401: PROFILE_BASE_CARETEAM
health.fhir.r4.international401: PROFILE_BASE_CATALOGENTRY
health.fhir.r4.international401: PROFILE_BASE_CHARGEITEM
health.fhir.r4.international401: PROFILE_BASE_CHARGEITEMDEFINITION
health.fhir.r4.international401: PROFILE_BASE_CLAIM
health.fhir.r4.international401: PROFILE_BASE_CLAIMRESPONSE
health.fhir.r4.international401: PROFILE_BASE_CLINICALIMPRESSION
health.fhir.r4.international401: PROFILE_BASE_COMMUNICATION
health.fhir.r4.international401: PROFILE_BASE_COMMUNICATIONREQUEST
health.fhir.r4.international401: PROFILE_BASE_COMPARTMENTDEFINITION
health.fhir.r4.international401: PROFILE_BASE_COMPOSITION
health.fhir.r4.international401: PROFILE_BASE_CONCEPTMAP
health.fhir.r4.international401: PROFILE_BASE_CONDITION
health.fhir.r4.international401: PROFILE_BASE_CONSENT
health.fhir.r4.international401: PROFILE_BASE_CONTRACT
health.fhir.r4.international401: PROFILE_BASE_COVERAGE
health.fhir.r4.international401: PROFILE_BASE_COVERAGEELIGIBILITYREQUEST
health.fhir.r4.international401: PROFILE_BASE_COVERAGEELIGIBILITYRESPONSE
health.fhir.r4.international401: PROFILE_BASE_DETECTEDISSUE
health.fhir.r4.international401: PROFILE_BASE_DEVICE
health.fhir.r4.international401: PROFILE_BASE_DEVICEDEFINITION
health.fhir.r4.international401: PROFILE_BASE_DEVICEMETRIC
health.fhir.r4.international401: PROFILE_BASE_DEVICEREQUEST
health.fhir.r4.international401: PROFILE_BASE_DEVICEUSESTATEMENT
health.fhir.r4.international401: PROFILE_BASE_DIAGNOSTICREPORT
health.fhir.r4.international401: PROFILE_BASE_DOCUMENTMANIFEST
health.fhir.r4.international401: PROFILE_BASE_DOCUMENTREFERENCE
health.fhir.r4.international401: PROFILE_BASE_EFFECTEVIDENCESYNTHESIS
health.fhir.r4.international401: PROFILE_BASE_ENCOUNTER
health.fhir.r4.international401: PROFILE_BASE_ENDPOINT
health.fhir.r4.international401: PROFILE_BASE_ENROLLMENTREQUEST
health.fhir.r4.international401: PROFILE_BASE_ENROLLMENTRESPONSE
health.fhir.r4.international401: PROFILE_BASE_EPISODEOFCARE
health.fhir.r4.international401: PROFILE_BASE_EVENTDEFINITION
health.fhir.r4.international401: PROFILE_BASE_EVIDENCE
health.fhir.r4.international401: PROFILE_BASE_EVIDENCEVARIABLE
health.fhir.r4.international401: PROFILE_BASE_EXAMPLESCENARIO
health.fhir.r4.international401: PROFILE_BASE_EXPLANATIONOFBENEFIT
health.fhir.r4.international401: PROFILE_BASE_FAMILYMEMBERHISTORY
health.fhir.r4.international401: PROFILE_BASE_FLAG
health.fhir.r4.international401: PROFILE_BASE_GOAL
health.fhir.r4.international401: PROFILE_BASE_GRAPHDEFINITION
health.fhir.r4.international401: PROFILE_BASE_GROUP
health.fhir.r4.international401: PROFILE_BASE_GUIDANCERESPONSE
health.fhir.r4.international401: PROFILE_BASE_HEALTHCARESERVICE
health.fhir.r4.international401: PROFILE_BASE_IMAGINGSTUDY
health.fhir.r4.international401: PROFILE_BASE_IMMUNIZATION
health.fhir.r4.international401: PROFILE_BASE_IMMUNIZATIONEVALUATION
health.fhir.r4.international401: PROFILE_BASE_IMMUNIZATIONRECOMMENDATION
health.fhir.r4.international401: PROFILE_BASE_IMPLEMENTATIONGUIDE
health.fhir.r4.international401: PROFILE_BASE_INSURANCEPLAN
health.fhir.r4.international401: PROFILE_BASE_INVOICE
health.fhir.r4.international401: PROFILE_BASE_LIBRARY
health.fhir.r4.international401: PROFILE_BASE_LINKAGE
health.fhir.r4.international401: PROFILE_BASE_LIST
health.fhir.r4.international401: PROFILE_BASE_LOCATION
health.fhir.r4.international401: PROFILE_BASE_MEASURE
health.fhir.r4.international401: PROFILE_BASE_MEASUREREPORT
health.fhir.r4.international401: PROFILE_BASE_MEDIA
health.fhir.r4.international401: PROFILE_BASE_MEDICATION
health.fhir.r4.international401: PROFILE_BASE_MEDICATIONADMINISTRATION
health.fhir.r4.international401: PROFILE_BASE_MEDICATIONDISPENSE
health.fhir.r4.international401: PROFILE_BASE_MEDICATIONKNOWLEDGE
health.fhir.r4.international401: PROFILE_BASE_MEDICATIONREQUEST
health.fhir.r4.international401: PROFILE_BASE_MEDICATIONSTATEMENT
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCT
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTAUTHORIZATION
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTCONTRAINDICATION
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTINDICATION
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTINGREDIENT
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTINTERACTION
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTMANUFACTURED
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTPACKAGED
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTPHARMACEUTICAL
health.fhir.r4.international401: PROFILE_BASE_MEDICINALPRODUCTUNDESIRABLEEFFECT
health.fhir.r4.international401: PROFILE_BASE_MESSAGEDEFINITION
health.fhir.r4.international401: PROFILE_BASE_MESSAGEHEADER
health.fhir.r4.international401: PROFILE_BASE_MOLECULARSEQUENCE
health.fhir.r4.international401: PROFILE_BASE_NAMINGSYSTEM
health.fhir.r4.international401: PROFILE_BASE_NUTRITIONORDER
health.fhir.r4.international401: PROFILE_BASE_OBSERVATION
health.fhir.r4.international401: PROFILE_BASE_OBSERVATIONDEFINITION
health.fhir.r4.international401: PROFILE_BASE_OPERATIONDEFINITION
health.fhir.r4.international401: PROFILE_BASE_ORGANIZATION
health.fhir.r4.international401: PROFILE_BASE_ORGANIZATIONAFFILIATION
health.fhir.r4.international401: PROFILE_BASE_PARAMETERS
health.fhir.r4.international401: PROFILE_BASE_PATIENT
health.fhir.r4.international401: PROFILE_BASE_PAYMENTNOTICE
health.fhir.r4.international401: PROFILE_BASE_PAYMENTRECONCILIATION
health.fhir.r4.international401: PROFILE_BASE_PERSON
health.fhir.r4.international401: PROFILE_BASE_PLANDEFINITION
health.fhir.r4.international401: PROFILE_BASE_PRACTITIONER
health.fhir.r4.international401: PROFILE_BASE_PRACTITIONERROLE
health.fhir.r4.international401: PROFILE_BASE_PROCEDURE
health.fhir.r4.international401: PROFILE_BASE_PROVENANCE
health.fhir.r4.international401: PROFILE_BASE_QUESTIONNAIRE
health.fhir.r4.international401: PROFILE_BASE_QUESTIONNAIRERESPONSE
health.fhir.r4.international401: PROFILE_BASE_RELATEDPERSON
health.fhir.r4.international401: PROFILE_BASE_REQUESTGROUP
health.fhir.r4.international401: PROFILE_BASE_RESEARCHDEFINITION
health.fhir.r4.international401: PROFILE_BASE_RESEARCHELEMENTDEFINITION
health.fhir.r4.international401: PROFILE_BASE_RESEARCHSTUDY
health.fhir.r4.international401: PROFILE_BASE_RESEARCHSUBJECT
health.fhir.r4.international401: PROFILE_BASE_RISKASSESSMENT
health.fhir.r4.international401: PROFILE_BASE_RISKEVIDENCESYNTHESIS
health.fhir.r4.international401: PROFILE_BASE_SCHEDULE
health.fhir.r4.international401: PROFILE_BASE_SEARCHPARAMETER
health.fhir.r4.international401: PROFILE_BASE_SERVICEREQUEST
health.fhir.r4.international401: PROFILE_BASE_SLOT
health.fhir.r4.international401: PROFILE_BASE_SPECIMEN
health.fhir.r4.international401: PROFILE_BASE_SPECIMENDEFINITION
health.fhir.r4.international401: PROFILE_BASE_STRUCTUREDEFINITION
health.fhir.r4.international401: PROFILE_BASE_STRUCTUREMAP
health.fhir.r4.international401: PROFILE_BASE_SUBSCRIPTION
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCE
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCENUCLEICACID
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCEPOLYMER
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCEPROTEIN
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCEREFERENCEINFORMATION
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCESOURCEMATERIAL
health.fhir.r4.international401: PROFILE_BASE_SUBSTANCESPECIFICATION
health.fhir.r4.international401: PROFILE_BASE_SUPPLYDELIVERY
health.fhir.r4.international401: PROFILE_BASE_SUPPLYREQUEST
health.fhir.r4.international401: PROFILE_BASE_TASK
health.fhir.r4.international401: PROFILE_BASE_TERMINOLOGYCAPABILITIES
health.fhir.r4.international401: PROFILE_BASE_TESTREPORT
health.fhir.r4.international401: PROFILE_BASE_TESTSCRIPT
health.fhir.r4.international401: PROFILE_BASE_VERIFICATIONRESULT
health.fhir.r4.international401: PROFILE_BASE_VISIONPRESCRIPTION
health.fhir.r4.international401: RESOURCE_NAME_ACCOUNT
health.fhir.r4.international401: RESOURCE_NAME_ACTIVITYDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_ADVERSEEVENT
health.fhir.r4.international401: RESOURCE_NAME_ALLERGYINTOLERANCE
health.fhir.r4.international401: RESOURCE_NAME_APPOINTMENT
health.fhir.r4.international401: RESOURCE_NAME_APPOINTMENTRESPONSE
health.fhir.r4.international401: RESOURCE_NAME_AUDITEVENT
health.fhir.r4.international401: RESOURCE_NAME_BASIC
health.fhir.r4.international401: RESOURCE_NAME_BINARY
health.fhir.r4.international401: RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT
health.fhir.r4.international401: RESOURCE_NAME_BODYSTRUCTURE
health.fhir.r4.international401: RESOURCE_NAME_CAPABILITYSTATEMENT
health.fhir.r4.international401: RESOURCE_NAME_CAREPLAN
health.fhir.r4.international401: RESOURCE_NAME_CARETEAM
health.fhir.r4.international401: RESOURCE_NAME_CATALOGENTRY
health.fhir.r4.international401: RESOURCE_NAME_CHARGEITEM
health.fhir.r4.international401: RESOURCE_NAME_CHARGEITEMDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_CLAIM
health.fhir.r4.international401: RESOURCE_NAME_CLAIMRESPONSE
health.fhir.r4.international401: RESOURCE_NAME_CLINICALIMPRESSION
health.fhir.r4.international401: RESOURCE_NAME_COMMUNICATION
health.fhir.r4.international401: RESOURCE_NAME_COMMUNICATIONREQUEST
health.fhir.r4.international401: RESOURCE_NAME_COMPARTMENTDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_COMPOSITION
health.fhir.r4.international401: RESOURCE_NAME_CONCEPTMAP
health.fhir.r4.international401: RESOURCE_NAME_CONDITION
health.fhir.r4.international401: RESOURCE_NAME_CONSENT
health.fhir.r4.international401: RESOURCE_NAME_CONTRACT
health.fhir.r4.international401: RESOURCE_NAME_COVERAGE
health.fhir.r4.international401: RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST
health.fhir.r4.international401: RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE
health.fhir.r4.international401: RESOURCE_NAME_DETECTEDISSUE
health.fhir.r4.international401: RESOURCE_NAME_DEVICE
health.fhir.r4.international401: RESOURCE_NAME_DEVICEDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_DEVICEMETRIC
health.fhir.r4.international401: RESOURCE_NAME_DEVICEREQUEST
health.fhir.r4.international401: RESOURCE_NAME_DEVICEUSESTATEMENT
health.fhir.r4.international401: RESOURCE_NAME_DIAGNOSTICREPORT
health.fhir.r4.international401: RESOURCE_NAME_DOCUMENTMANIFEST
health.fhir.r4.international401: RESOURCE_NAME_DOCUMENTREFERENCE
health.fhir.r4.international401: RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS
health.fhir.r4.international401: RESOURCE_NAME_ENCOUNTER
health.fhir.r4.international401: RESOURCE_NAME_ENDPOINT
health.fhir.r4.international401: RESOURCE_NAME_ENROLLMENTREQUEST
health.fhir.r4.international401: RESOURCE_NAME_ENROLLMENTRESPONSE
health.fhir.r4.international401: RESOURCE_NAME_EPISODEOFCARE
health.fhir.r4.international401: RESOURCE_NAME_EVENTDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_EVIDENCE
health.fhir.r4.international401: RESOURCE_NAME_EVIDENCEVARIABLE
health.fhir.r4.international401: RESOURCE_NAME_EXAMPLESCENARIO
health.fhir.r4.international401: RESOURCE_NAME_EXPLANATIONOFBENEFIT
health.fhir.r4.international401: RESOURCE_NAME_FAMILYMEMBERHISTORY
health.fhir.r4.international401: RESOURCE_NAME_FLAG
health.fhir.r4.international401: RESOURCE_NAME_GOAL
health.fhir.r4.international401: RESOURCE_NAME_GRAPHDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_GROUP
health.fhir.r4.international401: RESOURCE_NAME_GUIDANCERESPONSE
health.fhir.r4.international401: RESOURCE_NAME_HEALTHCARESERVICE
health.fhir.r4.international401: RESOURCE_NAME_IMAGINGSTUDY
health.fhir.r4.international401: RESOURCE_NAME_IMMUNIZATION
health.fhir.r4.international401: RESOURCE_NAME_IMMUNIZATIONEVALUATION
health.fhir.r4.international401: RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION
health.fhir.r4.international401: RESOURCE_NAME_IMPLEMENTATIONGUIDE
health.fhir.r4.international401: RESOURCE_NAME_INSURANCEPLAN
health.fhir.r4.international401: RESOURCE_NAME_INVOICE
health.fhir.r4.international401: RESOURCE_NAME_LIBRARY
health.fhir.r4.international401: RESOURCE_NAME_LINKAGE
health.fhir.r4.international401: RESOURCE_NAME_LIST
health.fhir.r4.international401: RESOURCE_NAME_LOCATION
health.fhir.r4.international401: RESOURCE_NAME_MEASURE
health.fhir.r4.international401: RESOURCE_NAME_MEASUREREPORT
health.fhir.r4.international401: RESOURCE_NAME_MEDIA
health.fhir.r4.international401: RESOURCE_NAME_MEDICATION
health.fhir.r4.international401: RESOURCE_NAME_MEDICATIONADMINISTRATION
health.fhir.r4.international401: RESOURCE_NAME_MEDICATIONDISPENSE
health.fhir.r4.international401: RESOURCE_NAME_MEDICATIONKNOWLEDGE
health.fhir.r4.international401: RESOURCE_NAME_MEDICATIONREQUEST
health.fhir.r4.international401: RESOURCE_NAME_MEDICATIONSTATEMENT
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCT
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTINDICATION
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTINTERACTION
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTPACKAGED
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL
health.fhir.r4.international401: RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT
health.fhir.r4.international401: RESOURCE_NAME_MESSAGEDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_MESSAGEHEADER
health.fhir.r4.international401: RESOURCE_NAME_MOLECULARSEQUENCE
health.fhir.r4.international401: RESOURCE_NAME_NAMINGSYSTEM
health.fhir.r4.international401: RESOURCE_NAME_NUTRITIONORDER
health.fhir.r4.international401: RESOURCE_NAME_OBSERVATION
health.fhir.r4.international401: RESOURCE_NAME_OBSERVATIONDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_OPERATIONDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_ORGANIZATION
health.fhir.r4.international401: RESOURCE_NAME_ORGANIZATIONAFFILIATION
health.fhir.r4.international401: RESOURCE_NAME_PARAMETERS
health.fhir.r4.international401: RESOURCE_NAME_PATIENT
health.fhir.r4.international401: RESOURCE_NAME_PAYMENTNOTICE
health.fhir.r4.international401: RESOURCE_NAME_PAYMENTRECONCILIATION
health.fhir.r4.international401: RESOURCE_NAME_PERSON
health.fhir.r4.international401: RESOURCE_NAME_PLANDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_PRACTITIONER
health.fhir.r4.international401: RESOURCE_NAME_PRACTITIONERROLE
health.fhir.r4.international401: RESOURCE_NAME_PROCEDURE
health.fhir.r4.international401: RESOURCE_NAME_PROVENANCE
health.fhir.r4.international401: RESOURCE_NAME_QUESTIONNAIRE
health.fhir.r4.international401: RESOURCE_NAME_QUESTIONNAIRERESPONSE
health.fhir.r4.international401: RESOURCE_NAME_RELATEDPERSON
health.fhir.r4.international401: RESOURCE_NAME_REQUESTGROUP
health.fhir.r4.international401: RESOURCE_NAME_RESEARCHDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_RESEARCHELEMENTDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_RESEARCHSTUDY
health.fhir.r4.international401: RESOURCE_NAME_RESEARCHSUBJECT
health.fhir.r4.international401: RESOURCE_NAME_RISKASSESSMENT
health.fhir.r4.international401: RESOURCE_NAME_RISKEVIDENCESYNTHESIS
health.fhir.r4.international401: RESOURCE_NAME_SCHEDULE
health.fhir.r4.international401: RESOURCE_NAME_SEARCHPARAMETER
health.fhir.r4.international401: RESOURCE_NAME_SERVICEREQUEST
health.fhir.r4.international401: RESOURCE_NAME_SLOT
health.fhir.r4.international401: RESOURCE_NAME_SPECIMEN
health.fhir.r4.international401: RESOURCE_NAME_SPECIMENDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_STRUCTUREDEFINITION
health.fhir.r4.international401: RESOURCE_NAME_STRUCTUREMAP
health.fhir.r4.international401: RESOURCE_NAME_SUBSCRIPTION
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCE
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCENUCLEICACID
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCEPOLYMER
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCEPROTEIN
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCEREFERENCEINFORMATION
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCESOURCEMATERIAL
health.fhir.r4.international401: RESOURCE_NAME_SUBSTANCESPECIFICATION
health.fhir.r4.international401: RESOURCE_NAME_SUPPLYDELIVERY
health.fhir.r4.international401: RESOURCE_NAME_SUPPLYREQUEST
health.fhir.r4.international401: RESOURCE_NAME_TASK
health.fhir.r4.international401: RESOURCE_NAME_TERMINOLOGYCAPABILITIES
health.fhir.r4.international401: RESOURCE_NAME_TESTREPORT
health.fhir.r4.international401: RESOURCE_NAME_TESTSCRIPT
health.fhir.r4.international401: RESOURCE_NAME_VERIFICATIONRESULT
health.fhir.r4.international401: RESOURCE_NAME_VISIONPRESCRIPTION
Enums
health.fhir.r4.international401: AccountStatus
AccountStatus enum
Members
health.fhir.r4.international401: ActivityDefinitionIntent
ActivityDefinitionIntent enum
Members
health.fhir.r4.international401: ActivityDefinitionParticipantType
ActivityDefinitionParticipantType enum
Members
health.fhir.r4.international401: ActivityDefinitionPriority
ActivityDefinitionPriority enum
Members
health.fhir.r4.international401: ActivityDefinitionStatus
ActivityDefinitionStatus enum
Members
health.fhir.r4.international401: AdverseEventActuality
AdverseEventActuality enum
Members
health.fhir.r4.international401: AllergyIntoleranceCategory
AllergyIntoleranceCategory enum
Members
health.fhir.r4.international401: AllergyIntoleranceCriticality
AllergyIntoleranceCriticality enum
Members
health.fhir.r4.international401: AllergyIntoleranceReactionSeverity
AllergyIntoleranceReactionSeverity enum
Members
health.fhir.r4.international401: AllergyIntoleranceType
AllergyIntoleranceType enum
Members
health.fhir.r4.international401: AppointmentParticipantRequired
AppointmentParticipantRequired enum
Members
health.fhir.r4.international401: AppointmentParticipantStatus
AppointmentParticipantStatus enum
Members
health.fhir.r4.international401: AppointmentResponseParticipantStatus
AppointmentResponseParticipantStatus enum
Members
health.fhir.r4.international401: AppointmentStatus
AppointmentStatus enum
Members
health.fhir.r4.international401: BiologicallyDerivedProductProductCategory
BiologicallyDerivedProductProductCategory enum
Members
health.fhir.r4.international401: BiologicallyDerivedProductStatus
BiologicallyDerivedProductStatus enum
Members
health.fhir.r4.international401: BiologicallyDerivedProductStorageScale
BiologicallyDerivedProductStorageScale enum
Members
health.fhir.r4.international401: CapabilityStatementDocumentMode
CapabilityStatementDocumentMode enum
Members
health.fhir.r4.international401: CapabilityStatementFormat
CapabilityStatementFormat enum
Members
health.fhir.r4.international401: CapabilityStatementKind
CapabilityStatementKind enum
Members
health.fhir.r4.international401: CapabilityStatementMessagingSupportedMessageMode
CapabilityStatementMessagingSupportedMessageMode enum
Members
health.fhir.r4.international401: CapabilityStatementRestInteractionCode
CapabilityStatementRestInteractionCode enum
Members
health.fhir.r4.international401: CapabilityStatementRestMode
CapabilityStatementRestMode enum
Members
health.fhir.r4.international401: CapabilityStatementRestResourceConditionalDelete
CapabilityStatementRestResourceConditionalDelete enum
Members
health.fhir.r4.international401: CapabilityStatementRestResourceConditionalRead
CapabilityStatementRestResourceConditionalRead enum
Members
health.fhir.r4.international401: CapabilityStatementRestResourceInteractionCode
CapabilityStatementRestResourceInteractionCode enum
Members
health.fhir.r4.international401: CapabilityStatementRestResourceReferencePolicy
CapabilityStatementRestResourceReferencePolicy enum
Members
health.fhir.r4.international401: CapabilityStatementRestResourceSearchParamType
CapabilityStatementRestResourceSearchParamType enum
Members
health.fhir.r4.international401: CapabilityStatementRestResourceVersioning
CapabilityStatementRestResourceVersioning enum
Members
health.fhir.r4.international401: CapabilityStatementStatus
CapabilityStatementStatus enum
Members
health.fhir.r4.international401: CarePlanActivityDetailKind
CarePlanActivityDetailKind enum
Members
health.fhir.r4.international401: CarePlanActivityDetailStatus
CarePlanActivityDetailStatus enum
Members
health.fhir.r4.international401: CarePlanIntent
CarePlanIntent enum
Members
health.fhir.r4.international401: CarePlanStatus
CarePlanStatus enum
Members
health.fhir.r4.international401: CareTeamStatus
CareTeamStatus enum
Members
health.fhir.r4.international401: CatalogEntryRelatedEntryRelationtype
CatalogEntryRelatedEntryRelationtype enum
Members
health.fhir.r4.international401: CatalogEntryStatus
CatalogEntryStatus enum
Members
health.fhir.r4.international401: ChargeItemDefinitionPropertyGroupPriceComponentType
ChargeItemDefinitionPropertyGroupPriceComponentType enum
Members
health.fhir.r4.international401: ChargeItemDefinitionStatus
ChargeItemDefinitionStatus enum
Members
health.fhir.r4.international401: ChargeItemStatus
ChargeItemStatus enum
Members
health.fhir.r4.international401: ClaimResponseOutcome
ClaimResponseOutcome enum
Members
health.fhir.r4.international401: ClaimResponseProcessNoteType
ClaimResponseProcessNoteType enum
Members
health.fhir.r4.international401: ClaimResponseStatus
ClaimResponseStatus enum
Members
health.fhir.r4.international401: ClaimResponseUse
ClaimResponseUse enum
Members
health.fhir.r4.international401: ClaimStatus
ClaimStatus enum
Members
health.fhir.r4.international401: ClaimUse
ClaimUse enum
Members
health.fhir.r4.international401: ClinicalImpressionStatus
ClinicalImpressionStatus enum
Members
health.fhir.r4.international401: CommunicationPriority
CommunicationPriority enum
Members
health.fhir.r4.international401: CommunicationRequestPriority
CommunicationRequestPriority enum
Members
health.fhir.r4.international401: CommunicationRequestStatus
CommunicationRequestStatus enum
Members
health.fhir.r4.international401: CommunicationStatus
CommunicationStatus enum
Members
health.fhir.r4.international401: CompartmentDefinitionCode
CompartmentDefinitionCode enum
Members
health.fhir.r4.international401: CompartmentDefinitionStatus
CompartmentDefinitionStatus enum
Members
health.fhir.r4.international401: CompositionAttesterMode
CompositionAttesterMode enum
Members
health.fhir.r4.international401: CompositionRelatesToCode
CompositionRelatesToCode enum
Members
health.fhir.r4.international401: CompositionSectionMode
CompositionSectionMode enum
Members
health.fhir.r4.international401: CompositionStatus
CompositionStatus enum
Members
health.fhir.r4.international401: ConceptMapGroupElementTargetEquivalence
ConceptMapGroupElementTargetEquivalence enum
Members
health.fhir.r4.international401: ConceptMapGroupUnmappedMode
ConceptMapGroupUnmappedMode enum
Members
health.fhir.r4.international401: ConceptMapStatus
ConceptMapStatus enum
Members
health.fhir.r4.international401: ConsentProvisionDataMeaning
ConsentProvisionDataMeaning enum
Members
health.fhir.r4.international401: ConsentProvisionType
ConsentProvisionType enum
Members
health.fhir.r4.international401: ConsentStatus
ConsentStatus enum
Members
health.fhir.r4.international401: ContractContentDefinitionPublicationStatus
ContractContentDefinitionPublicationStatus enum
Members
health.fhir.r4.international401: ContractStatus
ContractStatus enum
Members
health.fhir.r4.international401: CoverageEligibilityRequestPurpose
CoverageEligibilityRequestPurpose enum
Members
health.fhir.r4.international401: CoverageEligibilityRequestStatus
CoverageEligibilityRequestStatus enum
Members
health.fhir.r4.international401: CoverageEligibilityResponseOutcome
CoverageEligibilityResponseOutcome enum
Members
health.fhir.r4.international401: CoverageEligibilityResponsePurpose
CoverageEligibilityResponsePurpose enum
Members
health.fhir.r4.international401: CoverageEligibilityResponseStatus
CoverageEligibilityResponseStatus enum
Members
health.fhir.r4.international401: CoverageStatus
CoverageStatus enum
Members
health.fhir.r4.international401: DetectedIssueSeverity
DetectedIssueSeverity enum
Members
health.fhir.r4.international401: DetectedIssueStatus
DetectedIssueStatus enum
Members
health.fhir.r4.international401: DeviceDefinitionDeviceNameType
DeviceDefinitionDeviceNameType enum
Members
health.fhir.r4.international401: DeviceDeviceNameType
DeviceDeviceNameType enum
Members
health.fhir.r4.international401: DeviceMetricCalibrationState
DeviceMetricCalibrationState enum
Members
health.fhir.r4.international401: DeviceMetricCalibrationType
DeviceMetricCalibrationType enum
Members
health.fhir.r4.international401: DeviceMetricCategory
DeviceMetricCategory enum
Members
health.fhir.r4.international401: DeviceMetricColor
DeviceMetricColor enum
Members
health.fhir.r4.international401: DeviceMetricOperationalStatus
DeviceMetricOperationalStatus enum
Members
health.fhir.r4.international401: DeviceRequestIntent
DeviceRequestIntent enum
Members
health.fhir.r4.international401: DeviceRequestPriority
DeviceRequestPriority enum
Members
health.fhir.r4.international401: DeviceRequestStatus
DeviceRequestStatus enum
Members
health.fhir.r4.international401: DeviceStatus
DeviceStatus enum
Members
health.fhir.r4.international401: DeviceUdiCarrierEntryType
DeviceUdiCarrierEntryType enum
Members
health.fhir.r4.international401: DeviceUseStatementStatus
DeviceUseStatementStatus enum
Members
health.fhir.r4.international401: DiagnosticReportStatus
DiagnosticReportStatus enum
Members
health.fhir.r4.international401: DocumentManifestStatus
DocumentManifestStatus enum
Members
health.fhir.r4.international401: DocumentReferenceDocStatus
DocumentReferenceDocStatus enum
Members
health.fhir.r4.international401: DocumentReferenceRelatesToCode
DocumentReferenceRelatesToCode enum
Members
health.fhir.r4.international401: DocumentReferenceStatus
DocumentReferenceStatus enum
Members
health.fhir.r4.international401: EffectEvidenceSynthesisResultsByExposureExposureState
EffectEvidenceSynthesisResultsByExposureExposureState enum
Members
health.fhir.r4.international401: EffectEvidenceSynthesisStatus
EffectEvidenceSynthesisStatus enum
Members
health.fhir.r4.international401: EncounterLocationStatus
EncounterLocationStatus enum
Members
health.fhir.r4.international401: EncounterStatus
EncounterStatus enum
Members
health.fhir.r4.international401: EncounterStatusHistoryStatus
EncounterStatusHistoryStatus enum
Members
health.fhir.r4.international401: EndpointStatus
EndpointStatus enum
Members
health.fhir.r4.international401: EnrollmentRequestStatus
EnrollmentRequestStatus enum
Members
health.fhir.r4.international401: EnrollmentResponseOutcome
EnrollmentResponseOutcome enum
Members
health.fhir.r4.international401: EnrollmentResponseStatus
EnrollmentResponseStatus enum
Members
health.fhir.r4.international401: EpisodeOfCareStatus
EpisodeOfCareStatus enum
Members
health.fhir.r4.international401: EpisodeOfCareStatusHistoryStatus
EpisodeOfCareStatusHistoryStatus enum
Members
health.fhir.r4.international401: EventDefinitionStatus
EventDefinitionStatus enum
Members
health.fhir.r4.international401: EvidenceStatus
EvidenceStatus enum
Members
health.fhir.r4.international401: EvidenceVariableCharacteristicGroupMeasure
EvidenceVariableCharacteristicGroupMeasure enum
Members
health.fhir.r4.international401: EvidenceVariableStatus
EvidenceVariableStatus enum
Members
health.fhir.r4.international401: EvidenceVariableType
EvidenceVariableType enum
Members
health.fhir.r4.international401: ExampleScenarioActorType
ExampleScenarioActorType enum
Members
health.fhir.r4.international401: ExampleScenarioStatus
ExampleScenarioStatus enum
Members
health.fhir.r4.international401: ExplanationOfBenefitOutcome
ExplanationOfBenefitOutcome enum
Members
health.fhir.r4.international401: ExplanationOfBenefitProcessNoteType
ExplanationOfBenefitProcessNoteType enum
Members
health.fhir.r4.international401: ExplanationOfBenefitStatus
ExplanationOfBenefitStatus enum
Members
health.fhir.r4.international401: ExplanationOfBenefitUse
ExplanationOfBenefitUse enum
Members
health.fhir.r4.international401: FamilyMemberHistoryStatus
FamilyMemberHistoryStatus enum
Members
health.fhir.r4.international401: FlagStatus
FlagStatus enum
Members
health.fhir.r4.international401: GoalLifecycleStatus
GoalLifecycleStatus enum
Members
health.fhir.r4.international401: GraphDefinitionLinkTargetCompartmentCode
GraphDefinitionLinkTargetCompartmentCode enum
Members
health.fhir.r4.international401: GraphDefinitionLinkTargetCompartmentRule
GraphDefinitionLinkTargetCompartmentRule enum
Members
health.fhir.r4.international401: GraphDefinitionLinkTargetCompartmentUse
GraphDefinitionLinkTargetCompartmentUse enum
Members
health.fhir.r4.international401: GraphDefinitionStatus
GraphDefinitionStatus enum
Members
health.fhir.r4.international401: GroupType
GroupType enum
Members
health.fhir.r4.international401: GuidanceResponseStatus
GuidanceResponseStatus enum
Members
health.fhir.r4.international401: HealthcareServiceAvailableTimeDaysOfWeek
HealthcareServiceAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.international401: ImagingStudyStatus
ImagingStudyStatus enum
Members
health.fhir.r4.international401: ImmunizationEvaluationStatus
ImmunizationEvaluationStatus enum
Members
health.fhir.r4.international401: ImmunizationStatus
ImmunizationStatus enum
Members
health.fhir.r4.international401: ImplementationGuideDefinitionPageGeneration
ImplementationGuideDefinitionPageGeneration enum
Members
health.fhir.r4.international401: ImplementationGuideDefinitionParameterCode
ImplementationGuideDefinitionParameterCode enum
Members
health.fhir.r4.international401: ImplementationGuideStatus
ImplementationGuideStatus enum
Members
health.fhir.r4.international401: InsurancePlanStatus
InsurancePlanStatus enum
Members
health.fhir.r4.international401: InvoiceLineItemPriceComponentType
InvoiceLineItemPriceComponentType enum
Members
health.fhir.r4.international401: InvoiceStatus
InvoiceStatus enum
Members
health.fhir.r4.international401: LibraryStatus
LibraryStatus enum
Members
health.fhir.r4.international401: LinkageItemType
LinkageItemType enum
Members
health.fhir.r4.international401: ListMode
ListMode enum
Members
health.fhir.r4.international401: ListStatus
ListStatus enum
Members
health.fhir.r4.international401: LocationHoursOfOperationDaysOfWeek
LocationHoursOfOperationDaysOfWeek enum
Members
health.fhir.r4.international401: LocationMode
LocationMode enum
Members
health.fhir.r4.international401: LocationStatus
LocationStatus enum
Members
health.fhir.r4.international401: MeasureReportStatus
MeasureReportStatus enum
Members
health.fhir.r4.international401: MeasureReportType
MeasureReportType enum
Members
health.fhir.r4.international401: MeasureStatus
MeasureStatus enum
Members
health.fhir.r4.international401: MediaStatus
MediaStatus enum
Members
health.fhir.r4.international401: MedicationAdministrationStatus
MedicationAdministrationStatus enum
Members
health.fhir.r4.international401: MedicationDispenseStatus
MedicationDispenseStatus enum
Members
health.fhir.r4.international401: MedicationKnowledgeStatus
MedicationKnowledgeStatus enum
Members
health.fhir.r4.international401: MedicationRequestIntent
MedicationRequestIntent enum
Members
health.fhir.r4.international401: MedicationRequestPriority
MedicationRequestPriority enum
Members
health.fhir.r4.international401: MedicationRequestStatus
MedicationRequestStatus enum
Members
health.fhir.r4.international401: MedicationStatementStatus
MedicationStatementStatus enum
Members
health.fhir.r4.international401: MedicationStatus
MedicationStatus enum
Members
health.fhir.r4.international401: MessageDefinitionCategory
MessageDefinitionCategory enum
Members
health.fhir.r4.international401: MessageDefinitionResponseRequired
MessageDefinitionResponseRequired enum
Members
health.fhir.r4.international401: MessageDefinitionStatus
MessageDefinitionStatus enum
Members
health.fhir.r4.international401: MessageHeaderResponseCode
MessageHeaderResponseCode enum
Members
health.fhir.r4.international401: MolecularSequenceQualityType
MolecularSequenceQualityType enum
Members
health.fhir.r4.international401: MolecularSequenceReferenceSeqOrientation
MolecularSequenceReferenceSeqOrientation enum
Members
health.fhir.r4.international401: MolecularSequenceReferenceSeqStrand
MolecularSequenceReferenceSeqStrand enum
Members
health.fhir.r4.international401: MolecularSequenceRepositoryType
MolecularSequenceRepositoryType enum
Members
health.fhir.r4.international401: MolecularSequenceType
MolecularSequenceType enum
Members
health.fhir.r4.international401: NamingSystemKind
NamingSystemKind enum
Members
health.fhir.r4.international401: NamingSystemStatus
NamingSystemStatus enum
Members
health.fhir.r4.international401: NamingSystemUniqueIdType
NamingSystemUniqueIdType enum
Members
health.fhir.r4.international401: NutritionOrderIntent
NutritionOrderIntent enum
Members
health.fhir.r4.international401: NutritionOrderStatus
NutritionOrderStatus enum
Members
health.fhir.r4.international401: ObservationDefinitionPermittedDataType
ObservationDefinitionPermittedDataType enum
Members
health.fhir.r4.international401: ObservationDefinitionQualifiedIntervalCategory
ObservationDefinitionQualifiedIntervalCategory enum
Members
health.fhir.r4.international401: ObservationDefinitionQualifiedIntervalGender
ObservationDefinitionQualifiedIntervalGender enum
Members
health.fhir.r4.international401: ObservationStatus
ObservationStatus enum
Members
health.fhir.r4.international401: OperationDefinitionKind
OperationDefinitionKind enum
Members
health.fhir.r4.international401: OperationDefinitionParameterBindingStrength
OperationDefinitionParameterBindingStrength enum
Members
health.fhir.r4.international401: OperationDefinitionParameterSearchType
OperationDefinitionParameterSearchType enum
Members
health.fhir.r4.international401: OperationDefinitionParameterUse
OperationDefinitionParameterUse enum
Members
health.fhir.r4.international401: OperationDefinitionStatus
OperationDefinitionStatus enum
Members
health.fhir.r4.international401: PatientContactGender
PatientContactGender enum
Members
health.fhir.r4.international401: PatientGender
PatientGender enum
Members
health.fhir.r4.international401: PatientLinkType
PatientLinkType enum
Members
health.fhir.r4.international401: PaymentNoticeStatus
PaymentNoticeStatus enum
Members
health.fhir.r4.international401: PaymentReconciliationOutcome
PaymentReconciliationOutcome enum
Members
health.fhir.r4.international401: PaymentReconciliationProcessNoteType
PaymentReconciliationProcessNoteType enum
Members
health.fhir.r4.international401: PaymentReconciliationStatus
PaymentReconciliationStatus enum
Members
health.fhir.r4.international401: PersonGender
PersonGender enum
Members
health.fhir.r4.international401: PersonLinkAssurance
PersonLinkAssurance enum
Members
health.fhir.r4.international401: PlanDefinitionActionCardinalityBehavior
PlanDefinitionActionCardinalityBehavior enum
Members
health.fhir.r4.international401: PlanDefinitionActionConditionKind
PlanDefinitionActionConditionKind enum
Members
health.fhir.r4.international401: PlanDefinitionActionGroupingBehavior
PlanDefinitionActionGroupingBehavior enum
Members
health.fhir.r4.international401: PlanDefinitionActionParticipantType
PlanDefinitionActionParticipantType enum
Members
health.fhir.r4.international401: PlanDefinitionActionPrecheckBehavior
PlanDefinitionActionPrecheckBehavior enum
Members
health.fhir.r4.international401: PlanDefinitionActionPriority
PlanDefinitionActionPriority enum
Members
health.fhir.r4.international401: PlanDefinitionActionRelatedActionRelationship
PlanDefinitionActionRelatedActionRelationship enum
Members
health.fhir.r4.international401: PlanDefinitionActionRequiredBehavior
PlanDefinitionActionRequiredBehavior enum
Members
health.fhir.r4.international401: PlanDefinitionActionSelectionBehavior
PlanDefinitionActionSelectionBehavior enum
Members
health.fhir.r4.international401: PlanDefinitionStatus
PlanDefinitionStatus enum
Members
health.fhir.r4.international401: PractitionerGender
PractitionerGender enum
Members
health.fhir.r4.international401: PractitionerRoleAvailableTimeDaysOfWeek
PractitionerRoleAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.international401: ProcedureStatus
ProcedureStatus enum
Members
health.fhir.r4.international401: ProvenanceEntityRole
ProvenanceEntityRole enum
Members
health.fhir.r4.international401: QuestionnaireItemEnableBehavior
QuestionnaireItemEnableBehavior enum
Members
health.fhir.r4.international401: QuestionnaireItemEnableWhenOperator
QuestionnaireItemEnableWhenOperator enum
Members
health.fhir.r4.international401: QuestionnaireItemType
QuestionnaireItemType enum
Members
health.fhir.r4.international401: QuestionnaireResponseStatus
QuestionnaireResponseStatus enum
Members
health.fhir.r4.international401: QuestionnaireStatus
QuestionnaireStatus enum
Members
health.fhir.r4.international401: RelatedPersonGender
RelatedPersonGender enum
Members
health.fhir.r4.international401: RequestGroupActionCardinalityBehavior
RequestGroupActionCardinalityBehavior enum
Members
health.fhir.r4.international401: RequestGroupActionConditionKind
RequestGroupActionConditionKind enum
Members
health.fhir.r4.international401: RequestGroupActionGroupingBehavior
RequestGroupActionGroupingBehavior enum
Members
health.fhir.r4.international401: RequestGroupActionPrecheckBehavior
RequestGroupActionPrecheckBehavior enum
Members
health.fhir.r4.international401: RequestGroupActionPriority
RequestGroupActionPriority enum
Members
health.fhir.r4.international401: RequestGroupActionRelatedActionRelationship
RequestGroupActionRelatedActionRelationship enum
Members
health.fhir.r4.international401: RequestGroupActionRequiredBehavior
RequestGroupActionRequiredBehavior enum
Members
health.fhir.r4.international401: RequestGroupActionSelectionBehavior
RequestGroupActionSelectionBehavior enum
Members
health.fhir.r4.international401: RequestGroupIntent
RequestGroupIntent enum
Members
health.fhir.r4.international401: RequestGroupPriority
RequestGroupPriority enum
Members
health.fhir.r4.international401: RequestGroupStatus
RequestGroupStatus enum
Members
health.fhir.r4.international401: ResearchDefinitionStatus
ResearchDefinitionStatus enum
Members
health.fhir.r4.international401: ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure
ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure enum
Members
health.fhir.r4.international401: ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure
ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure enum
Members
health.fhir.r4.international401: ResearchElementDefinitionStatus
ResearchElementDefinitionStatus enum
Members
health.fhir.r4.international401: ResearchElementDefinitionType
ResearchElementDefinitionType enum
Members
health.fhir.r4.international401: ResearchElementDefinitionVariableType
ResearchElementDefinitionVariableType enum
Members
health.fhir.r4.international401: ResearchStudyStatus
ResearchStudyStatus enum
Members
health.fhir.r4.international401: ResearchSubjectStatus
ResearchSubjectStatus enum
Members
health.fhir.r4.international401: RiskAssessmentStatus
RiskAssessmentStatus enum
Members
health.fhir.r4.international401: RiskEvidenceSynthesisStatus
RiskEvidenceSynthesisStatus enum
Members
health.fhir.r4.international401: SearchParameterComparator
SearchParameterComparator enum
Members
health.fhir.r4.international401: SearchParameterModifier
SearchParameterModifier enum
Members
health.fhir.r4.international401: SearchParameterStatus
SearchParameterStatus enum
Members
health.fhir.r4.international401: SearchParameterType
SearchParameterType enum
Members
health.fhir.r4.international401: SearchParameterXpathUsage
SearchParameterXpathUsage enum
Members
health.fhir.r4.international401: ServiceRequestIntent
ServiceRequestIntent enum
Members
health.fhir.r4.international401: ServiceRequestPriority
ServiceRequestPriority enum
Members
health.fhir.r4.international401: ServiceRequestStatus
ServiceRequestStatus enum
Members
health.fhir.r4.international401: SlotStatus
SlotStatus enum
Members
health.fhir.r4.international401: SpecimenDefinitionTypeTestedPreference
SpecimenDefinitionTypeTestedPreference enum
Members
health.fhir.r4.international401: SpecimenStatus
SpecimenStatus enum
Members
health.fhir.r4.international401: StructureDefinitionContextType
StructureDefinitionContextType enum
Members
health.fhir.r4.international401: StructureDefinitionDerivation
StructureDefinitionDerivation enum
Members
health.fhir.r4.international401: StructureDefinitionKind
StructureDefinitionKind enum
Members
health.fhir.r4.international401: StructureDefinitionStatus
StructureDefinitionStatus enum
Members
health.fhir.r4.international401: StructureMapGroupInputMode
StructureMapGroupInputMode enum
Members
health.fhir.r4.international401: StructureMapGroupRuleSourceListMode
StructureMapGroupRuleSourceListMode enum
Members
health.fhir.r4.international401: StructureMapGroupRuleTargetContextType
StructureMapGroupRuleTargetContextType enum
Members
health.fhir.r4.international401: StructureMapGroupRuleTargetListMode
StructureMapGroupRuleTargetListMode enum
Members
health.fhir.r4.international401: StructureMapGroupRuleTargetTransform
StructureMapGroupRuleTargetTransform enum
Members
health.fhir.r4.international401: StructureMapGroupTypeMode
StructureMapGroupTypeMode enum
Members
health.fhir.r4.international401: StructureMapStatus
StructureMapStatus enum
Members
health.fhir.r4.international401: StructureMapStructureMode
StructureMapStructureMode enum
Members
health.fhir.r4.international401: SubscriptionChannelType
SubscriptionChannelType enum
Members
health.fhir.r4.international401: SubscriptionStatus
SubscriptionStatus enum
Members
health.fhir.r4.international401: SubstanceStatus
SubstanceStatus enum
Members
health.fhir.r4.international401: SupplyDeliveryStatus
SupplyDeliveryStatus enum
Members
health.fhir.r4.international401: SupplyRequestPriority
SupplyRequestPriority enum
Members
health.fhir.r4.international401: SupplyRequestStatus
SupplyRequestStatus enum
Members
health.fhir.r4.international401: TaskIntent
TaskIntent enum
Members
health.fhir.r4.international401: TaskPriority
TaskPriority enum
Members
health.fhir.r4.international401: TaskStatus
TaskStatus enum
Members
health.fhir.r4.international401: TerminologyCapabilitiesCodeSearch
TerminologyCapabilitiesCodeSearch enum
Members
health.fhir.r4.international401: TerminologyCapabilitiesKind
TerminologyCapabilitiesKind enum
Members
health.fhir.r4.international401: TerminologyCapabilitiesStatus
TerminologyCapabilitiesStatus enum
Members
health.fhir.r4.international401: TestReportParticipantType
TestReportParticipantType enum
Members
health.fhir.r4.international401: TestReportResult
TestReportResult enum
Members
health.fhir.r4.international401: TestReportSetupActionAssertResult
TestReportSetupActionAssertResult enum
Members
health.fhir.r4.international401: TestReportSetupActionOperationResult
TestReportSetupActionOperationResult enum
Members
health.fhir.r4.international401: TestReportStatus
TestReportStatus enum
Members
health.fhir.r4.international401: TestScriptSetupActionAssertDirection
TestScriptSetupActionAssertDirection enum
Members
health.fhir.r4.international401: TestScriptSetupActionAssertOperator
TestScriptSetupActionAssertOperator enum
Members
health.fhir.r4.international401: TestScriptSetupActionAssertRequestMethod
TestScriptSetupActionAssertRequestMethod enum
Members
health.fhir.r4.international401: TestScriptSetupActionAssertResponse
TestScriptSetupActionAssertResponse enum
Members
health.fhir.r4.international401: TestScriptSetupActionOperationMethod
TestScriptSetupActionOperationMethod enum
Members
health.fhir.r4.international401: TestScriptStatus
TestScriptStatus enum
Members
health.fhir.r4.international401: VerificationResultStatus
VerificationResultStatus enum
Members
health.fhir.r4.international401: VisionPrescriptionLensSpecificationEye
VisionPrescriptionLensSpecificationEye enum
Members
health.fhir.r4.international401: VisionPrescriptionLensSpecificationPrismBase
VisionPrescriptionLensSpecificationPrismBase enum
Members
health.fhir.r4.international401: VisionPrescriptionStatus
VisionPrescriptionStatus enum
Members
Variables
health.fhir.r4.international401: terminologyProcessor
Terminology processor instance
health.fhir.r4.international401: fhirRegistry
FHIR registry instance
health.fhir.r4.international401: FHIR_VALUE_SETS
health.fhir.r4.international401: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.international401: Account
FHIR Account resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ACCOUNT(default RESOURCE_NAME_ACCOUNT) - The type of the resource describes
- coverage AccountCoverage[]? - The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
- owner Reference? - Indicates the service area, hospital, department, etc. with responsibility for managing the Account.
- identifier Identifier[]? - Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).
- partOf Reference? - Reference to a parent Account.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference[]? - Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.
- 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? - Provides additional information about what the account tracks and how it is used.
- guarantor AccountGuarantor[]? - The parties responsible for balancing the account if other payment options fall short.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept? - Categorizes the account for reporting and searching purposes.
- servicePeriod Period? - The date range of services associated with this account.
- 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 string? - Name used for the account when displaying it to humans in reports, 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.
- 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 AccountStatus - Indicates whether the account is presently used/usable or not.
- Element... - Rest field
health.fhir.r4.international401: AccountCoverage
FHIR AccountCoverage datatype record.
Fields
- Fields Included from *BackboneElement
- coverage Reference - The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- priority positiveInt? - The priority of the coverage in the context of this account.
health.fhir.r4.international401: AccountGuarantor
FHIR AccountGuarantor 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 timeframe during which the guarantor accepts responsibility for the account.
- onHold boolean? - A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- party Reference - The entity who is responsible.
health.fhir.r4.international401: ActivityDefinition
FHIR ActivityDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ACTIVITYDEFINITION(default RESOURCE_NAME_ACTIVITYDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
- copyright markdown? - A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
- 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).
- usage string? - A detailed description of how the activity definition is used from a clinical perspective.
- productReference Reference? - Identifies the food, drug or other product being consumed or supplied in the activity.
- experimental boolean? - A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- participant ActivityDefinitionParticipant[]? - Indicates who should participate in performing the action described.
- observationResultRequirement Reference[]? - Defines the observations that are expected to be produced by the action.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- timingAge Age? - The period, timing or frequency upon which the described activity is to occur.
- 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.
- doNotPerform boolean? - Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
- timingDuration Duration? - The period, timing or frequency upon which the described activity is to occur.
- identifier Identifier[]? - A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the activity definition content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- kind code? - A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
- profile canonical? - A profile to which the target of the activity definition is expected to conform.
- priority ActivityDefinitionPriority? - Indicates how quickly the activity should be addressed with respect to other requests.
- 'version string? - The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
- timingRange Range? - The period, timing or frequency upon which the described activity is to occur.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the activity definition giving additional information about its content.
- name string? - A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the activity definition.
- topic CodeableConcept[]? - Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.
- productCodeableConcept CodeableConcept? - Identifies the food, drug or other product being consumed or supplied in the activity.
- status ActivityDefinitionStatus - The status of this activity definition. Enables tracking the life-cycle of the content.
- dosage Dosage[]? - Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- code CodeableConcept? - Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
- subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the activity being defined.
- purpose markdown? - Explanation of why this activity definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the activity definition is intended to be used.
- description markdown? - A free text natural language description of the activity definition from a consumer's perspective.
- specimenRequirement Reference[]? - Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
- title string? - A short, descriptive, user-friendly title for the activity definition.
- transform canonical? - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
- dynamicValue ActivityDefinitionDynamicValue[]? - Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
- library canonical[]? - A reference to a Library resource containing any formal logic used by the activity definition.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- quantity SimpleQuantity? - Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
- timingTiming Timing? - The period, timing or frequency upon which the described activity is to occur.
- timingPeriod Period? - The period, timing or frequency upon which the described activity is to occur.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- intent ActivityDefinitionIntent? - Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
- subjectReference Reference? - A code or group definition that describes the intended subject of the activity being defined.
- observationRequirement Reference[]? - Defines observation requirements for the action to be performed, such as body weight or surface area.
- url uri? - An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
- bodySite CodeableConcept[]? - Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
- 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.
- location Reference? - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
- timingDateTime dateTime? - The period, timing or frequency upon which the described activity is to occur.
- Element... - Rest field
health.fhir.r4.international401: ActivityDefinitionDynamicValue
FHIR ActivityDefinitionDynamicValue datatype record.
Fields
- Fields Included from *BackboneElement
- path string - The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- expression Expression - An expression specifying the value of the customized element.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ActivityDefinitionParticipant
FHIR ActivityDefinitionParticipant 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.
- role CodeableConcept? - The role the participant should play in performing the described action.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ActivityDefinitionParticipantType - The type of participant in the action.
health.fhir.r4.international401: AdverseEvent
FHIR AdverseEvent resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ADVERSEEVENT(default RESOURCE_NAME_ADVERSEEVENT) - The type of the resource describes
- date dateTime? - The date (and perhaps time) when the adverse event occurred.
- 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.
- study Reference[]? - AdverseEvent.study.
- subjectMedicalHistory Reference[]? - AdverseEvent.subjectMedicalHistory.
- subject Reference - This subject or group impacted by the event.
- 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.
- contributor Reference[]? - Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
- 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 CodeableConcept? - This element defines the specific type of event that occurred or that was prevented from occurring.
- outcome CodeableConcept? - Describes the type of outcome from the adverse event.
- severity CodeableConcept? - Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
- identifier Identifier? - Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - Information on who recorded the adverse event. May be the patient or a practitioner.
- actuality AdverseEventActuality - Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
- recordedDate dateTime? - The date on which the existence of the AdverseEvent was first recorded.
- referenceDocument Reference[]? - AdverseEvent.referenceDocument.
- encounter Reference? - The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
- suspectEntity AdverseEventSuspectEntity[]? - Describes the entity that is suspected to have caused the adverse 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.
- resultingCondition Reference[]? - Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
- 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.
- seriousness CodeableConcept? - Assessment whether this event was of real importance.
- detected dateTime? - Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
- 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 information about where the adverse event occurred.
- category CodeableConcept[]? - The overall type of event, intended for search and filtering purposes.
- Element... - Rest field
health.fhir.r4.international401: AdverseEventSuspectEntity
FHIR AdverseEventSuspectEntity 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 Reference - Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- causality AdverseEventSuspectEntityCausality[]? - Information on the possible cause of the event.
health.fhir.r4.international401: AdverseEventSuspectEntityCausality
FHIR AdverseEventSuspectEntityCausality datatype record.
Fields
- Fields Included from *BackboneElement
- assessment CodeableConcept? - Assessment of if the entity caused the event.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- productRelatedness string? - AdverseEvent.suspectEntity.causalityProductRelatedness.
- method CodeableConcept? - ProbabilityScale | Bayesian | Checklist.
- author Reference? - AdverseEvent.suspectEntity.causalityAuthor.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: AllergyIntolerance
FHIR AllergyIntolerance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ALLERGYINTOLERANCE(default RESOURCE_NAME_ALLERGYINTOLERANCE) - The type of the resource describes
- note Annotation[]? - Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
- onsetRange Range? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- criticality AllergyIntoleranceCriticality? - Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
- language code? - The base language in which the resource is written.
- clinicalStatus CodeableConcept? - The clinical status of the allergy or intolerance.
- onsetDateTime dateTime? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- 'type AllergyIntoleranceType? - Identification of the underlying physiological mechanism for the reaction risk.
- onsetString string? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- onsetAge Age? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- lastOccurrence dateTime? - Represents the date and/or time of the last known occurrence of a reaction event.
- patient Reference - The patient who has the allergy or intolerance.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- identifier Identifier[]? - Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - Individual who recorded the record and takes responsibility for its content.
- onsetPeriod Period? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- reaction AllergyIntoleranceReaction[]? - Details about each adverse reaction event linked to exposure to the identified substance.
- verificationStatus CodeableConcept? - Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
- recordedDate dateTime? - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
- encounter Reference? - The encounter when the allergy or intolerance was asserted.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- asserter Reference? - The source of the information about the allergy that is recorded.
- 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 AllergyIntoleranceCategory[]? - Category of the identified substance.
- Element... - Rest field
health.fhir.r4.international401: AllergyIntoleranceReaction
FHIR AllergyIntoleranceReaction datatype record.
Fields
- Fields Included from *BackboneElement
- severity AllergyIntoleranceReactionSeverity? - Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
- note Annotation[]? - Additional text about the adverse reaction event not captured in other fields.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- manifestation CodeableConcept[] - Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- substance CodeableConcept? - Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
- description string? - Text description about the reaction as a whole, including details of the manifestation if required.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- onset dateTime? - Record of the date and/or time of the onset of the Reaction.
- exposureRoute CodeableConcept? - Identification of the route by which the subject was exposed to the substance.
health.fhir.r4.international401: Appointment
FHIR Appointment resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_APPOINTMENT(default RESOURCE_NAME_APPOINTMENT) - The type of the resource describes
- serviceType CodeableConcept[]? - The specific service that is to be performed during this appointment.
- 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.
- specialty CodeableConcept[]? - The specialty of a practitioner that would be required to perform the service requested in this appointment.
- 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 brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
- reasonReference Reference[]? - Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
- language code? - The base language in which the resource is written.
- requestedPeriod Period[]? - A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
- minutesDuration positiveInt? - Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
- slot Reference[]? - The slots from the participants' schedules that will be filled by the appointment.
- participant AppointmentParticipant[] - List of participants involved in the appointment.
- serviceCategory CodeableConcept[]? - A broad categorization of the service that is to be performed during this appointment.
- end instant? - Date/Time that the appointment is to conclude.
- 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 that this appointment is being scheduled. This is more clinical than administrative.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- basedOn Reference[]? - The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
- appointmentType CodeableConcept? - The style of appointment or patient that has been booked in the slot (not service type).
- identifier Identifier[]? - This records identifiers associated with this appointment concern 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 (e.g. in CDA documents, or in written / printed documentation).
- created dateTime? - The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
- 'start instant? - Date/Time that the appointment is to take place.
- supportingInformation Reference[]? - Additional information to support the appointment provided when making the appointment.
- priority unsignedInt? - The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
- 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.
- comment string? - Additional comments about the appointment.
- cancelationReason CodeableConcept? - The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
- patientInstruction string? - While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
- status AppointmentStatus - The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
- Element... - Rest field
health.fhir.r4.international401: AppointmentParticipant
FHIR AppointmentParticipant datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference? - A Person, Location/HealthcareService or Device that is participating in the appointment.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - Participation period of the actor.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept[]? - Role of participant in the appointment.
- required AppointmentParticipantRequired? - Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
- status AppointmentParticipantStatus - Participation status of the actor.
health.fhir.r4.international401: AppointmentResponse
FHIR AppointmentResponse resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_APPOINTMENTRESPONSE(default RESOURCE_NAME_APPOINTMENTRESPONSE) - The type of the resource describes
- identifier Identifier[]? - This records identifiers associated with this appointment response concern 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.
- 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).
- participantType CodeableConcept[]? - Role of participant in the appointment.
- 'start instant? - Date/Time that the appointment is to take place, or requested new start time.
- appointment Reference - Appointment that this response is replying to.
- language code? - The base language in which the resource is written.
- actor Reference? - A Person, Location, HealthcareService, or Device that is participating in the appointment.
- 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.
- comment string? - Additional comments about the appointment.
- end instant? - This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
- participantStatus AppointmentResponseParticipantStatus - Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
- 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.international401: AuditEvent
FHIR AuditEvent resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUDITEVENT(default RESOURCE_NAME_AUDITEVENT) - The type of the resource describes
- agent AuditEventAgent[] - An actor taking an active role in the event or activity that is logged.
- 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 activity occurred.
- 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.
- 'source AuditEventSource - The system that is reporting the event.
- recorded instant - The time when the event was recorded.
- 'type Coding - Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
- 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.
- subtype Coding[]? - Identifier for the category of event.
- 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.
- outcomeDesc string? - A free text description of the outcome of the event.
- action code? - Indicator for type of action performed during the event that generated the audit.
- 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.
- purposeOfEvent CodeableConcept[]? - The purposeOfUse (reason) that was used during the event being recorded.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- entity AuditEventEntity[]? - Specific instances of data or objects that have been accessed.
- outcome code? - Indicates whether the event succeeded or failed.
- Element... - Rest field
health.fhir.r4.international401: AuditEventAgent
FHIR AuditEventAgent 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.
- role CodeableConcept[]? - The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
- purposeOfUse CodeableConcept[]? - The reason (purpose of use), specific to this agent, that was used during the event being recorded.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- media Coding? - Type of media involved. Used when the event is about exporting/importing onto media.
- 'type CodeableConcept? - Specification of the participation type the user plays when performing the event.
- altId string? - Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
- requestor boolean - Indicator that the user is or is not the requestor, or initiator, for the event being audited.
- network AuditEventAgentNetwork? - Logical network location for application activity, if the activity has a network location.
- name string? - Human-meaningful name for the agent.
- location Reference? - Where the event occurred.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- policy uri[]? - The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
- who Reference? - Reference to who this agent is that was involved in the event.
health.fhir.r4.international401: AuditEventAgentNetwork
FHIR AuditEventAgentNetwork 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 string? - An identifier for the network access point of the user device for the audit event.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 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 code? - An identifier for the type of network access point that originated the audit event.
health.fhir.r4.international401: AuditEventEntity
FHIR AuditEventEntity datatype record.
Fields
- Fields Included from *BackboneElement
- lifecycle Coding? - Identifier for the data life-cycle stage for the entity.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role Coding? - Code representing the role the entity played in the event being audited.
- what Reference? - Identifies a specific instance of the entity. The reference should be version specific.
- securityLabel Coding[]? - Security labels for the identified entity.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- query base64Binary? - The query parameters for a query-type entities.
- name string? - A name of the entity in the audit event.
- description string? - Text that describes the entity in more detail.
- detail AuditEventEntityDetail[]? - Tagged value pairs for conveying additional information about the entity.
- 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 Coding? - The type of the object that was involved in this audit event.
health.fhir.r4.international401: AuditEventEntityDetail
FHIR AuditEventEntityDetail datatype record.
Fields
- Fields Included from *BackboneElement
- valueAuditEventBase64Binary base64Binary - The value of the extra detail.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueAuditEventString string - The value of the extra detail.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 string - The type of extra detail provided in the value.
health.fhir.r4.international401: AuditEventSource
FHIR AuditEventSource datatype record.
Fields
- Fields Included from *BackboneElement
- observer Reference - Identifier of the source where the event was detected.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- site string? - Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 Coding[]? - Code specifying the type of source where event originated.
health.fhir.r4.international401: Basic
FHIR Basic resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BASIC(default RESOURCE_NAME_BASIC) - The type of the resource describes
- identifier Identifier[]? - Identifier assigned to the resource for business purposes, outside the context of FHIR.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - Identifies the 'type' of resource - equivalent to the resource name for other resources.
- author Reference? - Indicates who was responsible for creating the resource instance.
- created date? - Identifies when the resource was first created.
- subject Reference? - Identifies the patient, practitioner, device or any other resource that is the 'focus' of this resource.
- 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.
- 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.
- Element... - Rest field
health.fhir.r4.international401: Binary
FHIR Binary resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BINARY(default RESOURCE_NAME_BINARY) - The type of the resource describes
- data base64Binary? - The actual content, base64 encoded.
- 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.
- language code? - The base language in which the resource is written.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- securityContext Reference? - This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.
- contentType code - MimeType of the binary content represented as a standard MimeType (BCP 13).
- Element... - Rest field
health.fhir.r4.international401: BiologicallyDerivedProduct
FHIR BiologicallyDerivedProduct resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT(default RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT) - The type of the resource describes
- identifier Identifier[]? - This records identifiers associated with this biologically derived product instance 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 (e.g. in CDA documents, or in written / printed documentation).
- parent Reference[]? - Parent product (if any).
- request Reference[]? - Procedure request to obtain this biologically derived product.
- 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.
- quantity integer? - Number of discrete units within this 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).
- language code? - The base language in which the resource is written.
- collection BiologicallyDerivedProductCollection? - How this product was collected.
- storage BiologicallyDerivedProductStorage[]? - Product storage.
- productCategory BiologicallyDerivedProductProductCategory? - Broad category of this 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.
- productCode CodeableConcept? - A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
- 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.
- processing BiologicallyDerivedProductProcessing[]? - Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
- 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.
- manipulation BiologicallyDerivedProductManipulation? - Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
- status BiologicallyDerivedProductStatus? - Whether the product is currently available.
- Element... - Rest field
health.fhir.r4.international401: BiologicallyDerivedProductCollection
FHIR BiologicallyDerivedProductCollection 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.
- collectedPeriod Period? - Time of product collection.
- collectedDateTime dateTime? - Time of product collection.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- 'source Reference? - The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.
- collector Reference? - Healthcare professional who is performing the collection.
health.fhir.r4.international401: BiologicallyDerivedProductManipulation
FHIR BiologicallyDerivedProductManipulation 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? - Time of manipulation.
- description string? - Description of manipulation.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- timeDateTime dateTime? - Time of manipulation.
health.fhir.r4.international401: BiologicallyDerivedProductProcessing
FHIR BiologicallyDerivedProductProcessing 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? - Time of processing.
- description string? - Description of of processing.
- 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? - Procesing code.
- timeDateTime dateTime? - Time of processing.
- additive Reference? - Substance added during processing.
health.fhir.r4.international401: BiologicallyDerivedProductStorage
FHIR BiologicallyDerivedProductStorage datatype record.
Fields
- Fields Included from *BackboneElement
- duration Period? - Storage timeperiod.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- temperature decimal? - Storage temperature.
- description string? - Description of storage.
- scale BiologicallyDerivedProductStorageScale? - Temperature scale 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.
health.fhir.r4.international401: BodyStructure
FHIR BodyStructure resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BODYSTRUCTURE(default RESOURCE_NAME_BODYSTRUCTURE) - The type of the resource describes
- identifier Identifier[]? - Identifier for this instance of the anatomical structure.
- image Attachment[]? - Image or images used to identify a 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.
- morphology CodeableConcept? - The kind of structure being represented by the body structure at
BodyStructure.location
. This can define both normal and abnormal morphologies.
- locationQualifier CodeableConcept[]? - Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
- 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 body site is in active use.
- description string? - A summary, characterization or explanation of the body structure.
- language code? - The base language in which the resource is written.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The person to which the body site belongs.
- 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 CodeableConcept? - The anatomical location or region of the specimen, lesion, or body structure.
- 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.international401: CapabilityStatement
FHIR CapabilityStatement resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CAPABILITYSTATEMENT(default RESOURCE_NAME_CAPABILITYSTATEMENT) - The type of the resource describes
- date dateTime - The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
- instantiates canonical[]? - Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
- copyright markdown? - A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability 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.
- software CapabilityStatementSoftware? - Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
- purpose markdown? - Explanation of why this capability statement is needed and why it has been designed as it has.
- document CapabilityStatementDocument[]? - A document definition.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the capability statement is intended to be used.
- 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 markdown? - A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
- experimental boolean? - A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the capability statement.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- fhirVersion code - The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
- patchFormat code[]? - A list of the patch formats supported by this implementation using their content types.
- 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.
- rest CapabilityStatementRest[]? - A definition of the restful capabilities of the solution, if any.
- imports canonical[]? - Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
- kind CapabilityStatementKind - The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
- implementation CapabilityStatementImplementation? - Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
- format CapabilityStatementFormat[] - A list of the formats supported by this implementation using their content types.
- 'version string? - The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
- messaging CapabilityStatementMessaging[]? - A description of the messaging capabilities of the solution.
- implementationGuide canonical[]? - A list of implementation guides that the server does (or should) support in their entirety.
- 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 string? - A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the capability statement.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.
- status CapabilityStatementStatus - The status of this capability statement. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: CapabilityStatementDocument
FHIR CapabilityStatementDocument datatype record.
Fields
- Fields Included from *BackboneElement
- mode CapabilityStatementDocumentMode - Mode of this document declaration - whether an application is a producer or consumer.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- documentation markdown? - A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, 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).
- profile canonical - A profile on the document Bundle that constrains which resources are present, and their contents.
- 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.international401: CapabilityStatementImplementation
FHIR CapabilityStatementImplementation 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.
- custodian Reference? - The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Information about the specific installation that this capability statement relates to.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- url urlType? - An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
health.fhir.r4.international401: CapabilityStatementMessaging
FHIR CapabilityStatementMessaging datatype record.
Fields
- Fields Included from *BackboneElement
- endpoint CapabilityStatementMessagingEndpoint[]? - An endpoint (network accessible address) to which messages and/or replies are to be sent.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- documentation markdown? - Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- reliableCache unsignedInt? - Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
- supportedMessage CapabilityStatementMessagingSupportedMessage[]? - References to message definitions for messages this system can send or receive.
health.fhir.r4.international401: CapabilityStatementMessagingEndpoint
FHIR CapabilityStatementMessagingEndpoint 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.
- protocol Coding - A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
- address urlType - The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: CapabilityStatementMessagingSupportedMessage
FHIR CapabilityStatementMessagingSupportedMessage datatype record.
Fields
- Fields Included from *BackboneElement
- mode CapabilityStatementMessagingSupportedMessageMode - The mode of this event declaration - whether application is sender or receiver.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- definition canonical - Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: CapabilityStatementRest
FHIR CapabilityStatementRest datatype record.
Fields
- Fields Included from *BackboneElement
- mode CapabilityStatementRestMode - Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- security CapabilityStatementRestSecurity? - Information about security implementation from an interface perspective - what a client needs to know.
- 'resource CapabilityStatementRestResource[]? - A specification of the restful capabilities of the solution for a specific resource type.
- documentation markdown? - Information about the system's restful capabilities that apply across all applications, such as security.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- compartment canonical[]? - An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
- interaction CapabilityStatementRestInteraction[]? - A specification of restful operations supported by the system.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: CapabilityStatementRestInteraction
FHIR CapabilityStatementRestInteraction 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 CapabilityStatementRestInteractionCode - A coded identifier of the operation, supported by the system.
- documentation markdown? - Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: CapabilityStatementRestResource
FHIR CapabilityStatementRestResource datatype record.
Fields
- Fields Included from *BackboneElement
- updateCreate boolean? - A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
- searchInclude string[]? - A list of _include values supported by the server.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- conditionalCreate boolean? - A flag that indicates that the server supports conditional create.
- versioning CapabilityStatementRestResourceVersioning? - This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
- searchParam CapabilityStatementRestResourceSearchParam[]? - Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
- searchRevInclude string[]? - A list of _revinclude (reverse include) values supported by the server.
- documentation markdown? - Additional information about the resource type used by the system.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- profile canonical? - A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in Using Profiles.
- referencePolicy CapabilityStatementRestResourceReferencePolicy[]? - A set of flags that defines how references are supported.
- 'type code - A type of resource exposed via the restful interface.
- supportedProfile canonical[]? - A list of profiles that represent different use cases supported by the system. For a server, 'supported by the system' means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles.
- conditionalDelete CapabilityStatementRestResourceConditionalDelete? - A code that indicates how the server supports conditional delete.
- conditionalUpdate boolean? - A flag that indicates that the server supports conditional update.
- readHistory boolean? - A flag for whether the server is able to return past versions as part of the vRead operation.
- conditionalRead CapabilityStatementRestResourceConditionalRead? - A code that indicates how the server supports conditional read.
- interaction CapabilityStatementRestResourceInteraction[]? - Identifies a restful operation supported by the solution.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- operation CapabilityStatementRestResourceOperation[]? - Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.
health.fhir.r4.international401: CapabilityStatementRestResourceInteraction
FHIR CapabilityStatementRestResourceInteraction 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 CapabilityStatementRestResourceInteractionCode - Coded identifier of the operation, supported by the system resource.
- documentation markdown? - Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: CapabilityStatementRestResourceOperation
FHIR CapabilityStatementRestResourceOperation 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.
- documentation markdown? - Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
- definition canonical - Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as
http://hl7.org/fhir/OperationDefinition/ValueSet-expand
), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom OperationDefinition with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.
- 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.international401: CapabilityStatementRestResourceSearchParam
FHIR CapabilityStatementRestResourceSearchParam 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.
- documentation markdown? - This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 search parameter used in the interface.
- definition canonical? - An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to SearchParameter.url). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
- 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 CapabilityStatementRestResourceSearchParamType - The type of value a search parameter refers to, and how the content is interpreted.
health.fhir.r4.international401: CapabilityStatementRestSecurity
FHIR CapabilityStatementRestSecurity 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.
- cors boolean? - Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.
- 'service CodeableConcept[]? - Types of security services that are supported/required by the system.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 markdown? - General description of how security works.
- 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.international401: CapabilityStatementSoftware
FHIR CapabilityStatementSoftware 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.
- releaseDate dateTime? - Date this version of the software was released.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Name the software is known by.
- 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 identifier for the software covered by this statement.
health.fhir.r4.international401: CarePlan
FHIR CarePlan resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CAREPLAN(default RESOURCE_NAME_CAREPLAN) - The type of the resource describes
- note Annotation[]? - General notes about the care plan not covered elsewhere.
- partOf Reference[]? - A larger care plan of which this particular care plan is a component or step.
- addresses Reference[]? - Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- activity CarePlanActivity[]? - Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
- subject Reference - Identifies the patient or group whose intended care is described by the plan.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - A description of the scope and nature of the plan.
- language code? - The base language in which the resource is written.
- title string? - Human-friendly name for the care plan.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
- contributor Reference[]? - Identifies the individual(s) or organization who provided the contents of the care plan.
- supportingInfo Reference[]? - Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- basedOn Reference[]? - A care plan that is fulfilled in whole or in part by this care plan.
- careTeam Reference[]? - Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
- identifier Identifier[]? - Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- period Period? - Indicates when the plan did (or is intended to) come into effect and end.
- goal Reference[]? - Describes the intended objective(s) of carrying out the care plan.
- author Reference? - When populated, the author is responsible for the care plan. The care plan is attributed to the author.
- created dateTime? - Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
- replaces Reference[]? - Completed or terminated care plan whose function is taken by this new care plan.
- encounter Reference? - The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
- intent CarePlanIntent - Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- 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[]? - Identifies what 'kind' of plan this is to support differentiation between multiple co-existing plans; e.g. 'Home health', 'psychiatric', 'asthma', 'disease management', 'wellness plan', etc.
- status CarePlanStatus - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
- Element... - Rest field
health.fhir.r4.international401: CarePlanActivity
FHIR CarePlanActivity datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference? - The details of the proposed activity represented in a specific resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- outcomeCodeableConcept CodeableConcept[]? - Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).
- outcomeReference Reference[]? - Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- progress Annotation[]? - Notes about the adherence/status/progress of the activity.
- detail CarePlanActivityDetail? - A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: CarePlanActivityDetail
FHIR CarePlanActivityDetail 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? - Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.
- goal Reference[]? - Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
- performer Reference[]? - Identifies who's expected to be involved in the activity.
- quantity Quantity? - Identifies the quantity expected to be supplied, administered or consumed by the subject.
- kind CarePlanActivityDetailKind? - A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
- productCarePlanCodeableConcept CodeableConcept? - Identifies the food, drug or other product to be consumed or supplied in the activity.
- reasonReference Reference[]? - Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.
- scheduledCarePlanPeriod Period? - The period, timing or frequency upon which the described activity is to occur.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
- scheduledCarePlanString string? - The period, timing or frequency upon which the described activity is to occur.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
- productCarePlanReference Reference? - Identifies the food, drug or other product to be consumed or supplied in the activity.
- statusReason CodeableConcept? - Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
- dailyAmount Quantity? - Identifies the quantity expected to be consumed in a given day.
- location Reference? - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- reasonCode CodeableConcept[]? - Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
- doNotPerform boolean? - If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
- scheduledCarePlanTiming Timing? - The period, timing or frequency upon which the described activity is to occur.
- status CarePlanActivityDetailStatus - Identifies what progress is being made for the specific activity.
health.fhir.r4.international401: CareTeam
FHIR CareTeam resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CARETEAM(default RESOURCE_NAME_CARETEAM) - The type of the resource describes
- identifier Identifier[]? - Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- note Annotation[]? - Comments made about the CareTeam.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - Indicates when the team did (or is intended to) come into effect and end.
- subject Reference? - Identifies the patient or group whose intended care is handled by the team.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Condition(s) that this care team addresses.
- language code? - The base language in which the resource is written.
- encounter Reference? - The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
- participant CareTeamParticipant[]? - Identifies all people and organizations who are expected to be involved in the care team.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- managingOrganization Reference[]? - The organization responsible for the care team.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- name string? - A label for human use intended to distinguish like teams. E.g. the 'red' vs. 'green' trauma teams.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A central contact detail for the care team (that applies to all members).
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - Describes why the care team exists.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- category CodeableConcept[]? - Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
- status CareTeamStatus? - Indicates the current state of the care team.
- Element... - Rest field
health.fhir.r4.international401: CareTeamParticipant
FHIR CareTeamParticipant 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? - Indicates when the specific member or organization did (or is intended to) come into effect and end.
- role CodeableConcept[]? - Indicates specific responsibility of an individual within the care team, such as 'Primary care physician', 'Trained social worker counselor', 'Caregiver', etc.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- member Reference? - The specific person or organization who is participating/expected to participate in the care team.
- onBehalfOf Reference? - The organization of the practitioner.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: CatalogEntry
FHIR CatalogEntry resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CATALOGENTRY(default RESOURCE_NAME_CATALOGENTRY) - The type of the resource describes
- additionalClassification CodeableConcept[]? - User for example for ATC classification, or.
- identifier Identifier[]? - Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
- 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.
- relatedEntry CatalogEntryRelatedEntry[]? - Used for example, to point to a substance, or to a device used to administer a medication.
- orderable boolean - Whether the entry represents an orderable item.
- 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.
- additionalIdentifier Identifier[]? - Used in supporting related concepts, e.g. NDC to RxNorm.
- classification CodeableConcept[]? - Classes of devices, or ATC for medication.
- 'type CodeableConcept? - The type of item - medication, device, service, protocol or other.
- validityPeriod Period? - The time period in which this catalog entry is expected to be active.
- lastUpdated dateTime? - Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
- 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.
- additionalCharacteristic CodeableConcept[]? - Used for examplefor Out of Formulary, or any specifics.
- 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.
- referencedItem Reference - The item in a catalog or definition.
- status CatalogEntryStatus? - Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
- validTo dateTime? - The date until which this catalog entry is expected to be active.
- Element... - Rest field
health.fhir.r4.international401: CatalogEntryRelatedEntry
FHIR CatalogEntryRelatedEntry 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.
- item Reference - The reference to the related item.
- relationtype CatalogEntryRelatedEntryRelationtype - The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, 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.international401: ChargeItem
FHIR ChargeItem resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CHARGEITEM(default RESOURCE_NAME_CHARGEITEM) - The type of the resource describes
- note Annotation[]? - Comments made about the event by the performer, subject or other participants.
- partOf Reference[]? - ChargeItems can be grouped to larger ChargeItems covering the whole set.
- reason CodeableConcept[]? - Describes why the event occurred in coded or textual form.
- definitionCanonical canonical[]? - References the source of pricing information, rules of application for the code this ChargeItem uses.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A code that identifies the charge, like a billing code.
- subject Reference - The individual or set of individuals the action is being or was performed on.
- 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).
- overrideReason string? - If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
- productReference Reference? - Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
- language code? - The base language in which the resource is written.
- definitionUri uri[]? - References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
- performingOrganization Reference? - The organization requesting the service.
- context Reference? - The encounter or episode of care that establishes the context for this event.
- enterer Reference? - The device, practitioner, etc. who entered the charge item.
- 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.
- factorOverride decimal? - Factor overriding the factor determined by the rules associated with the code.
- identifier Identifier[]? - Identifiers assigned to this event performer or other systems.
- bodysite CodeableConcept[]? - The anatomical location where the related service has been applied.
- performer ChargeItemPerformer[]? - Indicates who or what performed or participated in the charged service.
- quantity Quantity? - Quantity of which the charge item has been serviced.
- costCenter Reference? - The financial cost center permits the tracking of charge attribution.
- enteredDate dateTime? - Date the charge item was entered.
- priceOverride Money? - Total price of the charge overriding the list price associated with the code.
- supportingInformation Reference[]? - Further information supporting this charge.
- occurrenceTiming Timing? - Date/time(s) or duration when the charged service was applied.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - Date/time(s) or duration when the charged service was applied.
- 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.
- 'service Reference[]? - Indicated the rendered service that caused this charge.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - Date/time(s) or duration when the charged service was applied.
- requestingOrganization Reference? - The organization performing the service.
- account Reference[]? - Account into which this ChargeItems belongs.
- productCodeableConcept CodeableConcept? - Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
- status ChargeItemStatus - The current state of the ChargeItem.
- Element... - Rest field
health.fhir.r4.international401: ChargeItemDefinition
FHIR ChargeItemDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CHARGEITEMDEFINITION(default RESOURCE_NAME_CHARGEITEMDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
- propertyGroup ChargeItemDefinitionPropertyGroup[]? - Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
- partOf canonical[]? - A larger definition of which this particular definition is a component or step.
- copyright markdown? - A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- code CodeableConcept? - The defined billing details in this resource pertain to the given billing code.
- instance Reference[]? - The defined billing details in this resource pertain to the given product instance(s).
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the charge item definition is intended to be used.
- 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 markdown? - A free text natural language description of the charge item definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the charge item definition.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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.
- derivedFromUri uri[]? - The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
- identifier Identifier[]? - A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- effectivePeriod Period? - The period during which the charge item definition content was or is planned to be in active use.
- replaces canonical[]? - As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
- 'version string? - The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
- url uri - An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- publisher string? - The name of the organization or individual that published the charge item definition.
- applicability ChargeItemDefinitionApplicability[]? - Expressions that describe applicability criteria for the billing code.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.
- status ChargeItemDefinitionStatus - The current state of the ChargeItemDefinition.
- Element... - Rest field
health.fhir.r4.international401: ChargeItemDefinitionApplicability
FHIR ChargeItemDefinitionApplicability 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.
- expression string? - An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 brief, natural language description of the condition that effectively communicates the intended semantics.
- language string? - The media type of the language for the expression, e.g. 'text/cql' for Clinical Query Language expressions or 'text/fhirpath' for FHIRPath expressions.
- 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.international401: ChargeItemDefinitionPropertyGroup
FHIR ChargeItemDefinitionPropertyGroup 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.
- priceComponent ChargeItemDefinitionPropertyGroupPriceComponent[]? - The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.
health.fhir.r4.international401: ChargeItemDefinitionPropertyGroupPriceComponent
FHIR ChargeItemDefinitionPropertyGroupPriceComponent datatype record.
Fields
- Fields Included from *BackboneElement
- amount Money? - The amount calculated for this component.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts 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.
- factor decimal? - The factor that has been applied on the base price for calculating this component.
- 'type ChargeItemDefinitionPropertyGroupPriceComponentType - This code identifies the type of the component.
health.fhir.r4.international401: ChargeItemPerformer
FHIR ChargeItemPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - The device, practitioner, etc. who performed or participated in the 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.
- 'function CodeableConcept? - Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, 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.international401: Claim
FHIR Claim resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CLAIM(default RESOURCE_NAME_CLAIM) - The type of the resource describes
- insurance ClaimInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.
- 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.
- use ClaimUse - A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
- 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.
- 'type CodeableConcept - The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
- accident ClaimAccident? - Details of an accident which resulted in injuries which required the products and services listed in the claim.
- payee ClaimPayee? - The party to be reimbursed for cost of the products and services according to the terms of the policy.
- total Money? - The total value of the all the items in the claim.
- related ClaimRelated[]? - Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
- supportingInfo ClaimSupportingInfo[]? - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
- fundsReserve CodeableConcept? - A code to indicate whether and for whom funds are to be reserved for future claims.
- provider Reference - The provider which is responsible for the claim, predetermination or preauthorization.
- insurer Reference? - The Insurer who is target of the request.
- patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.
- enterer Reference? - Individual who created the claim, predetermination or preauthorization.
- 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.
- careTeam ClaimCareTeam[]? - The members of the team who provided the products and services.
- identifier Identifier[]? - A unique identifier assigned to this claim.
- item ClaimItem[]? - A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.
- created dateTime - The date this resource was created.
- diagnosis ClaimDiagnosis[]? - Information about diagnoses relevant to the claim items.
- originalPrescription Reference? - Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
- procedure ClaimProcedure[]? - Procedures performed on the patient relevant to the billing items with the claim.
- priority CodeableConcept - The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
- 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.
- referral Reference? - A reference to a referral resource.
- prescription Reference? - Prescription to support the dispensing of pharmacy, device or vision products.
- 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.
- billablePeriod Period? - The period for which charges are being submitted.
- 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.
- subType CodeableConcept? - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
- facility Reference? - Facility where the services were provided.
- status ClaimStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: ClaimAccident
FHIR ClaimAccident datatype record.
Fields
- Fields Included from *BackboneElement
- date date - Date of an accident event related to the products and services contained in the claim.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- locationAddress Address? - The physical location of the accident event.
- locationReference Reference? - The physical location of the accident event.
- 'type CodeableConcept? - The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.
health.fhir.r4.international401: ClaimCareTeam
FHIR ClaimCareTeam datatype record.
Fields
- Fields Included from *BackboneElement
- qualification CodeableConcept? - The qualification of the practitioner which is applicable for this service.
- sequence positiveInt - A number to uniquely identify care team entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role CodeableConcept? - The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.
- provider Reference - Member of the team who provided the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- responsible boolean? - The party who is billing and/or responsible for the claimed products or services.
- 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.international401: ClaimDiagnosis
FHIR ClaimDiagnosis datatype record.
Fields
- Fields Included from *BackboneElement
- sequence positiveInt - A number to uniquely identify diagnosis entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- onAdmission CodeableConcept? - Indication of whether the diagnosis was present on admission to a facility.
- packageCode CodeableConcept? - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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[]? - When the condition was observed or the relative ranking.
- diagnosisReference Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.
- diagnosisCodeableConcept CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.
health.fhir.r4.international401: ClaimInsurance
FHIR ClaimInsurance datatype record.
Fields
- Fields Included from *BackboneElement
- coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
- identifier Identifier? - The business identifier to be used when the claim is sent for adjudication against this insurance policy.
- sequence positiveInt - A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- businessArrangement string? - A business agreement number established between the provider and the insurer for special business processing purposes.
- claimResponse Reference? - The result of the adjudication of the line items for the Coverage specified in this insurance.
- focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- preAuthRef string[]? - Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.
- 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.international401: ClaimItem
FHIR ClaimItem 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.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- locationAddress Address? - Where the product or service was provided.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.
- informationSequence positiveInt[]? - Exceptions, special conditions and supporting information applicable for this service or product.
- revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.
- locationCodeableConcept CodeableConcept? - Where the product or service was provided.
- diagnosisSequence positiveInt[]? - Diagnosis applicable for this service or product.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- locationReference Reference? - Where the product or service was provided.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- quantity Quantity? - The number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- careTeamSequence positiveInt[]? - CareTeam members related to this service or product.
- encounter Reference[]? - The Encounters during which this Claim was created or to which the creation of this record is tightly associated.
- sequence positiveInt - A number to uniquely identify item entries.
- bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).
- subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).
- detail ClaimItemDetail[]? - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
- servicedDate date? - The date or dates when the service or product was supplied, performed or completed.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- procedureSequence positiveInt[]? - Procedures applicable for this service or product.
health.fhir.r4.international401: ClaimItemDetail
FHIR ClaimItemDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- subDetail ClaimItemDetailSubDetail[]? - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- sequence positiveInt - A number to uniquely identify item entries.
- revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
health.fhir.r4.international401: ClaimItemDetailSubDetail
FHIR ClaimItemDetailSubDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- sequence positiveInt - A number to uniquely identify item entries.
- revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
health.fhir.r4.international401: ClaimPayee
FHIR ClaimPayee 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.
- 'type CodeableConcept - Type of Party to be reimbursed: subscriber, provider, other.
- party Reference? - Reference to the individual or organization to whom any payment will be made.
health.fhir.r4.international401: ClaimProcedure
FHIR ClaimProcedure datatype record.
Fields
- Fields Included from *BackboneElement
- date dateTime? - Date and optionally time the procedure was performed.
- sequence positiveInt - A number to uniquely identify procedure entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- procedureCodeableConcept CodeableConcept - The code or reference to a Procedure resource which identifies the clinical intervention performed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- procedureReference Reference - The code or reference to a Procedure resource which identifies the clinical intervention performed.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- 'type CodeableConcept[]? - When the condition was observed or the relative ranking.
health.fhir.r4.international401: ClaimRelated
FHIR ClaimRelated datatype record.
Fields
- Fields Included from *BackboneElement
- reference Identifier? - An alternate organizational reference to the case or file to which this particular claim pertains.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- claim Reference? - Reference to a related claim.
- 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 code to convey how the claims are related.
health.fhir.r4.international401: ClaimResponse
FHIR ClaimResponse resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CLAIMRESPONSE(default RESOURCE_NAME_CLAIMRESPONSE) - The type of the resource describes
- insurance ClaimResponseInsurance[]? - Financial instruments for reimbursement for the health care products and services specified on the claim.
- request Reference? - Original request resource reference.
- 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.
- use ClaimResponseUse - A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
- 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).
- payeeType CodeableConcept? - Type of Party to be reimbursed: subscriber, provider, other.
- preAuthRef string? - Reference from the Insurer which is used in later communications which refers to this adjudication.
- language code? - The base language in which the resource is written.
- 'error ClaimResponseError[]? - Errors encountered during the processing of the adjudication.
- 'type CodeableConcept - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
- processNote ClaimResponseProcessNote[]? - A note that describes or explains adjudication results in a human readable form.
- addItem ClaimResponseAddItem[]? - The first-tier service adjudications for payor added product or service lines.
- total ClaimResponseTotal[]? - Categorized monetary totals for the adjudication.
- fundsReserve CodeableConcept? - A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
- insurer Reference - The party responsible for authorization, adjudication and reimbursement.
- patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.
- communicationRequest Reference[]? - Request for additional supporting or authorizing information.
- payment ClaimResponsePayment? - Payment details for the adjudication of the claim.
- 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.
- outcome ClaimResponseOutcome - The outcome of the claim, predetermination, or preauthorization processing.
- identifier Identifier[]? - A unique identifier assigned to this claim response.
- item ClaimResponseItem[]? - A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
- preAuthPeriod Period? - The time frame during which this authorization is effective.
- formCode CodeableConcept? - A code for the form to be used for printing the content.
- created dateTime - The date this resource was created.
- requestor Reference? - The provider which is responsible for the claim, predetermination or preauthorization.
- 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.
- disposition string? - A human readable description of the status of the adjudication.
- form Attachment? - The actual form, by reference or inclusion, for printing the content or an EOB.
- 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.
- subType CodeableConcept? - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
- status ClaimResponseStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: ClaimResponseAddItem
FHIR ClaimResponseAddItem datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- subdetailSequence positiveInt[]? - The sequence number of the sub-details within the details within the claim item which this line is intended to replace.
- locationAddress Address? - Where the product or service was provided.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
- servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.
- itemSequence positiveInt[]? - Claim items which this service line is intended to replace.
- bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).
- locationCodeableConcept CodeableConcept? - Where the product or service was provided.
- provider Reference[]? - The providers who are authorized for the services rendered to the patient.
- detailSequence positiveInt[]? - The sequence number of the details within the claim item which this line is intended to replace.
- subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).
- detail ClaimResponseAddItemDetail[]? - The second-tier service adjudications for payor added services.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- locationReference Reference? - Where the product or service was provided.
- servicedDate date? - The date or dates when the service or product was supplied, performed or completed.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
health.fhir.r4.international401: ClaimResponseAddItemDetail
FHIR ClaimResponseAddItemDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- subDetail ClaimResponseAddItemDetailSubDetail[]? - The third-tier service adjudications for payor added services.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ClaimResponseAddItemDetailSubDetail
FHIR ClaimResponseAddItemDetailSubDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ClaimResponseError
FHIR ClaimResponseError datatype record.
Fields
- Fields Included from *BackboneElement
- subDetailSequence positiveInt? - The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
- itemSequence positiveInt? - The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - An error code, from a specified code system, which details why the claim could not be adjudicated.
- detailSequence positiveInt? - The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ClaimResponseInsurance
FHIR ClaimResponseInsurance datatype record.
Fields
- Fields Included from *BackboneElement
- coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
- sequence positiveInt - A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- businessArrangement string? - A business agreement number established between the provider and the insurer for special business processing purposes.
- claimResponse Reference? - The result of the adjudication of the line items for the Coverage specified in this insurance.
- focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ClaimResponseItem
FHIR ClaimResponseItem datatype record.
Fields
- Fields Included from *BackboneElement
- adjudication ClaimResponseItemAdjudication[] - If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
- itemSequence positiveInt - A number to uniquely reference the claim item entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- detail ClaimResponseItemDetail[]? - A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ClaimResponseItemAdjudication
FHIR ClaimResponseItemAdjudication datatype record.
Fields
- Fields Included from *BackboneElement
- reason CodeableConcept? - A code supporting the understanding of the adjudication result and explaining variance from expected amount.
- amount Money? - Monetary amount associated with the category.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.
- value decimal? - A non-monetary value associated with the category. Mutually exclusive to the amount element above.
health.fhir.r4.international401: ClaimResponseItemDetail
FHIR ClaimResponseItemDetail 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.
- detailSequence positiveInt - A number to uniquely reference the claim detail entry.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- subDetail ClaimResponseItemDetailSubDetail[]? - A sub-detail adjudication of a simple product or service.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ClaimResponseItemDetailSubDetail
FHIR ClaimResponseItemDetailSubDetail datatype record.
Fields
- Fields Included from *BackboneElement
- subDetailSequence positiveInt - A number to uniquely reference the claim sub-detail entry.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ClaimResponsePayment
FHIR ClaimResponsePayment datatype record.
Fields
- Fields Included from *BackboneElement
- date date? - Estimated date the payment will be issued or the actual issue date of payment.
- identifier Identifier? - Issuer's unique identifier for the payment instrument.
- adjustmentReason CodeableConcept? - Reason for the payment adjustment.
- amount Money - Benefits payable less any payment adjustment.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- adjustment Money? - Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.
- 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 - Whether this represents partial or complete payment of the benefits payable.
health.fhir.r4.international401: ClaimResponseProcessNote
FHIR ClaimResponseProcessNote datatype record.
Fields
- Fields Included from *BackboneElement
- number positiveInt? - A number to uniquely identify a note entry.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - A code to define the language used in the text of the note.
- 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 - The explanation or description associated with the processing.
- 'type ClaimResponseProcessNoteType? - The business purpose of the note text.
health.fhir.r4.international401: ClaimResponseTotal
FHIR ClaimResponseTotal datatype record.
Fields
- Fields Included from *BackboneElement
- amount Money - Monetary total amount associated with the category.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
health.fhir.r4.international401: ClaimSupportingInfo
FHIR ClaimSupportingInfo datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean boolean? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- reason CodeableConcept? - Provides the reason in the situation where a reason code is required in addition to the 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.
- code CodeableConcept? - System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
- valueReference Reference? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- timingPeriod Period? - The date when or period to which this information refers.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- timingDate date? - The date when or period to which this information refers.
- sequence positiveInt - A number to uniquely identify supporting information entries.
- valueAttachment Attachment? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- valueString string? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category CodeableConcept - The general class of the information supplied: information; exception; accident, employment; onset, etc.
- valueQuantity Quantity? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
health.fhir.r4.international401: ClinicalImpression
FHIR ClinicalImpression resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CLINICALIMPRESSION(default RESOURCE_NAME_CLINICALIMPRESSION) - The type of the resource describes
- date dateTime? - Indicates when the documentation of the assessment was complete.
- note Annotation[]? - Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - Categorizes the type of clinical assessment performed.
- assessor Reference? - The clinician performing the assessment.
- subject Reference - The patient or group of individuals assessed as part of this record.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
- prognosisReference Reference[]? - RiskAssessment expressing likely outcome.
- language code? - The base language in which the resource is written.
- protocol uri[]? - Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
- problem Reference[]? - A list of the relevant problems/conditions for a patient.
- statusReason CodeableConcept? - Captures the reason for the current state of the ClinicalImpression.
- supportingInfo Reference[]? - Information supporting the clinical impression.
- 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.
- summary string? - A text summary of the investigations and the diagnosis.
- identifier Identifier[]? - Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- effectivePeriod Period? - The point in time or period over which the subject was assessed.
- previous Reference? - A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
- encounter Reference? - The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
- finding ClinicalImpressionFinding[]? - Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
- prognosisCodeableConcept CodeableConcept[]? - Estimate of likely outcome.
- 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 point in time or period over which the subject was assessed.
- 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.
- investigation ClinicalImpressionInvestigation[]? - One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
- status ClinicalImpressionStatus - Identifies the workflow status of the assessment.
- Element... - Rest field
health.fhir.r4.international401: ClinicalImpressionFinding
FHIR ClinicalImpressionFinding datatype record.
Fields
- Fields Included from *BackboneElement
- itemReference Reference? - Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- itemCodeableConcept CodeableConcept? - Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- basis string? - Which investigations support finding or diagnosis.
health.fhir.r4.international401: ClinicalImpressionInvestigation
FHIR ClinicalImpressionInvestigation 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.
- item Reference[]? - A record of a specific investigation that was undertaken.
- code CodeableConcept - A name/code for the group ('set') of investigations. Typically, this will be something like 'signs', 'symptoms', 'clinical', 'diagnostic', but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: Communication
FHIR Communication resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COMMUNICATION(default RESOURCE_NAME_COMMUNICATION) - The type of the resource describes
- note Annotation[]? - Additional notes or commentary about the communication by the sender, receiver or other interested parties.
- partOf Reference[]? - Part of this action.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference? - The patient or group that was the focus of this communication.
- 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).
- about Reference[]? - Other resources that pertain to this communication and to which this communication should be associated.
- reasonReference Reference[]? - Indicates another resource whose existence justifies this communication.
- language code? - The base language in which the resource is written.
- medium CodeableConcept[]? - A channel that was used for this communication (e.g. email, fax).
- 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 Communication.
- statusReason CodeableConcept? - Captures the reason for the current state of the Communication.
- payload CommunicationPayload[]? - Text, attachment(s), or resource(s) that was communicated to the recipient.
- inResponseTo Reference[]? - Prior communication that this communication is in response to.
- 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 justification for the communication.
- 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[]? - An order, proposal or plan fulfilled in whole or in part by this Communication.
- identifier Identifier[]? - Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- received dateTime? - The time when this communication arrived at the destination.
- encounter Reference? - The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
- priority CommunicationPriority? - Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
- sent dateTime? - The time when this communication was sent.
- 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.
- sender Reference? - The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
- 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.
- recipient Reference[]? - The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
- 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.
- topic CodeableConcept? - Description of the purpose/content, similar to a subject line in an email.
- category CodeableConcept[]? - The type of message conveyed such as alert, notification, reminder, instruction, etc.
- status CommunicationStatus - The status of the transmission.
- Element... - Rest field
health.fhir.r4.international401: CommunicationPayload
FHIR CommunicationPayload 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.
- contentReference Reference - A communicated content (or for multi-part communications, one portion of the communication).
- contentString string - A communicated content (or for multi-part communications, one portion of the communication).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- contentAttachment Attachment - A communicated content (or for multi-part communications, one portion of the communication).
- 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.international401: CommunicationRequest
FHIR CommunicationRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COMMUNICATIONREQUEST(default RESOURCE_NAME_COMMUNICATIONREQUEST) - The type of the resource describes
- note Annotation[]? - Comments made about the request by the requester, sender, recipient, subject or other participants.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference? - The patient or group that is the focus of this communication request.
- 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).
- about Reference[]? - Other resources that pertain to this communication request and to which this communication request should be associated.
- reasonReference Reference[]? - Indicates another resource whose existence justifies this request.
- language code? - The base language in which the resource is written.
- medium CodeableConcept[]? - A channel that was used for this communication (e.g. email, fax).
- statusReason CodeableConcept? - Captures the reason for the current state of the CommunicationRequest.
- payload CommunicationRequestPayload[]? - Text, attachment(s), or resource(s) to be communicated to the recipient.
- 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 request is being made 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.
- doNotPerform boolean? - If true indicates that the CommunicationRequest is asking for the specified action to not occur.
- basedOn Reference[]? - A plan or proposal that is fulfilled in whole or in part by this request.
- requester Reference? - The device, individual, or organization who initiated the request and has responsibility for its activation.
- identifier Identifier[]? - Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- authoredOn dateTime? - For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
- replaces Reference[]? - Completed or terminated request(s) whose function is taken by this new request.
- encounter Reference? - The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
- priority CommunicationRequestPriority? - Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - The time when this communication is to occur.
- sender Reference? - The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
- 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.
- recipient Reference[]? - The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - The time when this communication is to occur.
- category CodeableConcept[]? - The type of message to be sent such as alert, notification, reminder, instruction, etc.
- 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, prescription or similar form.
- status CommunicationRequestStatus - The status of the proposal or order.
- Element... - Rest field
health.fhir.r4.international401: CommunicationRequestPayload
FHIR CommunicationRequestPayload 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.
- contentReference Reference - The communicated content (or for multi-part communications, one portion of the communication).
- contentString string - The communicated content (or for multi-part communications, one portion of the communication).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- contentAttachment Attachment - The communicated content (or for multi-part communications, one portion of the communication).
- 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.international401: CompartmentDefinition
FHIR CompartmentDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COMPARTMENTDEFINITION(default RESOURCE_NAME_COMPARTMENTDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
- 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 CompartmentDefinitionCode - Which compartment this definition describes.
- purpose markdown? - Explanation of why this compartment definition is needed and why it has been designed as it has.
- 'resource CompartmentDefinitionResource[]? - Information about how a resource is related to the compartment.
- 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 markdown? - A free text natural language description of the compartment definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- 'version string? - The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri - An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.
- 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.
- search boolean - Whether the search syntax is supported,.
- 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 ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- name string - A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the compartment definition.
- 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.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.
- status CompartmentDefinitionStatus - The status of this compartment definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: CompartmentDefinitionResource
FHIR CompartmentDefinitionResource 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 code - The name of a resource supported by the server.
- param string[]? - The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.
- documentation string? - Additional documentation about the resource and compartment.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: Composition
FHIR Composition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COMPOSITION(default RESOURCE_NAME_COMPOSITION) - 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[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- custodian Reference? - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
- author Reference[] - Identifies who is responsible for the information in the composition, not necessarily who typed it in.
- subject Reference? - Who or what the composition is about. The 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).
- 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 CompositionSection[]? - The root of the sections that make up the composition.
- encounter Reference? - Describes the clinical encounter or type of care this documentation is associated with.
- title string - Official human-readable label for the composition.
- 'type CodeableConcept - Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
- attester CompositionAttester[]? - 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.
- 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.
- event CompositionEvent[]? - The clinical service, such as a colonoscopy or an appendectomy, being documented.
- relatesTo CompositionRelatesTo[]? - Relationships that this composition has with other compositions or documents that already exist.
- status CompositionStatus - 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.international401: CompositionAttester
FHIR CompositionAttester datatype record.
Fields
- Fields Included from *BackboneElement
- mode CompositionAttesterMode - 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.international401: CompositionEvent
FHIR CompositionEvent 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.international401: CompositionRelatesTo
FHIR CompositionRelatesTo 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 CompositionRelatesToCode - 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.international401: CompositionSection
FHIR CompositionSection datatype record.
Fields
- Fields Included from *BackboneElement
- mode CompositionSectionMode? - 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 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.international401: ConceptMap
FHIR ConceptMap resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CONCEPTMAP(default RESOURCE_NAME_CONCEPTMAP) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.
- copyright markdown? - A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
- 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.
- purpose markdown? - Explanation of why this concept map is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the concept map is intended to be used.
- 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 markdown? - A free text natural language description of the concept map from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the concept map.
- sourceUri uri? - Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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.
- group ConceptMapGroup[]? - A group of mappings that all have the same source and target system.
- identifier Identifier? - A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
- sourceCanonical canonical? - Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
- 'version string? - The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.
- 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 string? - A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- targetUri uri? - The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
- targetCanonical canonical? - The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
- 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.
- publisher string? - The name of the organization or individual that published the concept map.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.
- status ConceptMapStatus - The status of this concept map. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: ConceptMapGroup
FHIR ConceptMapGroup 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.
- sourceVersion string? - The specific version of the code system, as determined by the code system authority.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- 'source uri? - An absolute URI that identifies the source system where the concepts to be mapped are defined.
- unmapped ConceptMapGroupUnmapped? - What to do when there is no mapping for the source concept. 'Unmapped' does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.
- element ConceptMapGroupElement[] - Mappings for an individual concept in the source to one or more concepts in the target.
- target uri? - An absolute URI that identifies the target system that the concepts will be mapped to.
- targetVersion string? - The specific version of the code system, as determined by the code system authority.
health.fhir.r4.international401: ConceptMapGroupElement
FHIR ConceptMapGroupElement 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 code? - Identity (code or path) or the element/item being mapped.
- display string? - The display for the code. The display is only provided to help editors when editing the concept map.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- target ConceptMapGroupElementTarget[]? - A concept from the target value set that this concept maps to.
health.fhir.r4.international401: ConceptMapGroupElementTarget
FHIR ConceptMapGroupElementTarget datatype record.
Fields
- Fields Included from *BackboneElement
- equivalence ConceptMapGroupElementTargetEquivalence - The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code? - Identity (code or path) or the element/item that the map refers to.
- dependsOn ConceptMapGroupElementTargetDependsOn[]? - A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.
- display string? - The display for the code. The display is only provided to help editors when editing the concept map.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- comment string? - A description of status/issues in mapping that conveys additional information not represented in the structured data.
- 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.international401: ConceptMapGroupElementTargetDependsOn
FHIR ConceptMapGroupElementTargetDependsOn 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.
- system canonical? - An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
- display string? - The display for the code. The display is only provided to help editors when editing the concept map.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- property uri - A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value string - Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.
health.fhir.r4.international401: ConceptMapGroupUnmapped
FHIR ConceptMapGroupUnmapped datatype record.
Fields
- Fields Included from *BackboneElement
- mode ConceptMapGroupUnmappedMode - Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code? - The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.
- display string? - The display for the code. The display is only provided to help editors when editing the concept map.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- url canonical? - The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.
health.fhir.r4.international401: Condition
FHIR Condition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CONDITION(default RESOURCE_NAME_CONDITION) - 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 CodeableConcept? - Identification of the condition, problem or diagnosis.
- evidence ConditionEvidence[]? - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
- onsetRange Range? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- abatementDateTime dateTime? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- subject Reference - Indicates the patient or group who the condition record is associated with.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- clinicalStatus CodeableConcept? - The clinical status of the condition.
- onsetDateTime dateTime? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- onsetString string? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- onsetAge Age? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- abatementPeriod Period? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- abatementString string? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- severity CodeableConcept? - A subjective assessment of the severity of the condition as evaluated by the clinician.
- identifier Identifier[]? - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - Individual who recorded the record and takes responsibility for its content.
- onsetPeriod Period? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- verificationStatus CodeableConcept? - The verification status to support the clinical status of the condition.
- recordedDate dateTime? - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
- abatementRange Range? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- encounter Reference? - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
- bodySite CodeableConcept[]? - The anatomical location where this condition manifests itself.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- asserter Reference? - Individual who is making the condition statement.
- stage ConditionStage[]? - Clinical stage or grade of a condition. May include formal severity assessments.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[]? - A category assigned to the condition.
- 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.international401: ConditionEvidence
FHIR ConditionEvidence 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.international401: ConditionStage
FHIR ConditionStage 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.international401: Consent
FHIR Consent resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CONSENT(default RESOURCE_NAME_CONSENT) - The type of the resource describes
- dateTime dateTime? - When this Consent was issued / created / indexed.
- sourceReference Reference? - The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
- identifier Identifier[]? - Unique identifier for this copy of the Consent 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.
- performer Reference[]? - Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
- 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).
- sourceAttachment Attachment? - The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
- language code? - The base language in which the resource is written.
- 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.
- policyRule CodeableConcept? - A reference to the specific base computable regulation or policy.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference? - The patient/healthcare consumer to whom this consent applies.
- provision ConsentProvision? - An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
- organization Reference[]? - The organization that manages the consent, and the framework within which it is executed.
- scope CodeableConcept - A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- category CodeableConcept[] - A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
- verification ConsentVerification[]? - Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
- policy ConsentPolicy[]? - The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
- status ConsentStatus - Indicates the current state of this consent.
- Element... - Rest field
health.fhir.r4.international401: ConsentPolicy
FHIR ConsentPolicy 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.
- authority uri? - Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- uri uri? - The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
health.fhir.r4.international401: ConsentProvision
FHIR ConsentProvision datatype record.
Fields
- Fields Included from *BackboneElement
- dataPeriod Period? - Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 timeframe in this rule is valid.
- code CodeableConcept[]? - If this code is found in an instance, then the rule applies.
- data ConsentProvisionData[]? - The resources controlled by this rule if specific resources are referenced.
- purpose Coding[]? - The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
- securityLabel Coding[]? - A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'type ConsentProvisionType? - Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
- actor ConsentProvisionActor[]? - Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
- action CodeableConcept[]? - Actions controlled by this Rule.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'class Coding[]? - The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
health.fhir.r4.international401: ConsentProvisionActor
FHIR ConsentProvisionActor datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference - The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role CodeableConcept - How the individual is involved in the resources content that is described in the exception.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ConsentProvisionData
FHIR ConsentProvisionData datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference - A reference to a specific resource that defines which resources are covered by this consent.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- meaning ConsentProvisionDataMeaning - How the resource reference is interpreted when testing consent restrictions.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ConsentVerification
FHIR ConsentVerification 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.
- verifiedWith Reference? - Who verified the instruction (Patient, Relative or other Authorized Person).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- verified boolean - Has the instruction been verified.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- verificationDate dateTime? - Date verification was collected.
health.fhir.r4.international401: Contract
FHIR Contract resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CONTRACT(default RESOURCE_NAME_CONTRACT) - 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.
- friendly ContractFriendly[]? - The 'patient friendly language' versionof the Contract in whole or in parts. 'Patient friendly language' means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
- subject Reference[]? - The target entity impacted by or of interest to parties to the agreement.
- 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).
- rule ContractRule[]? - List of Computable Policy Rule Language Representations of this Contract.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
- 'type CodeableConcept? - A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.
- instantiatesUri uri? - The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
- relevantHistory Reference[]? - Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
- supportingInfo Reference[]? - Information that may be needed by/relevant to the performer in their execution of this term action.
- topicReference Reference? - Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
- contentDefinition ContractContentDefinition? - Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.
- scope CodeableConcept? - A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
- legal ContractLegal[]? - List of Legal expressions or representations of this Contract.
- alias string[]? - Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.
- term ContractTerm[]? - One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
- 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 dateTime? - When this Contract was issued.
- contentDerivative CodeableConcept? - The minimal content derived from the basal information source at a specific stage in its lifecycle.
- signer ContractSigner[]? - Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
- identifier Identifier[]? - Unique identifier for this Contract or a derivative that references a Source Contract.
- expirationType CodeableConcept? - Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
- legallyBindingAttachment Attachment? - Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the 'source of truth' and which would be the basis for legal action related to enforcement of this Contract.
- author Reference? - The individual or organization that authored the Contract definition, derivative, or instance in any legal state.
- topicCodeableConcept CodeableConcept? - Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
- instantiatesCanonical Reference? - The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.
- 'version string? - An edition identifier used for business purposes to label business significant variants.
- url uri? - Canonical identifier for this contract, represented as a URI (globally unique).
- 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 Reference[]? - Sites in which the contract is complied with, exercised, or in force.
- applies Period? - Relevant time or time-period when this Contract is applicable.
- 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.
- authority Reference[]? - A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
- domain Reference[]? - Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
- subtitle string? - An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
- name string? - A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- subType CodeableConcept[]? - Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.
- legalState CodeableConcept? - Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.
- legallyBindingReference Reference? - Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the 'source of truth' and which would be the basis for legal action related to enforcement of this Contract.
- status ContractStatus? - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: ContractContentDefinition
FHIR ContractContentDefinition datatype record.
Fields
- Fields Included from *BackboneElement
- publicationStatus ContractContentDefinitionPublicationStatus - amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated.
- copyright markdown? - A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor 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).
- publisher Reference? - The individual or organization that published the Contract precursor content.
- subType CodeableConcept? - Detailed Precusory content 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.
- 'type CodeableConcept - Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.
- publicationDate dateTime? - The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.
health.fhir.r4.international401: ContractFriendly
FHIR ContractFriendly 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.
- contentReference Reference - Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- contentAttachment Attachment - Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
- 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.international401: ContractLegal
FHIR ContractLegal 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.
- contentReference Reference - Contract legal text in human renderable form.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- contentAttachment Attachment - Contract legal text in human renderable form.
- 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.international401: ContractRule
FHIR ContractRule 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.
- contentReference Reference - Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- contentAttachment Attachment - Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
- 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.international401: ContractSigner
FHIR ContractSigner 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.
- signature Signature[] - Legally binding Contract DSIG signature contents in Base64.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 Coding - Role of this Contract signer, e.g. notary, grantee.
- party Reference - Party which is a signator to this Contract.
health.fhir.r4.international401: ContractTerm
FHIR ContractTerm datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier? - Unique identifier for this particular Contract Provision.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- securityLabel ContractTermSecurityLabel[]? - Security labels that protect the handling of information about the term and its elements, which may be specifically identified..
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- topicCodeableConcept CodeableConcept? - The entity that the term applies to.
- 'type CodeableConcept? - A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.
- offer ContractTermOffer - The matter of concern in the context of this provision of the agrement.
- applies Period? - Relevant time or time-period when this Contract Provision is applicable.
- topicReference Reference? - The entity that the term applies to.
- action ContractTermAction[]? - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- subType CodeableConcept? - A specialized legal clause or condition based on overarching contract 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.
- text string? - Statement of a provision in a policy or a contract.
- asset ContractTermAsset[]? - Contract Term Asset List.
- issued dateTime? - When this Contract Provision was issued.
health.fhir.r4.international401: ContractTermAction
FHIR ContractTermAction datatype record.
Fields
- Fields Included from *BackboneElement
- note Annotation[]? - Comments made about the term action made by the requester, performer, subject or other participants.
- reason string[]? - Describes why the action is to be performed or not performed in textual form.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ContractTermActionSubject[]? - Entity of the action.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 permitting or not permitting this action.
- occurrenceContractDateTime dateTime? - When action happens.
- performerLinkId string[]? - Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
- 'type CodeableConcept - Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.
- contextLinkId string[]? - Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
- context Reference? - Encounter or Episode with primary association to specified term activity.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- reasonCode CodeableConcept[]? - Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.
- doNotPerform boolean? - True if the term prohibits the action.
- requester Reference[]? - Who or what initiated the action and has responsibility for its activation.
- performer Reference? - Indicates who or what is being asked to perform (or not perform) the ction.
- performerRole CodeableConcept? - The type of role or competency of an individual desired or required to perform or not perform the action.
- securityLabelNumber unsignedInt[]? - Security labels that protects the action.
- intent CodeableConcept - Reason or purpose for the action stipulated by this Contract Provision.
- performerType CodeableConcept[]? - The type of individual that is desired or required to perform or not perform the action.
- requesterLinkId string[]? - Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
- occurrenceContractPeriod Period? - When action happens.
- linkId string[]? - Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.
- occurrenceContractTiming Timing? - When action happens.
- reasonLinkId string[]? - Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
- status CodeableConcept - Current state of the term action.
health.fhir.r4.international401: ContractTermActionSubject
FHIR ContractTermActionSubject datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference[] - The entity the action is performed or not performed on or for.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role CodeableConcept? - Role type of agent assigned roles in this Contract.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ContractTermAsset
FHIR ContractTermAsset 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[]? - Asset relevant contractual time period.
- usePeriod Period[]? - Time period of asset use.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- securityLabelNumber unsignedInt[]? - Security labels that protects the asset.
- 'type CodeableConcept[]? - Target entity type about which the term may be concerned.
- condition string? - Description of the quality and completeness of the asset that imay be a factor in its valuation.
- linkId string[]? - Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
- periodType CodeableConcept[]? - Type of Asset availability for use or ownership.
- subtype CodeableConcept[]? - May be a subtype or part of an offered asset.
- scope CodeableConcept? - Differentiates the kind of the asset .
- context ContractTermAssetContext[]? - Circumstance of the asset.
- typeReference Reference[]? - Associated entities.
- 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? - Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.
- valuedItem ContractTermAssetValuedItem[]? - Contract Valued Item List.
- relationship Coding? - Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree.
health.fhir.r4.international401: ContractTermAssetContext
FHIR ContractTermAssetContext datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference? - Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept[]? - Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 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? - Context description.
health.fhir.r4.international401: ContractTermAssetValuedItem
FHIR ContractTermAssetValuedItem datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - A Contract Valued Item unit valuation measure.
- identifier Identifier? - Identifies a Contract Valued Item instance.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.
- entityContractCodeableConcept CodeableConcept? - Specific type of Contract Valued Item that may be priced.
- effectiveTime dateTime? - Indicates the time during which this Contract ValuedItem information is effective.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- securityLabelNumber unsignedInt[]? - A set of security labels that define which terms are controlled by this condition.
- points decimal? - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.
- linkId string[]? - Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.
- responsible Reference? - Who will make payment.
- recipient Reference? - Who will receive payment.
- payment string? - Terms of valuation.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
- paymentDate dateTime? - When payment is due.
- entityContractReference Reference? - Specific type of Contract Valued Item that may be priced.
health.fhir.r4.international401: ContractTermOffer
FHIR ContractTermOffer datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier[]? - Unique identifier for this particular Contract Provision.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- decision CodeableConcept? - Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- securityLabelNumber unsignedInt[]? - Security labels that protects the offer.
- 'type CodeableConcept? - Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
- linkId string[]? - The id of the clause or question text of the offer in the referenced questionnaire/response.
- answer ContractTermOfferAnswer[]? - Response to offer text.
- decisionMode CodeableConcept[]? - How the decision about a Contract was conveyed.
- topic Reference? - The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).
- 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? - Human readable form of this Contract Offer.
- party ContractTermOfferParty[]? - Offer Recipient.
health.fhir.r4.international401: ContractTermOfferAnswer
FHIR ContractTermOfferAnswer 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.
- valueContractCoding Coding - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractInteger integer - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractBoolean boolean - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueContractUri uri - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractDate date - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractAttachment Attachment - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractTime time - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueContractDecimal decimal - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractDateTime dateTime - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractString string - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractQuantity Quantity - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
- valueContractReference Reference - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
health.fhir.r4.international401: ContractTermOfferParty
FHIR ContractTermOfferParty datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference[] - Participant in the offer.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role CodeableConcept - How the party participates in the offer.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ContractTermSecurityLabel
FHIR ContractTermSecurityLabel datatype record.
Fields
- Fields Included from *BackboneElement
- number unsignedInt[]? - Number used to link this term or term element to the applicable Security Label.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- control Coding[]? - Security label privacy tag that species the manner in which term and/or term elements are to be protected.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category Coding[]? - Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.
- classification Coding - Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements.
health.fhir.r4.international401: Coverage
FHIR Coverage resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COVERAGE(default RESOURCE_NAME_COVERAGE) - 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.
- subrogation boolean? - When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
- 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.
- 'type CodeableConcept? - The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
- network string? - The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
- payor Reference[] - The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
- 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.
- relationship CodeableConcept? - The relationship of beneficiary (patient) to the subscriber.
- 'class CoverageClass[]? - A suite of underwriter specific classifiers.
- dependent string? - A unique identifier for a dependent under the coverage.
- 'order positiveInt? - The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
- identifier Identifier[]? - A unique identifier assigned to this coverage.
- costToBeneficiary CoverageCostToBeneficiary[]? - A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
- period Period? - Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
- subscriber Reference? - The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
- contract Reference[]? - The policy(s) which constitute this insurance coverage.
- subscriberId string? - The insurer assigned ID for the Subscriber.
- 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.
- beneficiary Reference - The party who benefits from the insurance coverage; the patient when products and/or services are provided.
- 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.
- policyHolder Reference? - The party who 'owns' the insurance policy.
- status CoverageStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: CoverageClass
FHIR CoverageClass 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? - A short description for the class.
- 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 classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.
- value string - The alphanumeric string value associated with the insurer issued label.
health.fhir.r4.international401: CoverageCostToBeneficiary
FHIR CoverageCostToBeneficiary datatype record.
Fields
- Fields Included from *BackboneElement
- exception CoverageCostToBeneficiaryException[]? - A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueMoney Money - The amount due from the patient for the cost category.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 category of patient centric costs associated with treatment.
- valueQuantity Quantity - The amount due from the patient for the cost category.
health.fhir.r4.international401: CoverageCostToBeneficiaryException
FHIR CoverageCostToBeneficiaryException 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 timeframe during when the exception is in force.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 code for the specific exception.
health.fhir.r4.international401: CoverageEligibilityRequest
FHIR CoverageEligibilityRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST(default RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST) - The type of the resource describes
- insurance CoverageEligibilityRequestInsurance[]? - Financial instruments for reimbursement for the health care products and services.
- identifier Identifier[]? - A unique identifier assigned to this coverage eligiblity request.
- 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.
- item CoverageEligibilityRequestItem[]? - Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.
- purpose CoverageEligibilityRequestPurpose[] - Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
- created dateTime - The date when this resource was created.
- 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.
- priority CodeableConcept? - When the requestor expects the processor to complete processing.
- servicedPeriod Period? - The date or dates when the enclosed suite of services were performed or completed.
- 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.
- supportingInfo CoverageEligibilityRequestSupportingInfo[]? - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
- provider Reference? - The provider which is responsible for the request.
- insurer Reference - The Insurer who issued the coverage in question and is the recipient of the request.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
- enterer Reference? - Person who created the request.
- 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.
- servicedDate date? - The date or dates when the enclosed suite of services were performed or completed.
- 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.
- facility Reference? - Facility where the services are intended to be provided.
- status CoverageEligibilityRequestStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: CoverageEligibilityRequestInsurance
FHIR CoverageEligibilityRequestInsurance datatype record.
Fields
- Fields Included from *BackboneElement
- coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- businessArrangement string? - A business agreement number established between the provider and the insurer for special business processing purposes.
- focal boolean? - A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: CoverageEligibilityRequestItem
FHIR CoverageEligibilityRequestItem datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - The amount charged to the patient by the provider for a single unit.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- diagnosis CoverageEligibilityRequestItemDiagnosis[]? - Patient diagnosis for which care is sought.
- productOrService CodeableConcept? - This contains the product, service, drug or other billing code for the item.
- provider Reference? - The practitioner who is responsible for the product or service to be rendered to the patient.
- supportingInfoSequence positiveInt[]? - Exceptions, special conditions and supporting information applicable for this service or product line.
- detail Reference[]? - The plan/proposal/order describing the proposed service in detail.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- facility Reference? - Facility where the services will be provided.
health.fhir.r4.international401: CoverageEligibilityRequestItemDiagnosis
FHIR CoverageEligibilityRequestItemDiagnosis datatype record.
Fields
- Fields Included from *BackboneElement
- diagnosisCoverageEligibilityRequestCodeableConcept CodeableConcept? - The nature of illness or problem in a coded form or as a reference to an external defined Condition.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- diagnosisCoverageEligibilityRequestReference Reference? - The nature of illness or problem in a coded form or as a reference to an external defined Condition.
health.fhir.r4.international401: CoverageEligibilityRequestSupportingInfo
FHIR CoverageEligibilityRequestSupportingInfo datatype record.
Fields
- Fields Included from *BackboneElement
- sequence positiveInt - A number to uniquely identify supporting information entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- appliesToAll boolean? - The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- information Reference - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- 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.international401: CoverageEligibilityResponse
FHIR CoverageEligibilityResponse resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE(default RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE) - The type of the resource describes
- insurance CoverageEligibilityResponseInsurance[]? - Financial instruments for reimbursement for the health care products and services.
- identifier Identifier[]? - A unique identifier assigned to this coverage eligiblity request.
- request Reference - Reference to the original request resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- purpose CoverageEligibilityResponsePurpose[] - Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
- created dateTime - The date this resource was created.
- 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).
- preAuthRef string? - A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.
- language code? - The base language in which the resource is written.
- 'error CoverageEligibilityResponseError[]? - Errors encountered during the processing of the request.
- servicedPeriod Period? - The date or dates when the enclosed suite of services were performed or completed.
- requestor Reference? - The provider which is responsible for the request.
- 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.
- disposition string? - A human readable description of the status of the adjudication.
- form CodeableConcept? - A code for the form to be used for printing the content.
- insurer Reference - The Insurer who issued the coverage in question and is the author of the response.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
- 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.
- servicedDate date? - The date or dates when the enclosed suite of services were performed or completed.
- 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.
- outcome CoverageEligibilityResponseOutcome - The outcome of the request processing.
- status CoverageEligibilityResponseStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: CoverageEligibilityResponseError
FHIR CoverageEligibilityResponseError 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 - An error code,from a specified code system, which details why the eligibility check could not be performed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: CoverageEligibilityResponseInsurance
FHIR CoverageEligibilityResponseInsurance datatype record.
Fields
- Fields Included from *BackboneElement
- benefitPeriod Period? - The term of the benefits documented in this response.
- coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- inforce boolean? - Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
- item CoverageEligibilityResponseInsuranceItem[]? - Benefits and optionally current balances, and authorization details by category or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: CoverageEligibilityResponseInsuranceItem
FHIR CoverageEligibilityResponseInsuranceItem 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.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- authorizationSupporting CodeableConcept[]? - Codes or comments regarding information or actions associated with the preauthorization.
- description string? - A richer description of the benefit or services covered.
- productOrService CodeableConcept? - This contains the product, service, drug or other billing code for the item.
- benefit CoverageEligibilityResponseInsuranceItemBenefit[]? - Benefits used to date.
- network CodeableConcept? - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
- excluded boolean? - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
- unit CodeableConcept? - Indicates if the benefits apply to an individual or to the family.
- authorizationUrl uri? - A web location for obtaining requirements or descriptive information regarding the preauthorization.
- authorizationRequired boolean? - A boolean flag indicating whether a preauthorization is required prior to actual service delivery.
- provider Reference? - The practitioner who is eligible for the provision of the product or service.
- name string? - A short name or tag for the benefit.
- term CodeableConcept? - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
health.fhir.r4.international401: CoverageEligibilityResponseInsuranceItemBenefit
FHIR CoverageEligibilityResponseInsuranceItemBenefit datatype record.
Fields
- Fields Included from *BackboneElement
- allowedCoverageEligibilityResponseMoney Money? - The quantity of the benefit which is permitted under the coverage.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- usedCoverageEligibilityResponseMoney Money? - The quantity of the benefit which have been consumed to date.
- usedCoverageEligibilityResponseUnsignedInt unsignedInt? - The quantity of the benefit which have been consumed to date.
- allowedCoverageEligibilityResponseString string? - The quantity of the benefit which is permitted under the coverage.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- allowedCoverageEligibilityResponseUnsignedInt unsignedInt? - The quantity of the benefit which is permitted under the coverage.
- usedCoverageEligibilityResponseString string? - The quantity of the benefit which have been consumed to 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.
- 'type CodeableConcept - Classification of benefit being provided.
health.fhir.r4.international401: DetectedIssue
FHIR DetectedIssue resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DETECTEDISSUE(default RESOURCE_NAME_DETECTEDISSUE) - The type of the resource describes
- severity DetectedIssueSeverity? - Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
- identifier Identifier[]? - Business identifier associated with the detected issue record.
- 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.
- mitigation DetectedIssueMitigation[]? - Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.
- code CodeableConcept? - Identifies the general type of issue identified.
- evidence DetectedIssueEvidence[]? - Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.
- author Reference? - Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
- 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.
- reference uri? - The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference? - Indicates the patient whose record the detected issue is associated with.
- identifiedDateTime dateTime? - The date or period when the detected issue was initially identified.
- identifiedPeriod Period? - The date or period when the detected issue was initially identified.
- implicated Reference[]? - Indicates the resource representing the current activity or proposed activity that is potentially problematic.
- 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.
- detail string? - A textual explanation of the detected issue.
- 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 DetectedIssueStatus - Indicates the status of the detected issue.
- Element... - Rest field
health.fhir.r4.international401: DetectedIssueEvidence
FHIR DetectedIssueEvidence 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 that led to the recording of this detected issue.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.
- 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.international401: DetectedIssueMitigation
FHIR DetectedIssueMitigation datatype record.
Fields
- Fields Included from *BackboneElement
- date dateTime? - Indicates when the mitigating action was documented.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- author Reference? - Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
- 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.international401: Device
FHIR Device resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICE(default RESOURCE_NAME_DEVICE) - 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 DeviceDeviceName[]? - This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
- manufacturer string? - A name of the manufacturer.
- statusReason CodeableConcept[]? - Reason for the dtatus of the Device availability.
- patient Reference? - Patient information, If the device is affixed to a person.
- safety CodeableConcept[]? - Provides additional safety characteristics about a medical device. For example devices containing latex.
- contact ContactPoint[]? - Contact details for an organization or a particular human that is responsible for the device.
- property DeviceProperty[]? - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
- manufactureDate dateTime? - The date and time when the device was manufactured.
- definition Reference? - The reference to the definition for the device.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- expirationDate dateTime? - The date and time beyond which this device is no longer valid or should not be used (if applicable).
- owner Reference? - An organization that is responsible for the provision and ongoing maintenance of the device.
- identifier Identifier[]? - Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
- serialNumber string? - The serial number assigned by the organization when the device was manufactured.
- lotNumber string? - Lot number assigned by the manufacturer.
- 'version DeviceVersion[]? - The actual design of the device or software version running on the device.
- url uri? - A network address on which the device may be contacted directly.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- udiCarrier DeviceUdiCarrier[]? - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
- 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 DeviceSpecialization[]? - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
- location Reference? - The place where the device can be found.
- modelNumber string? - The model number for the device.
- partNumber string? - The part number of the device.
- status DeviceStatus? - Status of the Device availability.
- Element... - Rest field
health.fhir.r4.international401: DeviceDefinition
FHIR DeviceDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEDEFINITION(default RESOURCE_NAME_DEVICEDEFINITION) - The type of the resource describes
- note Annotation[]? - Descriptive information, usage information or implantation information that is not captured in an existing 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.
- 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).
- physicalCharacteristics ProdCharacteristic? - Dimensions, color etc.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept? - What kind of device or device system this is.
- deviceName DeviceDefinitionDeviceName[]? - A name given to the device to identify it.
- capability DeviceDefinitionCapability[]? - Device capabilities.
- shelfLifeStorage ProductShelfLife[]? - Shelf Life and storage information.
- safety CodeableConcept[]? - Safety characteristics of the device.
- contact ContactPoint[]? - Contact details for an organization or a particular human that is responsible for the device.
- parentDevice Reference? - The parent device it can be part of.
- property DeviceDefinitionProperty[]? - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
- onlineInformation uri? - Access to on-line information about 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.
- 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 the software, manufacturers, other organizations or owners. For example: handle ID.
- manufacturerReference Reference? - A name of the manufacturer.
- quantity Quantity? - The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
- manufacturerString string? - A name of the manufacturer.
- languageCode CodeableConcept[]? - Language code for the human-readable text strings produced by the device (all supported).
- 'version string[]? - The available versions of the device, e.g., software versions.
- udiDeviceIdentifier DeviceDefinitionUdiDeviceIdentifier[]? - 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.
- 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.
- material DeviceDefinitionMaterial[]? - A substance used to create the material(s) of which the device is made.
- 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 DeviceDefinitionSpecialization[]? - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
- modelNumber string? - The model number for the device.
- Element... - Rest field
health.fhir.r4.international401: DeviceDefinitionCapability
FHIR DeviceDefinitionCapability 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 CodeableConcept[]? - Description of capability.
- 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 - Type of capability.
health.fhir.r4.international401: DeviceDefinitionDeviceName
FHIR DeviceDefinitionDeviceName 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 DeviceDefinitionDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
health.fhir.r4.international401: DeviceDefinitionMaterial
FHIR DeviceDefinitionMaterial 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).
- substance CodeableConcept - The substance.
- alternate boolean? - Indicates an alternative material 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.
- allergenicIndicator boolean? - Whether the substance is a known or suspected allergen.
health.fhir.r4.international401: DeviceDefinitionProperty
FHIR DeviceDefinitionProperty 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.international401: DeviceDefinitionSpecialization
FHIR DeviceDefinitionSpecialization 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 string - 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.international401: DeviceDefinitionUdiDeviceIdentifier
FHIR DeviceDefinitionUdiDeviceIdentifier 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.
- deviceIdentifier string - The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.
- jurisdiction uri - The jurisdiction to which the deviceIdentifier applies.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 uri - The organization that assigns the identifier algorithm.
health.fhir.r4.international401: DeviceDeviceName
FHIR DeviceDeviceName 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 DeviceDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
health.fhir.r4.international401: DeviceMetric
FHIR DeviceMetric resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEMETRIC(default RESOURCE_NAME_DEVICEMETRIC) - The type of the resource describes
- operationalStatus DeviceMetricOperationalStatus? - Indicates current operational state of the device. For example: On, Off, Standby, etc.
- identifier Identifier[]? - Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.
- parent Reference? - Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment 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.
- measurementPeriod Timing? - Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
- color DeviceMetricColor? - Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
- 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.
- 'source Reference? - Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
- 'type CodeableConcept - Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
- 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.
- unit CodeableConcept? - Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
- 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.
- category DeviceMetricCategory - Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
- calibration DeviceMetricCalibration[]? - Describes the calibrations that have been performed or that are required to be performed.
- Element... - Rest field
health.fhir.r4.international401: DeviceMetricCalibration
FHIR DeviceMetricCalibration 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.
- state DeviceMetricCalibrationState? - Describes the state of the calibration.
- time instant? - Describes the time last calibration has been performed.
- 'type DeviceMetricCalibrationType? - Describes the type of the calibration method.
health.fhir.r4.international401: DeviceProperty
FHIR DeviceProperty 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.international401: DeviceRequest
FHIR DeviceRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEREQUEST(default RESOURCE_NAME_DEVICEREQUEST) - 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[]? - Details about this request 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.
- subject Reference - The patient who will use 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[]? - Reason or justification for the use of this device.
- language code? - The base language in which the resource is written.
- priorRequest Reference[]? - The request takes the place of the referenced completed or terminated request(s).
- 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 DeviceRequest.
- relevantHistory Reference[]? - Key events in the history of the request.
- codeReference Reference - The details of the device to be used.
- supportingInfo Reference[]? - Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).
- 'parameter DeviceRequestParameter[]? - Specific parameters for the ordered item. For example, the prism value for lenses.
- 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 this 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.
- basedOn Reference[]? - Plan/proposal/order fulfilled by this request.
- requester Reference? - The individual who initiated the request and has responsibility for its activation.
- identifier Identifier[]? - Identifiers assigned to this order by the orderer or by the receiver.
- authoredOn dateTime? - When the request transitioned to being actionable.
- performer Reference? - The desired performer for doing the diagnostic testing.
- encounter Reference? - An encounter that provides additional context in which this request is made.
- occurrenceTiming Timing? - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
- priority DeviceRequestPriority? - Indicates how quickly the {{title}} should be addressed with respect to other requests.
- intent DeviceRequestIntent - Whether the request is a proposal, plan, an original order or a reflex order.
- performerType CodeableConcept? - Desired type of performer for doing the diagnostic testing.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.
- groupIdentifier Identifier? - Composite request this is part of.
- codeCodeableConcept CodeableConcept - The details of the device to be used.
- status DeviceRequestStatus? - The status of the request.
- Element... - Rest field
health.fhir.r4.international401: DeviceRequestParameter
FHIR DeviceRequestParameter datatype record.
Fields
- Fields Included from *BackboneElement
- valueCodeableConcept CodeableConcept? - The value of the device detail.
- valueBoolean boolean? - The value of the device detail.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code or string that identifies the device detail being asserted.
- valueRange Range? - The value of the device detail.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - The value of the device detail.
health.fhir.r4.international401: DeviceSpecialization
FHIR DeviceSpecialization 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.international401: DeviceUdiCarrier
FHIR DeviceUdiCarrier datatype record.
Fields
- Fields Included from *BackboneElement
- entryType DeviceUdiCarrierEntryType? - A coded entry to indicate how the data was entered.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- deviceIdentifier string? - The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
- carrierHRF string? - The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
- jurisdiction uri? - The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- carrierAIDC base64Binary? - The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
- issuer uri? - Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
health.fhir.r4.international401: DeviceUseStatement
FHIR DeviceUseStatement resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DEVICEUSESTATEMENT(default RESOURCE_NAME_DEVICEUSESTATEMENT) - 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 Reference - The patient who used 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 CodeableConcept? - Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).
- 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 DeviceUseStatementStatus - 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.international401: DeviceVersion
FHIR DeviceVersion 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.international401: DiagnosticReport
FHIR DiagnosticReport resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DIAGNOSTICREPORT(default RESOURCE_NAME_DIAGNOSTICREPORT) - The type of the resource describes
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A code or name that describes this diagnostic report.
- subject Reference? - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- presentedForm Attachment[]? - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
- language code? - The base language in which the resource is written.
- media DiagnosticReportMedia[]? - A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
- conclusion string? - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
- result Reference[]? - Observations that are part of this diagnostic report.
- specimen Reference[]? - Details about the specimens on which this diagnostic report is based.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued instant? - The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
- basedOn Reference[]? - Details concerning a service requested.
- identifier Identifier[]? - Identifiers assigned to this report by the performer or other systems.
- performer Reference[]? - The diagnostic service that is responsible for issuing the report.
- effectivePeriod Period? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- resultsInterpreter Reference[]? - The practitioner or organization that is responsible for the report's conclusions and interpretations.
- conclusionCode CodeableConcept[]? - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- effectiveDateTime dateTime? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category CodeableConcept[]? - A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
- imagingStudy Reference[]? - One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
- status DiagnosticReportStatus - The status of the diagnostic report.
- Element... - Rest field
health.fhir.r4.international401: DiagnosticReportMedia
FHIR DiagnosticReportMedia 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.international401: DocumentManifest
FHIR DocumentManifest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DOCUMENTMANIFEST(default RESOURCE_NAME_DOCUMENTMANIFEST) - The type of the resource describes
- identifier Identifier[]? - Other identifiers associated with the document manifest, including version independent identifiers.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- author Reference[]? - Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
- created dateTime? - When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
- subject Reference? - Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - Human-readable description of the source document. This is sometimes known as the 'title'.
- language code? - The base language in which the resource is written.
- 'source uri? - Identifies the source system, application, or software that produced the document manifest.
- masterIdentifier Identifier? - A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
- 'type CodeableConcept? - The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
- content Reference[] - The list of Resources that consist of the parts of this manifest.
- 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.
- related DocumentManifestRelated[]? - Related identifiers or resources associated with the DocumentManifest.
- 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.
- recipient Reference[]? - A patient, practitioner, or organization for which this set of documents is intended.
- 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 DocumentManifestStatus - The status of this document manifest.
- Element... - Rest field
health.fhir.r4.international401: DocumentManifestRelated
FHIR DocumentManifestRelated datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier? - Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- ref Reference? - Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, 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.international401: DocumentReference
FHIR DocumentReference resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_DOCUMENTREFERENCE(default RESOURCE_NAME_DOCUMENTREFERENCE) - The type of the resource describes
- date instant? - When the document reference was created.
- identifier Identifier[]? - Other identifiers associated with the document, including version independent identifiers.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- custodian Reference? - Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
- author Reference[]? - Identifies who is responsible for adding the information to the document.
- securityLabel CodeableConcept[]? - A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the 'reference' to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
- subject Reference? - Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - Human-readable description of the source document.
- language code? - The base language in which the resource is written.
- masterIdentifier Identifier? - Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
- 'type CodeableConcept? - Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
- content DocumentReferenceContent[] - The document and format referenced. There may be multiple content element repetitions, each with a different format.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- docStatus DocumentReferenceDocStatus? - The status of the underlying document.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- context DocumentReferenceContext? - The clinical context in which the document was prepared.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- category CodeableConcept[]? - A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
- relatesTo DocumentReferenceRelatesTo[]? - Relationships that this document has with other document references that already exist.
- authenticator Reference? - Which person or organization authenticates that this document is valid.
- status DocumentReferenceStatus - The status of this document reference.
- Element... - Rest field
health.fhir.r4.international401: DocumentReferenceContent
FHIR DocumentReferenceContent 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.
- attachment Attachment - The document or URL of the document along with critical metadata to prove content has integrity.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- format Coding? - An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: DocumentReferenceContext
FHIR DocumentReferenceContext 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 time period over which the service that is described by the document was provided.
- related Reference[]? - Related identifiers or resources associated with the DocumentReference.
- facilityType CodeableConcept? - The kind of facility where the patient was seen.
- practiceSetting CodeableConcept? - This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- encounter Reference[]? - Describes the clinical encounter or type of care that the document content is associated with.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- event CodeableConcept[]? - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.
- sourcePatientInfo Reference? - The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
health.fhir.r4.international401: DocumentReferenceRelatesTo
FHIR DocumentReferenceRelatesTo 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 DocumentReferenceRelatesToCode - The type of relationship that this document has with anther document.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- target Reference - The target document of this relationship.
health.fhir.r4.international401: EffectEvidenceSynthesis
FHIR EffectEvidenceSynthesis resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS(default RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the effect evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the effect evidence synthesis changes.
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- copyright markdown? - A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the effect evidence synthesis is intended to be used.
- 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 markdown? - A free text natural language description of the effect evidence synthesis from a consumer's perspective.
- language code? - The base language in which the resource is written.
- sampleSize EffectEvidenceSynthesisSampleSize? - A description of the size of the sample involved in the synthesis.
- title string? - A short, descriptive, user-friendly title for the effect evidence synthesis.
- exposureAlternative Reference - A reference to a EvidenceVariable resource that defines the comparison exposure for the research.
- studyType CodeableConcept? - Type of study eg randomized trial.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- outcome Reference - A reference to a EvidenceVariable resomece that defines the outcome for the research.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.
- resultsByExposure EffectEvidenceSynthesisResultsByExposure[]? - A description of the results for each exposure considered in the effect estimate.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the effect evidence synthesis content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- certainty EffectEvidenceSynthesisCertainty[]? - A description of the certainty of the effect estimate.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- 'version string? - The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this effect evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers.
- population Reference - A reference to a EvidenceVariable resource that defines the population for the research.
- 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.
- effectEstimate EffectEvidenceSynthesisEffectEstimate[]? - The estimated effect of the exposure variant.
- exposure Reference - A reference to a EvidenceVariable resource that defines the exposure for the research.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- synthesisType CodeableConcept? - Type of synthesis eg meta-analysis.
- name string? - A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the effect evidence synthesis.
- topic CodeableConcept[]? - Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate effect evidence synthesis instances.
- status EffectEvidenceSynthesisStatus - The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: EffectEvidenceSynthesisCertainty
FHIR EffectEvidenceSynthesisCertainty datatype record.
Fields
- Fields Included from *BackboneElement
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rating CodeableConcept[]? - A rating of the certainty of the effect estimate.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- certaintySubcomponent EffectEvidenceSynthesisCertaintyCertaintySubcomponent[]? - A description of a component of the overall certainty.
health.fhir.r4.international401: EffectEvidenceSynthesisCertaintyCertaintySubcomponent
FHIR EffectEvidenceSynthesisCertaintyCertaintySubcomponent datatype record.
Fields
- Fields Included from *BackboneElement
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rating CodeableConcept[]? - A rating of a subcomponent of rating certainty.
- 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? - Type of subcomponent of certainty rating.
health.fhir.r4.international401: EffectEvidenceSynthesisEffectEstimate
FHIR EffectEvidenceSynthesisEffectEstimate 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.
- unitOfMeasure CodeableConcept? - Specifies the UCUM unit for the outcome.
- variantState CodeableConcept? - Used to define variant exposure states such as low-risk state.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- precisionEstimate EffectEvidenceSynthesisEffectEstimatePrecisionEstimate[]? - A description of the precision of the estimate for the effect.
- description string? - Human-readable summary of effect estimate.
- 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? - Examples include relative risk and mean difference.
- value decimal? - The point estimate of the effect estimate.
health.fhir.r4.international401: EffectEvidenceSynthesisEffectEstimatePrecisionEstimate
FHIR EffectEvidenceSynthesisEffectEstimatePrecisionEstimate 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.
- level decimal? - Use 95 for a 95% confidence interval.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'from decimal? - Lower bound of confidence interval.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- to decimal? - Upper bound of confidence interval.
- 'type CodeableConcept? - Examples include confidence interval and interquartile range.
health.fhir.r4.international401: EffectEvidenceSynthesisResultsByExposure
FHIR EffectEvidenceSynthesisResultsByExposure 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.
- variantState CodeableConcept? - Used to define variant exposure states such as low-risk state.
- exposureState EffectEvidenceSynthesisResultsByExposureExposureState? - Whether these results are for the exposure state or alternative exposure state.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - Human-readable summary of results by exposure state.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- riskEvidenceSynthesis Reference - Reference to a RiskEvidenceSynthesis resource.
health.fhir.r4.international401: EffectEvidenceSynthesisSampleSize
FHIR EffectEvidenceSynthesisSampleSize datatype record.
Fields
- Fields Included from *BackboneElement
- numberOfParticipants integer? - Number of participants included in this evidence synthesis.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - Human-readable summary of sample size.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- numberOfStudies integer? - Number of studies included in this evidence synthesis.
health.fhir.r4.international401: Encounter
FHIR Encounter resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ENCOUNTER(default RESOURCE_NAME_ENCOUNTER) - The type of the resource describes
- serviceType CodeableConcept? - Broad categorization of the service that is to be provided (e.g. cardiology).
- partOf Reference? - Another Encounter of which this encounter is a part of (administratively or in time).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference? - The patient or group present at the encounter.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- appointment Reference[]? - The appointment that scheduled this encounter.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept[]? - Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
- participant EncounterParticipant[]? - The list of people responsible for providing the service.
- episodeOfCare Reference[]? - Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- 'class Coding - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
- basedOn Reference[]? - The request this encounter satisfies (e.g. incoming referral or procedure request).
- identifier Identifier[]? - Identifier(s) by which this encounter is known.
- period Period? - The start and end time of the encounter.
- classHistory EncounterClassHistory[]? - The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
- hospitalization EncounterHospitalization? - Details about the admission to a healthcare service.
- length Duration? - Quantity of time the encounter lasted. This excludes the time during leaves of absence.
- diagnosis EncounterDiagnosis[]? - The list of diagnosis relevant to this encounter.
- priority CodeableConcept? - Indicates the urgency of the encounter.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- statusHistory EncounterStatusHistory[]? - The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- serviceProvider Reference? - The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location EncounterLocation[]? - List of locations where the patient has been during this encounter.
- account Reference[]? - The set of accounts that may be used for billing for this Encounter.
- status EncounterStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
- Element... - Rest field
health.fhir.r4.international401: EncounterClassHistory
FHIR EncounterClassHistory 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 time that the episode was in the specified class.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'class Coding - inpatient | outpatient | ambulatory | emergency +.
health.fhir.r4.international401: EncounterDiagnosis
FHIR EncounterDiagnosis datatype record.
Fields
- Fields Included from *BackboneElement
- condition Reference - Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- use CodeableConcept? - Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rank positiveInt? - Ranking of the diagnosis (for each role type).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: EncounterHospitalization
FHIR EncounterHospitalization 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.
- specialArrangement CodeableConcept[]? - Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
- reAdmission CodeableConcept? - Whether this hospitalization is a readmission and why if known.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- origin Reference? - The location/organization from which the patient came before admission.
- destination Reference? - Location/organization to which the patient is discharged.
- dietPreference CodeableConcept[]? - Diet preferences reported by the patient.
- preAdmissionIdentifier Identifier? - Pre-admission identifier.
- specialCourtesy CodeableConcept[]? - Special courtesies (VIP, board member).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- dischargeDisposition CodeableConcept? - Category or kind of location after discharge.
- admitSource CodeableConcept? - From where patient was admitted (physician referral, transfer).
health.fhir.r4.international401: EncounterLocation
FHIR EncounterLocation 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? - Time period during which the patient was present at the location.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- physicalType CodeableConcept? - This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
- location Reference - The location where the encounter takes place.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- status EncounterLocationStatus? - The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
health.fhir.r4.international401: EncounterParticipant
FHIR EncounterParticipant 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 that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
- individual Reference? - Persons involved in the encounter other than the patient.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept[]? - Role of participant in encounter.
health.fhir.r4.international401: EncounterStatusHistory
FHIR EncounterStatusHistory 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 time that the episode was in the specified status.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- status EncounterStatusHistoryStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
health.fhir.r4.international401: Endpoint
FHIR Endpoint resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ENDPOINT(default RESOURCE_NAME_ENDPOINT) - The type of the resource describes
- identifier Identifier[]? - Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
- 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 interval during which the endpoint is expected to be operational.
- address urlType - The uri that describes the actual end-point to connect to.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- connectionType Coding - A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- managingOrganization Reference? - The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
- payloadType CodeableConcept[] - The payload type describes the acceptable content that can be communicated on the endpoint.
- 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 ContactPoint[]? - Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
- name string? - A friendly name that this endpoint can be referred to with.
- header string[]? - Additional headers / information to send as part of the notification.
- 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.
- payloadMimeType code[]? - The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
- status EndpointStatus - active | suspended | error | off | test.
- Element... - Rest field
health.fhir.r4.international401: EnrollmentRequest
FHIR EnrollmentRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ENROLLMENTREQUEST(default RESOURCE_NAME_ENROLLMENTREQUEST) - The type of the resource describes
- coverage Reference? - Reference to the program or plan identification, underwriter or payor.
- identifier Identifier[]? - The Response business identifier.
- 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.
- created dateTime? - The date when this resource was created.
- 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.
- candidate Reference? - Patient Resource.
- 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.
- provider Reference? - The practitioner who is responsible for the services rendered to the patient.
- insurer Reference? - The Insurer who is target of the request.
- 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 EnrollmentRequestStatus? - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: EnrollmentResponse
FHIR EnrollmentResponse resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ENROLLMENTRESPONSE(default RESOURCE_NAME_ENROLLMENTRESPONSE) - The type of the resource describes
- identifier Identifier[]? - The Response business identifier.
- request Reference? - Original request resource reference.
- 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.
- created dateTime? - The date when the enclosed suite of services were performed or completed.
- 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.
- 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.
- disposition string? - A description of the status of the adjudication.
- requestProvider Reference? - The practitioner who is responsible for the services rendered to 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.
- organization Reference? - The Insurer who produced this adjudicated response.
- 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.
- outcome EnrollmentResponseOutcome? - Processing status: error, complete.
- status EnrollmentResponseStatus? - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: EpisodeOfCare
FHIR EpisodeOfCare resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EPISODEOFCARE(default RESOURCE_NAME_EPISODEOFCARE) - The type of the resource describes
- identifier Identifier[]? - The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
- 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 interval during which the managing organization assumes the defined responsibility.
- 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).
- diagnosis EpisodeOfCareDiagnosis[]? - The list of diagnosis relevant to this episode of care.
- careManager Reference? - The practitioner that is the care manager/care coordinator for this patient.
- language code? - The base language in which the resource is written.
- team Reference[]? - The list of practitioners that may be facilitating this episode of care for specific purposes.
- 'type CodeableConcept[]? - A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- statusHistory EpisodeOfCareStatusHistory[]? - The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
- managingOrganization Reference? - The organization that has assumed the specific responsibilities for the specified duration.
- referralRequest Reference[]? - Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The patient who is the focus of this episode of care.
- 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.
- account Reference[]? - The set of accounts that may be used for billing for this EpisodeOfCare.
- status EpisodeOfCareStatus - planned | waitlist | active | onhold | finished | cancelled.
- Element... - Rest field
health.fhir.r4.international401: EpisodeOfCareDiagnosis
FHIR EpisodeOfCareDiagnosis datatype record.
Fields
- Fields Included from *BackboneElement
- condition Reference - A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role CodeableConcept? - Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rank positiveInt? - Ranking of the diagnosis (for each role type).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: EpisodeOfCareStatusHistory
FHIR EpisodeOfCareStatusHistory 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 this EpisodeOfCare that the specific status applied.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- status EpisodeOfCareStatusHistoryStatus - planned | waitlist | active | onhold | finished | cancelled.
health.fhir.r4.international401: EventDefinition
FHIR EventDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EVENTDEFINITION(default RESOURCE_NAME_EVENTDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.
- copyright markdown? - A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the event definition.
- purpose markdown? - Explanation of why this event definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the event definition is intended to be used.
- 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).
- usage string? - A detailed description of how the event definition is used from a clinical perspective.
- description markdown? - A free text natural language description of the event definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the event definition.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related resources such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the event definition content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- trigger TriggerDefinition[] - The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
- subjectReference Reference? - A code or group definition that describes the intended subject of the event definition.
- 'version string? - The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the event definition giving additional information about its content.
- name string? - A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the event definition.
- topic CodeableConcept[]? - Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
- status EventDefinitionStatus - The status of this event definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: Evidence
FHIR Evidence resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EVIDENCE(default RESOURCE_NAME_EVIDENCE) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the evidence was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence changes.
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- copyright markdown? - A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the evidence is intended to be used.
- 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 markdown? - A free text natural language description of the evidence from a consumer's perspective.
- language code? - The base language in which the resource is written.
- shortTitle string? - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
- title string? - A short, descriptive, user-friendly title for the evidence.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- outcome Reference[]? - A reference to a EvidenceVariable resomece that defines the outcome for the research.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the evidence content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- exposureVariant Reference[]? - A reference to a EvidenceVariable resource that defines the exposure for the research.
- 'version string? - The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- url uri? - An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers.
- 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.
- exposureBackground Reference - A reference to a EvidenceVariable resource that defines the population for the research.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the Evidence giving additional information about its content.
- name string? - A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the evidence.
- topic CodeableConcept[]? - Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.
- status EvidenceStatus - The status of this evidence. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: EvidenceVariable
FHIR EvidenceVariable resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EVIDENCEVARIABLE(default RESOURCE_NAME_EVIDENCEVARIABLE) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- copyright markdown? - A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the evidence variable is intended to be used.
- 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 markdown? - A free text natural language description of the evidence variable from a consumer's perspective.
- language code? - The base language in which the resource is written.
- shortTitle string? - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
- title string? - A short, descriptive, user-friendly title for the evidence variable.
- 'type EvidenceVariableType? - The type of evidence element, a population, an exposure, or an outcome.
- characteristic EvidenceVariableCharacteristic[] - A characteristic that defines the members of the evidence element. Multiple characteristics are applied with 'and' semantics.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the evidence variable content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- 'version string? - The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- url uri? - An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the EvidenceVariable giving additional information about its content.
- name string? - A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the evidence variable.
- topic CodeableConcept[]? - Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances.
- status EvidenceVariableStatus - The status of this evidence variable. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: EvidenceVariableCharacteristic
FHIR EvidenceVariableCharacteristic datatype record.
Fields
- Fields Included from *BackboneElement
- participantEffectiveTiming Timing? - Indicates what effective period the study covers.
- definitionCodeableConcept CodeableConcept - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- participantEffectivePeriod Period? - Indicates what effective period the study covers.
- usageContext UsageContext[]? - Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.
- definitionCanonical canonical - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- definitionDataRequirement DataRequirement - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- groupMeasure EvidenceVariableCharacteristicGroupMeasure? - Indicates how elements are aggregated within the study effective period.
- participantEffectiveDateTime dateTime? - Indicates what effective period the study covers.
- timeFromStart Duration? - Indicates duration from the participant's study entry.
- definitionReference Reference - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.
- definitionExpression Expression - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- definitionTriggerDefinition TriggerDefinition - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- exclude boolean? - When true, members with this characteristic are excluded from the element.
- participantEffectiveDuration Duration? - Indicates what effective period the study covers.
- 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.international401: ExampleScenario
FHIR ExampleScenario resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EXAMPLESCENARIO(default RESOURCE_NAME_EXAMPLESCENARIO) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the example scenario was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').
- copyright markdown? - A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.
- 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.
- instance ExampleScenarioInstance[]? - Each resource and each version that is present in the workflow.
- purpose markdown? - What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the example scenario is intended to be used.
- 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).
- experimental boolean? - A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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[]? - A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.
- process ExampleScenarioProcess[]? - Each major process - a group of operations.
- workflow canonical[]? - Another nested workflow.
- 'version string? - The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.
- actor ExampleScenarioActor[]? - Actor participating in the resource.
- 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 string? - A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the example scenario.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances.
- status ExampleScenarioStatus - The status of this example scenario. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: ExampleScenarioActor
FHIR ExampleScenarioActor 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.
- actorId string - ID or acronym of actor.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 actor as shown in the page.
- description markdown? - The description of the actor.
- 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 ExampleScenarioActorType - The type of actor - person or system.
health.fhir.r4.international401: ExampleScenarioInstance
FHIR ExampleScenarioInstance 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.
- resourceId string - The id of the resource for referencing.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - A short name for the resource instance.
- description markdown? - Human-friendly description of the resource instance.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- containedInstance ExampleScenarioInstanceContainedInstance[]? - Resources contained in the instance (e.g. the observations contained in a bundle).
- 'version ExampleScenarioInstanceVersion[]? - A specific version of the resource.
- resourceType code - The type of the resource.
health.fhir.r4.international401: ExampleScenarioInstanceContainedInstance
FHIR ExampleScenarioInstanceContainedInstance 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.
- resourceId string - Each resource contained in the instance.
- versionId string? - A specific version of a resource contained in the instance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: ExampleScenarioInstanceVersion
FHIR ExampleScenarioInstanceVersion 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.
- versionId string - The identifier of a specific version of a resource.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description markdown - The description of the resource version.
- 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.international401: ExampleScenarioProcess
FHIR ExampleScenarioProcess 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.
- postConditions markdown? - Description of final status after the process ends.
- preConditions markdown? - Description of initial status before the process starts.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 markdown? - A longer description of the group of operations.
- step ExampleScenarioProcessStep[]? - Each step of the process.
- 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 diagram title of the group of operations.
health.fhir.r4.international401: ExampleScenarioProcessStep
FHIR ExampleScenarioProcessStep 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).
- alternative ExampleScenarioProcessStepAlternative[]? - Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- operation ExampleScenarioProcessStepOperation? - Each interaction or action.
- pause boolean? - If there is a pause in the flow.
health.fhir.r4.international401: ExampleScenarioProcessStepAlternative
FHIR ExampleScenarioProcessStepAlternative 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 markdown? - A human-readable description of the alternative explaining when the alternative should occur rather than the base step.
- 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 label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.
health.fhir.r4.international401: ExampleScenarioProcessStepOperation
FHIR ExampleScenarioProcessStepOperation datatype record.
Fields
- Fields Included from *BackboneElement
- number string - The sequential number of the interaction, e.g. 1.2.5.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- receiver string? - Who receives the transaction.
- initiator string? - Who starts the transaction.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 human-friendly name of the interaction.
- description markdown? - A comment to be inserted in the diagram.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- receiverActive boolean? - Whether the receiver is deactivated right after the transaction.
- 'type string? - The type of operation - CRUD.
- initiatorActive boolean? - Whether the initiator is deactivated right after the transaction.
health.fhir.r4.international401: ExplanationOfBenefit
FHIR ExplanationOfBenefit resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_EXPLANATIONOFBENEFIT(default RESOURCE_NAME_EXPLANATIONOFBENEFIT) - The type of the resource describes
- benefitPeriod Period? - The term of the benefits documented in this response.
- insurance ExplanationOfBenefitInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.
- claimResponse Reference? - The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
- use ExplanationOfBenefitUse - A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
- 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).
- preAuthRef string[]? - Reference from the Insurer which is used in later communications which refers to this adjudication.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept - The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
- precedence positiveInt? - This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
- processNote ExplanationOfBenefitProcessNote[]? - A note that describes or explains adjudication results in a human readable form.
- payee ExplanationOfBenefitPayee? - The party to be reimbursed for cost of the products and services according to the terms of the policy.
- supportingInfo ExplanationOfBenefitSupportingInfo[]? - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
- claim Reference? - The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
- enterer Reference? - Individual who created the claim, predetermination or preauthorization.
- payment ExplanationOfBenefitPayment? - Payment details for the adjudication of the claim.
- 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.
- careTeam ExplanationOfBenefitCareTeam[]? - The members of the team who provided the products and services.
- identifier Identifier[]? - A unique identifier assigned to this explanation of benefit.
- item ExplanationOfBenefitItem[]? - A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
- created dateTime - The date this resource was created.
- diagnosis ExplanationOfBenefitDiagnosis[]? - Information about diagnoses relevant to the claim items.
- priority CodeableConcept? - The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
- preAuthRefPeriod Period[]? - The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
- 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.
- billablePeriod Period? - The period for which charges are being submitted.
- 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.
- subType CodeableConcept? - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
- status ExplanationOfBenefitStatus - The status of the resource instance.
- 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.
- benefitBalance ExplanationOfBenefitBenefitBalance[]? - Balance by Benefit Category.
- accident ExplanationOfBenefitAccident? - Details of a accident which resulted in injuries which required the products and services listed in the claim.
- addItem ExplanationOfBenefitAddItem[]? - The first-tier service adjudications for payor added product or service lines.
- total ExplanationOfBenefitTotal[]? - Categorized monetary totals for the adjudication.
- related ExplanationOfBenefitRelated[]? - Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
- fundsReserve CodeableConcept? - A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
- fundsReserveRequested CodeableConcept? - A code to indicate whether and for whom funds are to be reserved for future claims.
- provider Reference - The provider which is responsible for the claim, predetermination or preauthorization.
- insurer Reference - The party responsible for authorization, adjudication and reimbursement.
- patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.
- outcome ExplanationOfBenefitOutcome - The outcome of the claim, predetermination, or preauthorization processing.
- formCode CodeableConcept? - A code for the form to be used for printing the content.
- originalPrescription Reference? - Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
- procedure ExplanationOfBenefitProcedure[]? - Procedures performed on the patient relevant to the billing items with the claim.
- 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.
- disposition string? - A human readable description of the status of the adjudication.
- referral Reference? - A reference to a referral resource.
- form Attachment? - The actual form, by reference or inclusion, for printing the content or an EOB.
- prescription Reference? - Prescription to support the dispensing of pharmacy, device or vision products.
- facility Reference? - Facility where the services were provided.
- Element... - Rest field
health.fhir.r4.international401: ExplanationOfBenefitAccident
FHIR ExplanationOfBenefitAccident datatype record.
Fields
- Fields Included from *BackboneElement
- date date? - Date of an accident event related to the products and services contained in the claim.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- locationAddress Address? - The physical location of the accident event.
- locationReference Reference? - The physical location of the accident event.
- 'type CodeableConcept? - The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.
health.fhir.r4.international401: ExplanationOfBenefitAddItem
FHIR ExplanationOfBenefitAddItem datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- locationAddress Address? - Where the product or service was provided.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
- servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.
- subDetailSequence positiveInt[]? - The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.
- itemSequence positiveInt[]? - Claim items which this service line is intended to replace.
- bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).
- locationCodeableConcept CodeableConcept? - Where the product or service was provided.
- provider Reference[]? - The providers who are authorized for the services rendered to the patient.
- detailSequence positiveInt[]? - The sequence number of the details within the claim item which this line is intended to replace.
- subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).
- detail ExplanationOfBenefitAddItemDetail[]? - The second-tier service adjudications for payor added services.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- locationReference Reference? - Where the product or service was provided.
- servicedDate date? - The date or dates when the service or product was supplied, performed or completed.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
health.fhir.r4.international401: ExplanationOfBenefitAddItemDetail
FHIR ExplanationOfBenefitAddItemDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- subDetail ExplanationOfBenefitAddItemDetailSubDetail[]? - The third-tier service adjudications for payor added services.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ExplanationOfBenefitAddItemDetailSubDetail
FHIR ExplanationOfBenefitAddItemDetailSubDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
health.fhir.r4.international401: ExplanationOfBenefitBenefitBalance
FHIR ExplanationOfBenefitBenefitBalance datatype record.
Fields
- Fields Included from *BackboneElement
- excluded boolean? - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- unit CodeableConcept? - Indicates if the benefits apply to an individual or to the family.
- financial ExplanationOfBenefitBenefitBalanceFinancial[]? - Benefits Used to date.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - A short name or tag for the benefit.
- description string? - A richer description of the benefit or services covered.
- term CodeableConcept? - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category CodeableConcept - Code to identify the general type of benefits under which products and services are provided.
- network CodeableConcept? - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
health.fhir.r4.international401: ExplanationOfBenefitBenefitBalanceFinancial
FHIR ExplanationOfBenefitBenefitBalanceFinancial datatype record.
Fields
- Fields Included from *BackboneElement
- allowedExplanationOfBenefitMoney Money? - The quantity of the benefit which is permitted under the coverage.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- allowedExplanationOfBenefitUnsignedInt unsignedInt? - The quantity of the benefit which is permitted under the coverage.
- allowedExplanationOfBenefitString string? - The quantity of the benefit which is permitted under the coverage.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- usedExplanationOfBenefitUnsignedInt unsignedInt? - The quantity of the benefit which have been consumed to 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.
- usedExplanationOfBenefitMoney Money? - The quantity of the benefit which have been consumed to date.
- 'type CodeableConcept - Classification of benefit being provided.
health.fhir.r4.international401: ExplanationOfBenefitCareTeam
FHIR ExplanationOfBenefitCareTeam datatype record.
Fields
- Fields Included from *BackboneElement
- qualification CodeableConcept? - The qualification of the practitioner which is applicable for this service.
- sequence positiveInt - A number to uniquely identify care team entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- role CodeableConcept? - The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.
- provider Reference - Member of the team who provided the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- responsible boolean? - The party who is billing and/or responsible for the claimed products or services.
- 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.international401: ExplanationOfBenefitDiagnosis
FHIR ExplanationOfBenefitDiagnosis datatype record.
Fields
- Fields Included from *BackboneElement
- sequence positiveInt - A number to uniquely identify diagnosis entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- onAdmission CodeableConcept? - Indication of whether the diagnosis was present on admission to a facility.
- packageCode CodeableConcept? - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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[]? - When the condition was observed or the relative ranking.
- diagnosisReference Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.
- diagnosisCodeableConcept CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.
health.fhir.r4.international401: ExplanationOfBenefitInsurance
FHIR ExplanationOfBenefitInsurance datatype record.
Fields
- Fields Included from *BackboneElement
- coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- preAuthRef string[]? - Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.
- 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.international401: ExplanationOfBenefitItem
FHIR ExplanationOfBenefitItem 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.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- locationAddress Address? - Where the product or service was provided.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
- servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.
- adjudication ExplanationOfBenefitItemAdjudication[]? - If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
- informationSequence positiveInt[]? - Exceptions, special conditions and supporting information applicable for this service or product.
- revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.
- locationCodeableConcept CodeableConcept? - Where the product or service was provided.
- diagnosisSequence positiveInt[]? - Diagnoses applicable for this service or product.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- locationReference Reference? - Where the product or service was provided.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- quantity Quantity? - The number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- careTeamSequence positiveInt[]? - Care team members related to this service or product.
- encounter Reference[]? - A billed item may include goods or services provided in multiple encounters.
- sequence positiveInt - A number to uniquely identify item entries.
- bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).
- subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).
- detail ExplanationOfBenefitItemDetail[]? - Second-tier of goods and services.
- servicedDate date? - The date or dates when the service or product was supplied, performed or completed.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- procedureSequence positiveInt[]? - Procedures applicable for this service or product.
health.fhir.r4.international401: ExplanationOfBenefitItemAdjudication
FHIR ExplanationOfBenefitItemAdjudication datatype record.
Fields
- Fields Included from *BackboneElement
- reason CodeableConcept? - A code supporting the understanding of the adjudication result and explaining variance from expected amount.
- amount Money? - Monetary amount associated with the category.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
- value decimal? - A non-monetary value associated with the category. Mutually exclusive to the amount element above.
health.fhir.r4.international401: ExplanationOfBenefitItemDetail
FHIR ExplanationOfBenefitItemDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- subDetail ExplanationOfBenefitItemDetailSubDetail[]? - Third-tier of goods and services.
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
- sequence positiveInt - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
- revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
health.fhir.r4.international401: ExplanationOfBenefitItemDetailSubDetail
FHIR ExplanationOfBenefitItemDetailSubDetail datatype record.
Fields
- Fields Included from *BackboneElement
- unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 number of repetitions of a service or product.
- programCode CodeableConcept[]? - Identifies the program under which this may be recovered.
- modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
- noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.
- sequence positiveInt - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
- revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.
- factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
- net Money? - The quantity times the unit price for an additional service or product or charge.
health.fhir.r4.international401: ExplanationOfBenefitPayee
FHIR ExplanationOfBenefitPayee 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.
- 'type CodeableConcept? - Type of Party to be reimbursed: Subscriber, provider, other.
- party Reference? - Reference to the individual or organization to whom any payment will be made.
health.fhir.r4.international401: ExplanationOfBenefitPayment
FHIR ExplanationOfBenefitPayment datatype record.
Fields
- Fields Included from *BackboneElement
- date date? - Estimated date the payment will be issued or the actual issue date of payment.
- identifier Identifier? - Issuer's unique identifier for the payment instrument.
- adjustmentReason CodeableConcept? - Reason for the payment adjustment.
- amount Money? - Benefits payable less any payment adjustment.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- adjustment Money? - Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.
- 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? - Whether this represents partial or complete payment of the benefits payable.
health.fhir.r4.international401: ExplanationOfBenefitProcedure
FHIR ExplanationOfBenefitProcedure datatype record.
Fields
- Fields Included from *BackboneElement
- date dateTime? - Date and optionally time the procedure was performed.
- sequence positiveInt - A number to uniquely identify procedure entries.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- procedureCodeableConcept CodeableConcept - The code or reference to a Procedure resource which identifies the clinical intervention performed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- procedureReference Reference - The code or reference to a Procedure resource which identifies the clinical intervention performed.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- udi Reference[]? - Unique Device Identifiers associated with this line item.
- 'type CodeableConcept[]? - When the condition was observed or the relative ranking.
health.fhir.r4.international401: ExplanationOfBenefitProcessNote
FHIR ExplanationOfBenefitProcessNote datatype record.
Fields
- Fields Included from *BackboneElement
- number positiveInt? - A number to uniquely identify a note entry.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - A code to define the language used in the text of the note.
- 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? - The explanation or description associated with the processing.
- 'type ExplanationOfBenefitProcessNoteType? - The business purpose of the note text.
health.fhir.r4.international401: ExplanationOfBenefitRelated
FHIR ExplanationOfBenefitRelated datatype record.
Fields
- Fields Included from *BackboneElement
- reference Identifier? - An alternate organizational reference to the case or file to which this particular claim pertains.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- claim Reference? - Reference to a related claim.
- 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 code to convey how the claims are related.
health.fhir.r4.international401: ExplanationOfBenefitSupportingInfo
FHIR ExplanationOfBenefitSupportingInfo datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean boolean? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- reason Coding? - Provides the reason in the situation where a reason code is required in addition to the 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.
- code CodeableConcept? - System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
- valueReference Reference? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- timingPeriod Period? - The date when or period to which this information refers.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- timingDate date? - The date when or period to which this information refers.
- sequence positiveInt - A number to uniquely identify supporting information entries.
- valueAttachment Attachment? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- valueString string? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category CodeableConcept - The general class of the information supplied: information; exception; accident, employment; onset, etc.
- valueQuantity Quantity? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
health.fhir.r4.international401: ExplanationOfBenefitTotal
FHIR ExplanationOfBenefitTotal datatype record.
Fields
- Fields Included from *BackboneElement
- amount Money - Monetary total amount associated with the category.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
health.fhir.r4.international401: FamilyMemberHistory
FHIR FamilyMemberHistory resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_FAMILYMEMBERHISTORY(default RESOURCE_NAME_FAMILYMEMBERHISTORY) - The type of the resource describes
- ageRange Range? - The age of the relative at the time the family member history is recorded.
- date dateTime? - The date (and possibly time) when the family member history was recorded or last updated.
- dataAbsentReason CodeableConcept? - Describes why the family member's history is not available.
- note Annotation[]? - This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
- 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).
- reasonReference Reference[]? - Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
- language code? - The base language in which the resource is written.
- bornString string? - The actual or approximate date of birth of the relative.
- 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 FamilyMemberHistory.
- estimatedAge boolean? - If true, indicates that the age value specified is an estimated value.
- patient Reference - The person who this history concerns.
- deceasedRange Range? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
- 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 family member history 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.
- relationship CodeableConcept - The type of relationship this person has to the patient (father, mother, brother etc.).
- ageAge Age? - The age of the relative at the time the family member history is recorded.
- identifier Identifier[]? - Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- ageString string? - The age of the relative at the time the family member history is recorded.
- sex CodeableConcept? - The birth sex of the family member.
- bornDate date? - The actual or approximate date of birth of the relative.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
- bornPeriod Period? - The actual or approximate date of birth of the relative.
- condition FamilyMemberHistoryCondition[]? - The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
- 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? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
- deceasedString string? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history 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.
- name string? - This will either be a name or a description; e.g. 'Aunt Susan', 'my cousin with the red hair'.
- 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.
- deceasedDate date? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
- deceasedAge Age? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
- status FamilyMemberHistoryStatus - A code specifying the status of the record of the family history of a specific family member.
- Element... - Rest field
health.fhir.r4.international401: FamilyMemberHistoryCondition
FHIR FamilyMemberHistoryCondition datatype record.
Fields
- Fields Included from *BackboneElement
- contributedToDeath boolean? - This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
- note Annotation[]? - An area where general notes can be placed about this specific condition.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.
- onsetPeriod Period? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
- onsetRange Range? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- onsetString string? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
- onsetAge Age? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
- outcome CodeableConcept? - Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.
health.fhir.r4.international401: Flag
FHIR Flag resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_FLAG(default RESOURCE_NAME_FLAG) - The type of the resource describes
- identifier Identifier[]? - Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.
- code CodeableConcept - The coded value or textual component of the flag to display to the user.
- author Reference? - The person, organization or device that created the flag.
- subject Reference - The patient, location, group, organization, or practitioner etc. this is about record this flag 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.
- encounter Reference? - This alert is only relevant during the encounter.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- 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.
- category CodeableConcept[]? - Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.
- status FlagStatus - Supports basic workflow.
- Element... - Rest field
health.fhir.r4.international401: Goal
FHIR Goal resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_GOAL(default RESOURCE_NAME_GOAL) - The type of the resource describes
- statusDate date? - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
- note Annotation[]? - Any comments related to the goal.
- addresses Reference[]? - The identified conditions and other health record elements that are intended to be addressed by the goal.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- lifecycleStatus GoalLifecycleStatus - The state of the goal throughout its lifecycle.
- outcomeReference Reference[]? - Details of what's changed (or not changed).
- subject Reference - Identifies the patient, group or organization for whom the goal is being established.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.
- language code? - The base language in which the resource is written.
- outcomeCode CodeableConcept[]? - Identifies the change (or lack of change) at the point when the status of the goal is assessed.
- statusReason string? - Captures the reason for the current status.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- identifier Identifier[]? - Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- priority CodeableConcept? - Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
- target GoalTarget[]? - Indicates what should be done by when.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- expressedBy Reference? - Indicates whose goal this is - patient goal, practitioner goal, etc.
- startCodeableConcept CodeableConcept? - The date or event after which the goal should begin being pursued.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- achievementStatus CodeableConcept? - Describes the progression, or lack thereof, towards the goal against the target.
- category CodeableConcept[]? - Indicates a category the goal falls within.
- startDate date? - The date or event after which the goal should begin being pursued.
- Element... - Rest field
health.fhir.r4.international401: GoalTarget
FHIR GoalTarget datatype record.
Fields
- Fields Included from *BackboneElement
- detailRange Range? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- detailQuantity Quantity? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- dueDate date? - Indicates either the date or the duration after start by which the goal should be met.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- detailString string? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- detailBoolean boolean? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- dueDuration Duration? - Indicates either the date or the duration after start by which the goal should be met.
- measure CodeableConcept? - The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
- detailRatio Ratio? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- detailInteger integer? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- detailCodeableConcept CodeableConcept? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: GraphDefinition
FHIR GraphDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_GRAPHDEFINITION(default RESOURCE_NAME_GRAPHDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the graph definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.
- 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.
- purpose markdown? - Explanation of why this graph definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the graph definition is intended to be used.
- 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).
- profile canonical? - The profile that describes the use of the base resource.
- link GraphDefinitionLink[]? - Links this graph makes rules about.
- 'start code - The type of FHIR resource at which instances of this graph start.
- description markdown? - A free text natural language description of the graph definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- 'version string? - The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers.
- 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.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- name string - A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the graph definition.
- 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.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.
- status GraphDefinitionStatus - The status of this graph definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: GraphDefinitionLink
FHIR GraphDefinitionLink datatype record.
Fields
- Fields Included from *BackboneElement
- path string? - A FHIR expression that identifies one of FHIR References to other resources.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- sliceName string? - Which slice (if profiled).
- min integer? - Minimum occurrences for this link.
- max string? - Maximum occurrences for this link.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Information about why this link is of interest in this graph definition.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- target GraphDefinitionLinkTarget[]? - Potential target for the link.
health.fhir.r4.international401: GraphDefinitionLinkTarget
FHIR GraphDefinitionLinkTarget 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).
- profile canonical? - Profile for the target resource.
- compartment GraphDefinitionLinkTargetCompartment[]? - Compartment Consistency Rules.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- params string? - A set of parameters to look up.
- 'type code - Type of resource this link refers to.
health.fhir.r4.international401: GraphDefinitionLinkTargetCompartment
FHIR GraphDefinitionLinkTargetCompartment 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 GraphDefinitionLinkTargetCompartmentCode - Identifies the compartment.
- expression string? - Custom rule, as a FHIRPath expression.
- use GraphDefinitionLinkTargetCompartmentUse - Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Documentation for FHIRPath expression.
- rule GraphDefinitionLinkTargetCompartmentRule - identical | matching | different | no-rule | custom.
- 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.international401: Group
FHIR Group resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_GROUP(default RESOURCE_NAME_GROUP) - The type of the resource describes
- actual boolean - If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
- identifier Identifier[]? - A unique business identifier for this group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc.
- quantity unsignedInt? - A count of the number of resource instances that are part of the group.
- 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? - Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
- language code? - The base language in which the resource is written.
- 'type GroupType - Identifies the broad classification of the kind of resources the group includes.
- characteristic GroupCharacteristic[]? - Identifies traits whose presence r absence is shared by members of the group.
- managingEntity Reference? - Entity responsible for defining and maintaining Group characteristics and/or registered members.
- 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.
- member GroupMember[]? - Identifies the resource instances that are members of the group.
- name string? - A label assigned to the group for human identification and communication.
- 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.
- Element... - Rest field
health.fhir.r4.international401: GroupCharacteristic
FHIR GroupCharacteristic datatype record.
Fields
- Fields Included from *BackboneElement
- valueCodeableConcept CodeableConcept - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
- valueBoolean boolean - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 over which the characteristic is tested; e.g. the patient had an operation during the month of June.
- code CodeableConcept - A code that identifies the kind of trait being asserted.
- valueReference Reference - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
- valueRange Range - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- exclude boolean - If true, indicates the characteristic is one that is NOT held by members of the group.
- 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 - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
health.fhir.r4.international401: GroupMember
FHIR GroupMember 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 that the member was in the group, if known.
- inactive boolean? - A flag to indicate that the member is no longer in the group, but previously may have been a member.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- entity Reference - A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.
health.fhir.r4.international401: GuidanceResponse
FHIR GuidanceResponse resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_GUIDANCERESPONSE(default RESOURCE_NAME_GUIDANCERESPONSE) - The type of the resource describes
- note Annotation[]? - Provides a mechanism to communicate additional information about the response.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference? - The patient for which the request was processed.
- 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 the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
- language code? - The base language in which the resource is written.
- result Reference? - The actions, if any, produced by the evaluation of the artifact.
- evaluationMessage Reference[]? - Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
- moduleCanonical canonical - An identifier, CodeableConcept or canonical reference to the guidance that was requested.
- 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 the reason for the guidance response 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.
- moduleUri uri - An identifier, CodeableConcept or canonical reference to the guidance that was requested.
- outputParameters Reference? - The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
- identifier Identifier[]? - Allows a service to provide unique, business identifiers for the response.
- performer Reference? - Provides a reference to the device that performed the guidance.
- encounter Reference? - The encounter during which this response was created or to which the creation of this record is tightly associated.
- moduleCodeableConcept CodeableConcept - An identifier, CodeableConcept or canonical reference to the guidance that was requested.
- 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.
- dataRequirement DataRequirement[]? - If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - Indicates when the guidance response was processed.
- requestIdentifier Identifier? - The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
- status GuidanceResponseStatus - The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
- Element... - Rest field
health.fhir.r4.international401: HealthcareService
FHIR HealthcareService resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_HEALTHCARESERVICE(default RESOURCE_NAME_HEALTHCARESERVICE) - The type of the resource describes
- serviceProvisionCode CodeableConcept[]? - The code(s) that detail the conditions under which the healthcare service is available/offered.
- 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.
- specialty CodeableConcept[]? - Collection of specialties handled by the service site. This is more of a medical term.
- 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).
- eligibility HealthcareServiceEligibility[]? - Does this service have specific eligibility requirements that need to be met in order to use the service?
- language code? - The base language in which the resource is written.
- program CodeableConcept[]? - Programs that this service is applicable to.
- 'type CodeableConcept[]? - The specific type of service that may be delivered or performed.
- characteristic CodeableConcept[]? - Collection of characteristics (attributes).
- notAvailable HealthcareServiceNotAvailable[]? - The HealthcareService is not available during this period of time due to the provided reason.
- availableTime HealthcareServiceAvailableTime[]? - A collection of times that the Service Site is available.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
- telecom ContactPoint[]? - List of contacts related to this specific healthcare 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.
- communication CodeableConcept[]? - Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.
- referralMethod CodeableConcept[]? - Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
- providedBy Reference? - The organization that provides this healthcare service.
- identifier Identifier[]? - External identifiers for this item.
- appointmentRequired boolean? - Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
- active boolean? - This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.
- photo Attachment? - If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
- 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 string? - Further description of the service as it would be presented to a consumer while searching.
- 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.
- comment string? - Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
- location Reference[]? - The location(s) where this healthcare service may be provided.
- category CodeableConcept[]? - Identifies the broad category of service being performed or delivered.
- extraDetails markdown? - Extra details about the service that can't be placed in the other fields.
- 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.
- coverageArea Reference[]? - The location(s) that this service is available to (not where the service is provided).
- Element... - Rest field
health.fhir.r4.international401: HealthcareServiceAvailableTime
FHIR HealthcareServiceAvailableTime 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 HealthcareServiceAvailableTimeDaysOfWeek[]? - 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.international401: HealthcareServiceEligibility
FHIR HealthcareServiceEligibility 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? - Coded value for the eligibility.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- comment markdown? - Describes the eligibility conditions for the service.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: HealthcareServiceNotAvailable
FHIR HealthcareServiceNotAvailable 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.international401: ImagingStudy
FHIR ImagingStudy resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMAGINGSTUDY(default RESOURCE_NAME_IMAGINGSTUDY) - 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 CodeableConcept[]? - The code for the performed procedure type.
- subject Reference - 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 CodeableConcept[]? - Description of clinical condition indicating why the ImagingStudy was requested.
- 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 ImagingStudySeries[]? - 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 ImagingStudyStatus - The current state of the ImagingStudy.
- Element... - Rest field
health.fhir.r4.international401: ImagingStudySeries
FHIR ImagingStudySeries 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 ImagingStudySeriesInstance[]? - A single SOP instance within the series, e.g. an image, or presentation state.
- modality Coding - The modality of this series sequence.
- performer ImagingStudySeriesPerformer[]? - 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.international401: ImagingStudySeriesInstance
FHIR ImagingStudySeriesInstance 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.international401: ImagingStudySeriesPerformer
FHIR ImagingStudySeriesPerformer 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.international401: Immunization
FHIR Immunization resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMMUNIZATION(default RESOURCE_NAME_IMMUNIZATION) - 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 ImmunizationEducation[]? - Educational material presented to the patient (or guardian) at the time of vaccine administration.
- doseQuantity SimpleQuantity? - The quantity of vaccine product that was administered.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Condition, Observation or DiagnosticReport that supports why the immunization was administered.
- language code? - The base language in which the resource is written.
- manufacturer Reference? - Name of vaccine manufacturer.
- programEligibility CodeableConcept[]? - Indicates a patient's eligibility for a funding program.
- statusReason CodeableConcept? - Indicates the reason the immunization event was not performed.
- isSubpotent boolean? - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
- patient Reference - The patient who either received or did not receive the immunization.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - Reasons why the vaccine was administered.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- vaccineCode CodeableConcept - Vaccine that was administered or was to be administered.
- expirationDate date? - Date vaccine batch expires.
- identifier Identifier[]? - A unique identifier assigned to this immunization record.
- performer ImmunizationPerformer[]? - Indicates who performed the immunization event.
- reaction ImmunizationReaction[]? - Categorical data indicating that an adverse event is associated in time to an immunization.
- subpotentReason CodeableConcept[]? - Reason why a dose is considered to be subpotent.
- encounter Reference? - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
- lotNumber string? - Lot number of the vaccine product.
- recorded dateTime? - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- site CodeableConcept? - Body site where vaccine was administered.
- route CodeableConcept? - The path by which the vaccine product is taken into the body.
- 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 ImmunizationProtocolApplied[]? - The protocol (set of recommendations) being followed by the provider who administered the dose.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- reportOrigin CodeableConcept? - The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
- location Reference? - The service delivery location where the vaccine administration occurred.
- occurrenceDateTime dateTime - Date vaccine administered or was to be administered.
- occurrenceString string - Date vaccine administered or was to be administered.
- fundingSource CodeableConcept? - Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
- status ImmunizationStatus - Indicates the current status of the immunization event.
- Element... - Rest field
health.fhir.r4.international401: ImmunizationEducation
FHIR ImmunizationEducation 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.international401: ImmunizationEvaluation
FHIR ImmunizationEvaluation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMMUNIZATIONEVALUATION(default RESOURCE_NAME_IMMUNIZATIONEVALUATION) - The type of the resource describes
- date dateTime? - The date the evaluation of the vaccine administration event was performed.
- identifier Identifier[]? - A unique identifier assigned to this immunization evaluation record.
- 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.
- seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.
- doseStatus CodeableConcept - Indicates if the dose is valid or not valid with respect to the published recommendations.
- 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? - Additional information about the evaluation.
- language code? - The base language in which the resource is written.
- seriesDosesString string? - The recommended number of doses to achieve immunity.
- immunizationEvent Reference - The vaccine administration event being evaluated.
- doseNumberString string? - Nominal position in a series.
- 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.
- doseStatusReason CodeableConcept[]? - Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The individual for whom the evaluation is being done.
- 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).
- doseNumberPositiveInt positiveInt? - Nominal position in a series.
- targetDisease CodeableConcept - The vaccine preventable disease the dose is being evaluated against.
- 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 ImmunizationEvaluationStatus - Indicates the current status of the evaluation of the vaccination administration event.
- Element... - Rest field
health.fhir.r4.international401: ImmunizationPerformer
FHIR ImmunizationPerformer 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.international401: ImmunizationProtocolApplied
FHIR ImmunizationProtocolApplied 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 vaccine preventable disease the dose is being administered against.
- seriesDosesString string? - The recommended number of doses to achieve immunity.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: ImmunizationReaction
FHIR ImmunizationReaction 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.international401: ImmunizationRecommendation
FHIR ImmunizationRecommendation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION(default RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION) - The type of the resource describes
- date dateTime - The date the immunization recommendation(s) were created.
- identifier Identifier[]? - A unique identifier assigned to this particular recommendation record.
- 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).
- recommendation ImmunizationRecommendationRecommendation[] - Vaccine administration recommendations.
- language code? - The base language in which the resource is written.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The patient the recommendation(s) are for.
- authority Reference? - Indicates the authority who published the protocol (e.g. ACIP).
- 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.
- Element... - Rest field
health.fhir.r4.international401: ImmunizationRecommendationRecommendation
FHIR ImmunizationRecommendationRecommendation datatype record.
Fields
- Fields Included from *BackboneElement
- supportingImmunization Reference[]? - Immunization event history and/or evaluation that supports the status and recommendation.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- forecastReason CodeableConcept[]? - The reason for the assigned forecast status.
- seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- forecastStatus CodeableConcept - Indicates the patient status with respect to the path to immunity for the target disease.
- description string? - Contains the description about the protocol under which the vaccine was administered.
- seriesDosesString string? - The recommended number of doses to achieve immunity.
- supportingPatientInformation Reference[]? - Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
- doseNumberString string? - Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).
- contraindicatedVaccineCode CodeableConcept[]? - Vaccine(s) which should not be used to fulfill the recommendation.
- series string? - One possible path to achieve presumed immunity against a disease - within the context of an authority.
- doseNumberPositiveInt positiveInt? - Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).
- targetDisease CodeableConcept? - The targeted disease for the recommendation.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- dateCriterion ImmunizationRecommendationRecommendationDateCriterion[]? - Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
- vaccineCode CodeableConcept[]? - Vaccine(s) or vaccine group that pertain to the recommendation.
health.fhir.r4.international401: ImmunizationRecommendationRecommendationDateCriterion
FHIR ImmunizationRecommendationRecommendationDateCriterion 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 - Date classification of recommendation. For example, earliest date to give, latest date to give, 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.
- value dateTime - The date whose meaning is specified by dateCriterion.code.
health.fhir.r4.international401: ImplementationGuide
FHIR ImplementationGuide resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_IMPLEMENTATIONGUIDE(default RESOURCE_NAME_IMPLEMENTATIONGUIDE) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the implementation guide was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
- copyright markdown? - A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
- 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.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the implementation guide is intended to be used.
- 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 markdown? - A free text natural language description of the implementation guide from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- global ImplementationGuideGlobal[]? - A set of profiles that all resources covered by this implementation guide must conform to.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the implementation guide.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- fhirVersion code[] - The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
- definition ImplementationGuideDefinition? - The information needed by an IG publisher tool to publish the whole implementation guide.
- 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.
- dependsOn ImplementationGuideDependsOn[]? - Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
- manifest ImplementationGuideManifest? - Information about an assembled implementation guide, created by the publication tooling.
- packageId id - The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
- 'version string? - The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri - An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
- license code? - The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
- 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 string - A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the implementation guide.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.
- status ImplementationGuideStatus - The status of this implementation guide. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: ImplementationGuideDefinition
FHIR ImplementationGuideDefinition datatype record.
Fields
- Fields Included from *BackboneElement
- template ImplementationGuideDefinitionTemplate[]? - A template for building resources.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 'resource ImplementationGuideDefinitionResource[] - A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'parameter ImplementationGuideDefinitionParameter[]? - Defines how IG is built by tools.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- page ImplementationGuideDefinitionPage? - A page / section in the implementation guide. The root page is the implementation guide home page.
- grouping ImplementationGuideDefinitionGrouping[]? - A logical group of resources. Logical groups can be used when building pages.
health.fhir.r4.international401: ImplementationGuideDefinitionGrouping
FHIR ImplementationGuideDefinitionGrouping 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 human-readable title to display for the package of resources when rendering the implementation guide.
- description string? - Human readable text describing the package.
- 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.international401: ImplementationGuideDefinitionPage
FHIR ImplementationGuideDefinitionPage datatype record.
Fields
- Fields Included from *BackboneElement
- generation ImplementationGuideDefinitionPageGeneration - A code that indicates how the page is generated.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- nameImplementationGuideReference Reference - The source address for the page.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- nameImplementationGuideUrl urlType - The source address for the page.
- title string - A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
health.fhir.r4.international401: ImplementationGuideDefinitionParameter
FHIR ImplementationGuideDefinitionParameter 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 ImplementationGuideDefinitionParameterCode - apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- value string - Value for named type.
health.fhir.r4.international401: ImplementationGuideDefinitionResource
FHIR ImplementationGuideDefinitionResource datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference - Where this resource is found.
- exampleImplementationGuideCanonical canonical? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- groupingId id? - Reference to the id of the grouping this resource appears in.
- fhirVersion code[]? - Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- exampleImplementationGuideBoolean boolean? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.
- name string? - A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
- description string? - A description of the reason that a resource has been included in the implementation guide.
- 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.international401: ImplementationGuideDefinitionTemplate
FHIR ImplementationGuideDefinitionTemplate 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 code - Type of template specified.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- scope string? - The scope in which the template applies.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'source string - The source location for the template.
health.fhir.r4.international401: ImplementationGuideDependsOn
FHIR ImplementationGuideDependsOn 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).
- packageId id? - The NPM package name for the Implementation Guide that this IG depends on.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- uri canonical - A canonical reference to the Implementation guide for the dependency.
- 'version string? - The version of the IG that is depended on, when the correct version is required to understand the IG correctly.
health.fhir.r4.international401: ImplementationGuideGlobal
FHIR ImplementationGuideGlobal 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).
- profile canonical - A reference to the profile that all instances must conform to.
- 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 code - The type of resource that all instances must conform to.
health.fhir.r4.international401: ImplementationGuideManifest
FHIR ImplementationGuideManifest datatype record.
Fields
- Fields Included from *BackboneElement
- image string[]? - Indicates a relative path to an image that exists within the IG.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 string[]? - Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.
- 'resource ImplementationGuideManifestResource[] - A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rendering urlType? - A pointer to official web page, PDF or other rendering of the implementation guide.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- page ImplementationGuideManifestPage[]? - Information about a page within the IG.
health.fhir.r4.international401: ImplementationGuideManifestPage
FHIR ImplementationGuideManifestPage 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.
- anchor string[]? - The name of an anchor available on the page.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Relative path to the page.
- 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? - Label for the page intended for human display.
health.fhir.r4.international401: ImplementationGuideManifestResource
FHIR ImplementationGuideManifestResource datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference - Where this resource is found.
- exampleImplementationGuideCanonical canonical? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- relativePath urlType? - The relative path for primary page for this resource within the IG.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- exampleImplementationGuideBoolean boolean? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.
- 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.international401: InsurancePlan
FHIR InsurancePlan resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_INSURANCEPLAN(default RESOURCE_NAME_INSURANCEPLAN) - The type of the resource describes
- coverage InsurancePlanCoverage[]? - Details about the coverage offered by the insurance product.
- identifier Identifier[]? - Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period of time that the health insurance product is available.
- 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.
- administeredBy Reference? - An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
- 'type CodeableConcept[]? - The kind of health insurance product.
- network Reference[]? - Reference to the network included in the health insurance 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.
- endpoint Reference[]? - The technical endpoints providing access to services operated for the health insurance product.
- 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 InsurancePlanContact[]? - The contact for the health insurance product for a certain purpose.
- name string? - Official name of the health insurance product as designated by the owner.
- alias string[]? - A list of alternate names that the product 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.
- 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.
- ownedBy Reference? - The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.
- plan InsurancePlanPlan[]? - Details about an insurance plan.
- coverageArea Reference[]? - The geographic region in which a health insurance product's benefits apply.
- status InsurancePlanStatus? - The current state of the health insurance product.
- Element... - Rest field
health.fhir.r4.international401: InsurancePlanContact
FHIR InsurancePlanContact 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.international401: InsurancePlanCoverage
FHIR InsurancePlanCoverage 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.
- 'type CodeableConcept - Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).
- benefit InsurancePlanCoverageBenefit[] - Specific benefits under this type of coverage.
- network Reference[]? - Reference to the network that providing the type of coverage.
health.fhir.r4.international401: InsurancePlanCoverageBenefit
FHIR InsurancePlanCoverageBenefit 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).
- 'limit InsurancePlanCoverageBenefitLimit[]? - The specific limits on the benefit.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- requirement string? - The referral requirements to have access/coverage for this benefit.
- 'type CodeableConcept - Type of benefit (primary care; speciality care; inpatient; outpatient).
health.fhir.r4.international401: InsurancePlanCoverageBenefitLimit
FHIR InsurancePlanCoverageBenefitLimit 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? - The specific limit on the benefit.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- value Quantity? - The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.
health.fhir.r4.international401: InsurancePlanPlan
FHIR InsurancePlanPlan datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier[]? - Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- specificCost InsurancePlanPlanSpecificCost[]? - Costs associated with the coverage provided by the product.
- 'type CodeableConcept? - Type of plan. For example, 'Platinum' or 'High Deductable'.
- coverageArea Reference[]? - The geographic region in which a health insurance plan's benefits apply.
- generalCost InsurancePlanPlanGeneralCost[]? - Overall costs associated with the plan.
- network Reference[]? - Reference to the network that providing the type of coverage.
health.fhir.r4.international401: InsurancePlanPlanGeneralCost
FHIR InsurancePlanPlanGeneralCost 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.
- cost Money? - Value of the cost.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- comment string? - Additional information about the general costs associated with this plan.
- groupSize positiveInt? - Number of participants enrolled in the plan.
- 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? - Type of cost.
health.fhir.r4.international401: InsurancePlanPlanSpecificCost
FHIR InsurancePlanPlanSpecificCost 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.
- category CodeableConcept - General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).
- benefit InsurancePlanPlanSpecificCostBenefit[]? - List of the specific benefits under this category of benefit.
health.fhir.r4.international401: InsurancePlanPlanSpecificCostBenefit
FHIR InsurancePlanPlanSpecificCostBenefit 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.
- cost InsurancePlanPlanSpecificCostBenefitCost[]? - List of the costs associated with a specific benefit.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).
health.fhir.r4.international401: InsurancePlanPlanSpecificCostBenefitCost
FHIR InsurancePlanPlanSpecificCostBenefitCost 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).
- qualifiers CodeableConcept[]? - Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).
- applicability CodeableConcept? - Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).
- 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 - Type of cost (copay; individual cap; family cap; coinsurance; deductible).
- value Quantity? - The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).
health.fhir.r4.international401: Invoice
FHIR Invoice resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_INVOICE(default RESOURCE_NAME_INVOICE) - The type of the resource describes
- date dateTime? - Date/time(s) of when this Invoice was posted.
- identifier Identifier[]? - Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
- note Annotation[]? - Comments made about the invoice by the issuer, subject, or other participants.
- totalGross Money? - Invoice total, tax included.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference? - The individual or set of individuals receiving the goods and services billed in this invoice.
- 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.
- 'type CodeableConcept? - Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
- issuer Reference? - The organizationissuing the Invoice.
- participant InvoiceParticipant[]? - Indicates who or what performed or participated in the charged service.
- totalNet Money? - Invoice total , taxes excluded.
- 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.
- lineItem InvoiceLineItem[]? - Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
- 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.
- recipient Reference? - The individual or Organization responsible for balancing of this invoice.
- 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.
- cancelledReason string? - In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
- account Reference? - Account which is supposed to be balanced with this Invoice.
- paymentTerms markdown? - Payment details such as banking details, period of payment, deductibles, methods of payment.
- status InvoiceStatus - The current state of the Invoice.
- Element... - Rest field
health.fhir.r4.international401: InvoiceLineItem
FHIR InvoiceLineItem datatype record.
Fields
- Fields Included from *BackboneElement
- chargeItemCodeableConcept CodeableConcept - The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.
- sequence positiveInt? - Sequence in which the items appear on the invoice.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- priceComponent InvoiceLineItemPriceComponent[]? - The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.
- chargeItemReference Reference - The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.
health.fhir.r4.international401: InvoiceLineItemPriceComponent
FHIR InvoiceLineItemPriceComponent datatype record.
Fields
- Fields Included from *BackboneElement
- amount Money? - The amount calculated for this component.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts 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.
- factor decimal? - The factor that has been applied on the base price for calculating this component.
- 'type InvoiceLineItemPriceComponentType - This code identifies the type of the component.
health.fhir.r4.international401: InvoiceParticipant
FHIR InvoiceParticipant datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - The device, practitioner, etc. who performed or participated in the 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.
- role CodeableConcept? - Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: Library
FHIR Library resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_LIBRARY(default RESOURCE_NAME_LIBRARY) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.
- copyright markdown? - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the contents of the library.
- purpose markdown? - Explanation of why this library is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the library is intended to be used.
- 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).
- usage string? - A detailed description of how the library is used from a clinical perspective.
- description markdown? - A free text natural language description of the library from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the library.
- 'type CodeableConcept - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
- content Attachment[]? - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 'parameter ParameterDefinition[]? - The parameter element defines parameters used by the library.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the library content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- subjectReference Reference? - A code or group definition that describes the intended subject of the contents of the library.
- 'version string? - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- url uri? - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the library giving additional information about its content.
- name string? - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- dataRequirement DataRequirement[]? - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
- 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.
- publisher string? - The name of the organization or individual that published the library.
- topic CodeableConcept[]? - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.
- status LibraryStatus - The status of this library. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: Linkage
FHIR Linkage resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_LINKAGE(default RESOURCE_NAME_LINKAGE) - The type of the resource describes
- 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.
- 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.
- item LinkageItem[] - Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.
- author Reference? - Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.
- 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.
- 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? - Indicates whether the asserted set of linkages are considered to be 'in effect'.
- 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.
- language code? - The base language in which the resource is written.
- 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.international401: LinkageItem
FHIR LinkageItem 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.
- 'resource Reference - The resource instance being linked as part of the group.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 LinkageItemType - Distinguishes which item is 'source of truth' (if any) and which items are no longer considered to be current representations.
health.fhir.r4.international401: List
FHIR List resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_LIST(default RESOURCE_NAME_LIST) - The type of the resource describes
- date dateTime? - The date that the list was prepared.
- identifier Identifier[]? - Identifier for the List assigned for business purposes outside the context of FHIR.
- note Annotation[]? - Comments that apply to the overall list.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - This code defines the purpose of the list - why it was created.
- emptyReason CodeableConcept? - If the list is empty, why the list is empty.
- subject Reference? - The common subject (or patient) of the resources that are in the list if there is one.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- encounter Reference? - The encounter that is the context in which this list was created.
- 'source Reference? - The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
- title string? - A label for the list assigned by the author.
- mode ListMode - How this 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 ListEntry[]? - Entries in this list.
- 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.
- orderedBy CodeableConcept? - What order applies to the items in the list.
- 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 ListStatus - Indicates the current state of this list.
- Element... - Rest field
health.fhir.r4.international401: ListEntry
FHIR ListEntry datatype record.
Fields
- Fields Included from *BackboneElement
- date dateTime? - When this item was added to the list.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- item Reference - A reference to the actual resource from which data was derived.
- deleted boolean? - True if this item is marked as deleted in the list.
- flag CodeableConcept? - The flag allows the system constructing the list to indicate the role and significance of the item in the list.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: Location
FHIR Location resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_LOCATION(default RESOURCE_NAME_LOCATION) - The type of the resource describes
- operationalStatus Coding? - The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
- partOf Reference? - Another Location of which this Location is physically a part of.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - Description of the Location, which helps in finding or referencing the place.
- hoursOfOperation LocationHoursOfOperation[]? - What days/times during a week is this location usually open.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept[]? - Indicates the type of function performed at the location.
- mode LocationMode? - Indicates whether a resource instance represents a specific location or a class of locations.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the location.
- alias string[]? - A list of alternate names that the location is known as, or was known as, in the past.
- telecom ContactPoint[]? - The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- identifier Identifier[]? - Unique code or number identifying the location to its users.
- address Address? - Physical location.
- physicalType CodeableConcept? - Physical form of the location, e.g. building, room, vehicle, road.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- managingOrganization Reference? - The organization responsible for the provisioning and upkeep of the location.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- name string? - Name of the location as used by humans. Does not need to be unique.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- position LocationPosition? - The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
- availabilityExceptions string? - A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
- status LocationStatus? - The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
- Element... - Rest field
health.fhir.r4.international401: LocationHoursOfOperation
FHIR LocationHoursOfOperation datatype record.
Fields
- Fields Included from *BackboneElement
- allDay boolean? - The Location is open all day.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- closingTime time? - Time that the Location closes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- openingTime time? - Time that the Location opens.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- daysOfWeek LocationHoursOfOperationDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.
health.fhir.r4.international401: LocationPosition
FHIR LocationPosition datatype record.
Fields
- Fields Included from *BackboneElement
- altitude decimal? - Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- latitude decimal - Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- longitude decimal - Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
health.fhir.r4.international401: Measure
FHIR Measure resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEASURE(default RESOURCE_NAME_MEASURE) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the measure was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
- copyright markdown? - A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
- 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).
- usage string? - A detailed description, from a clinical perspective, of how the measure is used.
- experimental boolean? - A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept[]? - Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
- riskAdjustment string? - A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- group MeasureGroup[]? - A group of population criteria for the measure.
- identifier Identifier[]? - A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the measure content was or is planned to be in active use.
- rateAggregation string? - Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- compositeScoring CodeableConcept? - If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
- supplementalData MeasureSupplementalData[]? - The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.
- 'version string? - The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the measure giving additional information about its content.
- name string? - A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the measure.
- topic CodeableConcept[]? - Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.
- status MeasureStatus - The status of this measure. Enables tracking the life-cycle of the content.
- clinicalRecommendationStatement markdown? - Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- subjectCodeableConcept CodeableConcept? - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
- purpose markdown? - Explanation of why this measure is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the measure is intended to be used.
- description markdown? - A free text natural language description of the measure from a consumer's perspective.
- improvementNotation CodeableConcept? - Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).
- title string? - A short, descriptive, user-friendly title for the measure.
- library canonical[]? - A reference to a Library resource containing the formal logic used by the measure.
- definition markdown[]? - Provides a description of an individual term used within the measure.
- disclaimer markdown? - Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- scoring CodeableConcept? - Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- rationale markdown? - Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
- subjectReference Reference? - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
- url uri? - An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
- 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.
- guidance markdown? - Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
- Element... - Rest field
health.fhir.r4.international401: MeasureGroup
FHIR MeasureGroup 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? - Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 human readable description of this population group.
- stratifier MeasureGroupStratifier[]? - The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- population MeasureGroupPopulation[]? - A population criteria for the measure.
health.fhir.r4.international401: MeasureGroupPopulation
FHIR MeasureGroupPopulation 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? - The type of population criteria.
- criteria Expression - An expression that specifies the criteria for the population, typically the name of an expression in a library.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 human readable description of this population criteria.
- 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.international401: MeasureGroupStratifier
FHIR MeasureGroupStratifier datatype record.
Fields
- Fields Included from *BackboneElement
- component MeasureGroupStratifierComponent[]? - A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.
- criteria Expression? - An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 human readable description of this stratifier criteria.
- 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.international401: MeasureGroupStratifierComponent
FHIR MeasureGroupStratifierComponent 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? - Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.
- criteria Expression - An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 human readable description of this stratifier criteria component.
- 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.international401: MeasureReport
FHIR MeasureReport resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEASUREREPORT(default RESOURCE_NAME_MEASUREREPORT) - The type of the resource describes
- date dateTime? - The date this measure report was generated.
- identifier Identifier[]? - A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.
- 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 reporting period for which the report was calculated.
- subject Reference? - Optional subject identifying the individual or individuals the report is for.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- improvementNotation CodeableConcept? - Whether improvement in the measure is noted by an increase or decrease in the measure score.
- language code? - The base language in which the resource is written.
- reporter Reference? - The individual, location, or organization that is reporting the data.
- 'type MeasureReportType - The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.
- 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.
- measure canonical - A reference to the Measure that was calculated to produce this report.
- 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.
- evaluatedResource Reference[]? - A reference to a Bundle containing the Resources that were used in the calculation of this measure.
- 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.
- group MeasureReportGroup[]? - The results of the calculation, one for each population group in the measure.
- status MeasureReportStatus - The MeasureReport status. No data will be available until the MeasureReport status is complete.
- Element... - Rest field
health.fhir.r4.international401: MeasureReportGroup
FHIR MeasureReportGroup 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? - The meaning of the population group as defined in the measure definition.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- stratifier MeasureReportGroupStratifier[]? - When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- measureScore Quantity? - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.
- population MeasureReportGroupPopulation[]? - The populations that make up the population group, one for each type of population appropriate for the measure.
health.fhir.r4.international401: MeasureReportGroupPopulation
FHIR MeasureReportGroupPopulation 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? - The type of the population.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- count integer? - The number of members of the population.
- subjectResults Reference? - This element refers to a List of subject level MeasureReport resources, one for each subject in this population.
- 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.international401: MeasureReportGroupStratifier
FHIR MeasureReportGroupStratifier 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[]? - The meaning of this stratifier, as defined in the measure definition.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- stratum MeasureReportGroupStratifierStratum[]? - This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.
health.fhir.r4.international401: MeasureReportGroupStratifierStratum
FHIR MeasureReportGroupStratifierStratum datatype record.
Fields
- Fields Included from *BackboneElement
- component MeasureReportGroupStratifierStratumComponent[]? - A stratifier component value.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- measureScore Quantity? - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.
- value CodeableConcept? - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.
- population MeasureReportGroupStratifierStratumPopulation[]? - The populations that make up the stratum, one for each type of population appropriate to the measure.
health.fhir.r4.international401: MeasureReportGroupStratifierStratumComponent
FHIR MeasureReportGroupStratifierStratumComponent 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 - The code for the stratum component 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.
- value CodeableConcept - The stratum component value.
health.fhir.r4.international401: MeasureReportGroupStratifierStratumPopulation
FHIR MeasureReportGroupStratifierStratumPopulation 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? - The type of the population.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- count integer? - The number of members of the population in this stratum.
- subjectResults Reference? - This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.
- 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.international401: MeasureSupplementalData
FHIR MeasureSupplementalData 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? - Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures.
- criteria Expression - The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- usage CodeableConcept[]? - An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
- description string? - The human readable description of this supplemental data.
- 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.international401: Media
FHIR Media resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDIA(default RESOURCE_NAME_MEDIA) - 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 Reference? - 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 CodeableConcept? - A code that classifies whether the media is an image, video or audio recording or some other media category.
- 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 MediaStatus - The current state of the {{title}}.
- Element... - Rest field
health.fhir.r4.international401: Medication
FHIR Medication resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATION(default RESOURCE_NAME_MEDICATION) - The type of the resource describes
- identifier Identifier[]? - Business identifier for this medication.
- amount Ratio? - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
- ingredient MedicationIngredient[]? - Identifies a particular constituent of interest in the product.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- batch MedicationBatch? - Information that only applies to packages (not products).
- language code? - The base language in which the resource is written.
- manufacturer Reference? - Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- form CodeableConcept? - Describes the form of the item. Powder; tablets; capsule.
- 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 MedicationStatus? - A code to indicate if the medication is in active use.
- Element... - Rest field
health.fhir.r4.international401: MedicationAdministration
FHIR MedicationAdministration resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONADMINISTRATION(default RESOURCE_NAME_MEDICATIONADMINISTRATION) - The type of the resource describes
- dosage MedicationAdministrationDosage? - Describes the medication dosage information details e.g. dose, rate, site, route, etc.
- instantiates uri[]? - A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
- note Annotation[]? - Extra information about the medication administration that is not conveyed by the other attributes.
- partOf Reference[]? - A larger event of which this particular event is a component or step.
- request Reference? - The original request, instruction or authority to perform the administration.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- subject Reference - The person or animal or group receiving 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 was administered.
- language code? - The base language in which the resource is written.
- medicationReference Reference - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- statusReason CodeableConcept[]? - A code indicating why the administration was not performed.
- context Reference? - The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
- 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 code indicating why the medication was given.
- 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[]? - Identifiers associated with this Medication Administration 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.
- performer MedicationAdministrationPerformer[]? - Indicates who or what performed the medication administration and how they were involved.
- effectivePeriod Period - A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
- supportingInformation Reference[]? - Additional information (for example, patient height and weight) that supports the administration of the medication.
- medicationCodeableConcept CodeableConcept - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- 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 - A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
- 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[]? - A summary of the events of interest that have occurred, such as when the administration was verified.
- 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.
- device Reference[]? - The device used in administering the medication to the patient. For example, a particular infusion pump.
- status MedicationAdministrationStatus - Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
- Element... - Rest field
health.fhir.r4.international401: MedicationAdministrationDosage
FHIR MedicationAdministrationDosage datatype record.
Fields
- Fields Included from *BackboneElement
- dose Quantity? - The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- rateRatio Ratio? - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
- site CodeableConcept? - A coded specification of the anatomic site where the medication first entered the body. For example, 'left arm'.
- route CodeableConcept? - A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
- method CodeableConcept? - A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
- rateQuantity Quantity? - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- text string? - Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.
health.fhir.r4.international401: MedicationAdministrationPerformer
FHIR MedicationAdministrationPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - Indicates who or what performed the medication administration.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 medication administration.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicationBatch
FHIR MedicationBatch 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.international401: MedicationDispense
FHIR MedicationDispense resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONDISPENSE(default RESOURCE_NAME_MEDICATIONDISPENSE) - The type of the resource describes
- note Annotation[]? - Extra information about the dispense that could not be conveyed in the other attributes.
- partOf Reference[]? - The procedure that trigger the dispense.
- 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 MedicationDispenseSubstitution? - Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
- subject Reference? - A link to a resource representing the person or the group 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).
- destination Reference? - Identification of the facility/location where the medication was shipped to, as part of the dispense event.
- language code? - The base language in which the resource is written.
- statusReasonReference Reference? - Indicates the reason why a dispense was not performed.
- statusReasonCodeableConcept CodeableConcept? - Indicates the reason why a dispense was not performed.
- 'type CodeableConcept? - Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
- 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 that identifies the medication from a known list of medications.
- context Reference? - The encounter or episode of care that establishes the context for this event.
- 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.
- authorizingPrescription Reference[]? - Indicates the medication order that is being dispensed against.
- identifier Identifier[]? - Identifiers associated with this Medication Dispense 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.
- performer MedicationDispensePerformer[]? - Indicates who or what performed the event.
- quantity SimpleQuantity? - The amount of medication that has been dispensed. Includes unit of measure.
- 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.
- receiver Reference[]? - Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
- whenPrepared dateTime? - The time when the dispensed product was packaged and reviewed.
- daysSupply SimpleQuantity? - The amount of medication expressed as a timing amount.
- supportingInformation Reference[]? - Additional information that supports the medication being dispensed.
- whenHandedOver dateTime? - The time the dispensed product was provided to the patient or their representative.
- 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 that identifies the medication from a known list of medications.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- dosageInstruction Dosage[]? - Indicates how the medication is to be used by the patient.
- 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[]? - A summary of the events of interest that have occurred, such as when the dispense was verified.
- 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 dispense was performed.
- category CodeableConcept? - Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- status MedicationDispenseStatus - A code specifying the state of the set of dispense events.
- Element... - Rest field
health.fhir.r4.international401: MedicationDispensePerformer
FHIR MedicationDispensePerformer datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser 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.
- 'function CodeableConcept? - Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicationDispenseSubstitution
FHIR MedicationDispenseSubstitution datatype record.
Fields
- Fields Included from *BackboneElement
- reason CodeableConcept[]? - Indicates the reason for the substitution (or lack of substitution) from what was prescribed.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- wasSubstituted boolean - True if the dispenser dispensed a different drug or product from what was prescribed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- responsibleParty Reference[]? - The person or organization that has primary responsibility for the substitution.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept? - A code signifying whether a different drug was dispensed from what was prescribed.
health.fhir.r4.international401: MedicationIngredient
FHIR MedicationIngredient 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? - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
- itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- isActive boolean? - Indication of whether this ingredient affects the therapeutic action of the drug.
health.fhir.r4.international401: MedicationKnowledge
FHIR MedicationKnowledge resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONKNOWLEDGE(default RESOURCE_NAME_MEDICATIONKNOWLEDGE) - The type of the resource describes
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
- 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).
- regulatory MedicationKnowledgeRegulatory[]? - Regulatory information about a medication.
- medicineClassification MedicationKnowledgeMedicineClassification[]? - Categorization of the medication within a formulary or classification system.
- associatedMedication Reference[]? - Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
- 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.
- synonym string[]? - Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
- 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.
- relatedMedicationKnowledge MedicationKnowledgeRelatedMedicationKnowledge[]? - Associated or related knowledge about a medication.
- productType CodeableConcept[]? - Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
- administrationGuidelines MedicationKnowledgeAdministrationGuidelines[]? - Guidelines for the administration of the medication.
- contraindication Reference[]? - Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
- amount SimpleQuantity? - 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.).
- intendedRoute CodeableConcept[]? - The intended or approved route of administration.
- cost MedicationKnowledgeCost[]? - The price of the medication.
- ingredient MedicationKnowledgeIngredient[]? - Identifies a particular constituent of interest in the product.
- preparationInstruction markdown? - The instructions for preparing the medication.
- packaging MedicationKnowledgePackaging? - Information that only applies to packages (not products).
- monitoringProgram MedicationKnowledgeMonitoringProgram[]? - The program under which the medication is reviewed.
- 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.
- drugCharacteristic MedicationKnowledgeDrugCharacteristic[]? - Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
- doseForm CodeableConcept? - Describes the form of the item. Powder; tablets; capsule.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- monograph MedicationKnowledgeMonograph[]? - Associated documentation about the medication.
- 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.
- kinetics MedicationKnowledgeKinetics[]? - The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.
- status MedicationKnowledgeStatus? - A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
- Element... - Rest field
health.fhir.r4.international401: MedicationKnowledgeAdministrationGuidelines
FHIR MedicationKnowledgeAdministrationGuidelines datatype record.
Fields
- Fields Included from *BackboneElement
- dosage MedicationKnowledgeAdministrationGuidelinesDosage[]? - Dosage for the medication for the specific guidelines.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- indicationReference Reference? - Indication for use that apply to the specific administration guidelines.
- patientCharacteristics MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics[]? - Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).
- indicationCodeableConcept CodeableConcept? - Indication for use that apply to the specific administration guidelines.
health.fhir.r4.international401: MedicationKnowledgeAdministrationGuidelinesDosage
FHIR MedicationKnowledgeAdministrationGuidelinesDosage datatype record.
Fields
- Fields Included from *BackboneElement
- dosage Dosage[] - Dosage for the medication for the specific guidelines.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 dosage (for example, prophylaxis, maintenance, therapeutic, etc.).
health.fhir.r4.international401: MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics
FHIR MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics 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.
- characteristicMedicationKnowledgeQuantity Quantity - Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).
- characteristicMedicationKnowledgeCodeableConcept CodeableConcept - Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- value string[]? - The specific characteristic (e.g. height, weight, gender, etc.).
health.fhir.r4.international401: MedicationKnowledgeCost
FHIR MedicationKnowledgeCost 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.
- cost Money - The price of the 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.
- 'source string? - The source or owner that assigns the price to the medication.
- 'type CodeableConcept - The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.
health.fhir.r4.international401: MedicationKnowledgeDrugCharacteristic
FHIR MedicationKnowledgeDrugCharacteristic datatype record.
Fields
- Fields Included from *BackboneElement
- valueCodeableConcept CodeableConcept? - Description of the characteristic.
- valueBase64Binary base64Binary? - Description of the characteristic.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueString string? - Description of the characteristic.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).
- valueQuantity Quantity? - Description of the characteristic.
health.fhir.r4.international401: MedicationKnowledgeIngredient
FHIR MedicationKnowledgeIngredient datatype record.
Fields
- Fields Included from *BackboneElement
- itemReference Reference - The actual ingredient - either a substance (simple ingredient) or another medication.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- strength Ratio? - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
- itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicationKnowledgeKinetics
FHIR MedicationKnowledgeKinetics datatype record.
Fields
- Fields Included from *BackboneElement
- areaUnderCurve Quantity[]? - The drug concentration measured at certain discrete points in time.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- halfLifePeriod Duration? - The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- lethalDose50 Quantity[]? - The median lethal dose of a drug.
health.fhir.r4.international401: MedicationKnowledgeMedicineClassification
FHIR MedicationKnowledgeMedicineClassification 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.
- classification CodeableConcept[]? - Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).
- 'type CodeableConcept - The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).
health.fhir.r4.international401: MedicationKnowledgeMonitoringProgram
FHIR MedicationKnowledgeMonitoringProgram 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? - Name of the reviewing program.
- 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? - Type of program under which the medication is monitored.
health.fhir.r4.international401: MedicationKnowledgeMonograph
FHIR MedicationKnowledgeMonograph 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.
- 'source Reference? - Associated documentation about the medication.
- 'type CodeableConcept? - The category of documentation about the medication. (e.g. professional monograph, patient education monograph).
health.fhir.r4.international401: MedicationKnowledgePackaging
FHIR MedicationKnowledgePackaging 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.
- quantity Quantity? - The number of product units the package would contain if fully loaded.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).
health.fhir.r4.international401: MedicationKnowledgeRegulatory
FHIR MedicationKnowledgeRegulatory datatype record.
Fields
- Fields Included from *BackboneElement
- schedule MedicationKnowledgeRegulatorySchedule[]? - Specifies the schedule of a medication in jurisdiction.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 MedicationKnowledgeRegulatorySubstitution[]? - Specifies if changes are allowed when dispensing a medication from a regulatory perspective.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- maxDispense MedicationKnowledgeRegulatoryMaxDispense? - The maximum number of units of the medication that can be dispensed in a period.
- regulatoryAuthority Reference - The authority that is specifying the regulations.
health.fhir.r4.international401: MedicationKnowledgeRegulatoryMaxDispense
FHIR MedicationKnowledgeRegulatoryMaxDispense 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 Duration? - The period that applies to the maximum number of units.
- quantity Quantity - The maximum number of units of the medication that can be dispensed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicationKnowledgeRegulatorySchedule
FHIR MedicationKnowledgeRegulatorySchedule datatype record.
Fields
- Fields Included from *BackboneElement
- schedule CodeableConcept - Specifies the specific drug schedule.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
health.fhir.r4.international401: MedicationKnowledgeRegulatorySubstitution
FHIR MedicationKnowledgeRegulatorySubstitution 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.
- allowed boolean - Specifies if regulation allows for changes in the medication when dispensing.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Specifies the type of substitution allowed.
health.fhir.r4.international401: MedicationKnowledgeRelatedMedicationKnowledge
FHIR MedicationKnowledgeRelatedMedicationKnowledge datatype record.
Fields
- Fields Included from *BackboneElement
- reference Reference[] - Associated documentation about the associated medication knowledge.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 category of the associated medication knowledge reference.
health.fhir.r4.international401: MedicationRequest
FHIR MedicationRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONREQUEST(default RESOURCE_NAME_MEDICATIONREQUEST) - 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 MedicationRequestSubstitution? - Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
- courseOfTherapyType CodeableConcept? - The description of the overall patte3rn of the administration of the medication to the patient.
- priorPrescription Reference? - A link to a resource representing an earlier order related order or prescription.
- subject Reference - A link to a resource representing the person or set of individuals to whom the medication will be given.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Condition or observation that supports why the medication was ordered.
- language code? - The base language in which the resource is written.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
- medicationReference Reference - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- reportedReference Reference? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- statusReason CodeableConcept? - Captures the reason for the current state of the MedicationRequest.
- dispenseRequest MedicationRequestDispenseRequest? - Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - The reason or the indication for ordering or not ordering the medication.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- doNotPerform boolean? - If true indicates that the provider is asking for the medication request not to occur.
- basedOn Reference[]? - A plan or request that is fulfilled in whole or in part by this medication request.
- requester Reference? - The individual, organization, or device that initiated the request and has responsibility for its activation.
- identifier Identifier[]? - Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
- reportedBoolean boolean? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- authoredOn dateTime? - The date (and perhaps time) when the prescription was initially written or authored on.
- performer Reference? - The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
- detectedIssue Reference[]? - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
- supportingInformation Reference[]? - Include additional information (for example, patient height and weight) that supports the ordering of the medication.
- encounter Reference? - The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
- instantiatesCanonical canonical[]? - The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
- medicationCodeableConcept CodeableConcept - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- priority MedicationRequestPriority? - Indicates how quickly the Medication Request should be addressed with respect to other requests.
- intent MedicationRequestIntent - Whether the request is a proposal, plan, or an original order.
- performerType CodeableConcept? - Indicates the type of performer of the administration of the medication.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- dosageInstruction Dosage[]? - Indicates how the medication is to be used by the patient.
- 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 MedicationRequestStatus - A code specifying the current state of the order. Generally, this will be active or completed state.
- Element... - Rest field
health.fhir.r4.international401: MedicationRequestDispenseRequest
FHIR MedicationRequestDispenseRequest 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 MedicationRequestDispenseRequestInitialFill? - Indicates the quantity or duration for the first dispense of the medication.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- expectedSupplyDuration Duration? - Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
health.fhir.r4.international401: MedicationRequestDispenseRequestInitialFill
FHIR MedicationRequestDispenseRequestInitialFill 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.international401: MedicationRequestSubstitution
FHIR MedicationRequestSubstitution 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.international401: MedicationStatement
FHIR MedicationStatement resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICATIONSTATEMENT(default RESOURCE_NAME_MEDICATIONSTATEMENT) - The type of the resource describes
- dosage Dosage[]? - 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 Reference - 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. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- 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 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 that identifies the medication from a known list of medications.
- 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 MedicationStatementStatus - 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.international401: MedicinalProduct
FHIR MedicinalProduct resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCT(default RESOURCE_NAME_MEDICINALPRODUCT) - The type of the resource describes
- attachedDocument Reference[]? - Supporting documentation, typically for regulatory submission.
- 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.
- crossReference Identifier[]? - Reference to another product, e.g. for linking authorised to investigational 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).
- pharmaceuticalProduct Reference[]? - Pharmaceutical aspects of product.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept? - Regulatory type, e.g. Investigational or Authorized.
- marketingStatus MarketingStatus[]? - Marketing status of the medicinal product, in contrast to marketing authorizaton.
- masterFile Reference[]? - A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
- productClassification CodeableConcept[]? - Allows the product to be classified by various systems.
- contact Reference[]? - A product specific contact, person (in a role), or an 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.
- paediatricUseIndicator CodeableConcept? - If authorised for use in children.
- identifier Identifier[]? - Business identifier for this product. Could be an MPID.
- manufacturingBusinessOperation MedicinalProductManufacturingBusinessOperation[]? - An operation applied to the product, for manufacturing or adminsitrative purpose.
- additionalMonitoringIndicator CodeableConcept? - Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
- packagedMedicinalProduct Reference[]? - Package representation for the product.
- specialMeasures string[]? - Whether the Medicinal Product is subject to special measures for regulatory reasons.
- 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.
- legalStatusOfSupply CodeableConcept? - The legal status of supply of the medicinal product as classified by the regulator.
- 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.
- domain Coding? - If this medicine applies to human or veterinary uses.
- name MedicinalProductName[] - The product's name, including full name and possibly coded parts.
- 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.
- specialDesignation MedicinalProductSpecialDesignation[]? - Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.
- clinicalTrial Reference[]? - Clinical trials or studies that this product is involved in.
- combinedPharmaceuticalDoseForm CodeableConcept? - The dose form for a single part product, or combined form of a multiple part product.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductAuthorization
FHIR MedicinalProductAuthorization resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION(default RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION) - The type of the resource describes
- statusDate dateTime? - The date at which the given status has become applicable.
- country CodeableConcept[]? - The country in which the marketing authorization has been granted.
- identifier Identifier[]? - Business identifier for the marketing authorization, as assigned by a regulator.
- 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.
- dateOfFirstAuthorization dateTime? - The date when the first authorization was granted by a Medicines Regulatory Agency.
- subject Reference? - The medicinal product that is being authorized.
- internationalBirthDate dateTime? - Date of first marketing authorization for a company's new medicinal product in any country in the World.
- jurisdiction CodeableConcept[]? - Jurisdiction within a country.
- 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).
- legalBasis CodeableConcept? - The legal framework against which this authorization is granted.
- holder Reference? - Marketing Authorization Holder.
- language code? - The base language in which the resource is written.
- procedure MedicinalProductAuthorizationProcedure? - The regulatory procedure for granting or amending a marketing authorization.
- jurisdictionalAuthorization MedicinalProductAuthorizationJurisdictionalAuthorization[]? - Authorization in areas within a country.
- validityPeriod Period? - The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- dataExclusivityPeriod Period? - A period of time after authorization before generic product applicatiosn can be submitted.
- 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.
- regulator Reference? - Medicines Regulatory Agency.
- 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.
- restoreDate dateTime? - The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.
- status CodeableConcept? - The status of the marketing authorization.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductAuthorizationJurisdictionalAuthorization
FHIR MedicinalProductAuthorizationJurisdictionalAuthorization datatype record.
Fields
- Fields Included from *BackboneElement
- validityPeriod Period? - The start and expected end date of the authorization.
- country CodeableConcept? - Country of authorization.
- identifier Identifier[]? - The assigned number for the marketing authorization.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- legalStatusOfSupply CodeableConcept? - The legal status of supply in a jurisdiction or region.
- jurisdiction CodeableConcept[]? - Jurisdiction within a country.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicinalProductAuthorizationProcedure
FHIR MedicinalProductAuthorizationProcedure datatype record.
Fields
- Fields Included from *BackboneElement
- dateDateTime dateTime? - Date of procedure.
- identifier Identifier? - Identifier for this 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.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- datePeriod Period? - Date 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.
- 'type CodeableConcept - Type of procedure.
health.fhir.r4.international401: MedicinalProductContraindication
FHIR MedicinalProductContraindication resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION(default RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION) - 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.
- disease CodeableConcept? - The disease, symptom or procedure for the contraindication.
- subject Reference[]? - The medication for which this is an indication.
- 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.
- therapeuticIndication Reference[]? - Information about the use of the medicinal product in relation to other therapies as part of the indication.
- population Population[]? - The population group to which this applies.
- diseaseStatus CodeableConcept? - The status of the disease or symptom for the contraindication.
- 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.
- otherTherapy MedicinalProductContraindicationOtherTherapy[]? - Information about the use of the medicinal product in relation to other therapies described as part of the indication.
- comorbidity CodeableConcept[]? - A comorbidity (concurrent condition) or coinfection.
- 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.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductContraindicationOtherTherapy
FHIR MedicinalProductContraindicationOtherTherapy datatype record.
Fields
- Fields Included from *BackboneElement
- medicationReference Reference - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- therapyRelationshipType CodeableConcept - The type of relationship between the medicinal product indication or contraindication and another therapy.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- medicationCodeableConcept CodeableConcept - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.
health.fhir.r4.international401: MedicinalProductIndication
FHIR MedicinalProductIndication resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTINDICATION(default RESOURCE_NAME_MEDICINALPRODUCTINDICATION) - 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.
- intendedEffect CodeableConcept? - The intended effect, aim or strategy to be achieved by the indication.
- subject Reference[]? - The medication for which this is an indication.
- 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.
- population Population[]? - The population group to which this applies.
- diseaseStatus CodeableConcept? - The status of the disease or symptom for which the indication applies.
- duration Quantity? - Timing or duration information as part of the indication.
- undesirableEffect Reference[]? - Describe the undesirable effects of the medicinal 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.
- otherTherapy MedicinalProductIndicationOtherTherapy[]? - Information about the use of the medicinal product in relation to other therapies described as part of the indication.
- comorbidity CodeableConcept[]? - Comorbidity (concurrent condition) or co-infection as part of the indication.
- 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.
- diseaseSymptomProcedure CodeableConcept? - The disease, symptom or procedure that is the indication for treatment.
- 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.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductIndicationOtherTherapy
FHIR MedicinalProductIndicationOtherTherapy datatype record.
Fields
- Fields Included from *BackboneElement
- medicationReference Reference - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- therapyRelationshipType CodeableConcept - The type of relationship between the medicinal product indication or contraindication and another therapy.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- medicationCodeableConcept CodeableConcept - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.
health.fhir.r4.international401: MedicinalProductIngredient
FHIR MedicinalProductIngredient resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT(default RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT) - The type of the resource describes
- identifier Identifier? - The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
- 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.
- role CodeableConcept - Ingredient role e.g. Active ingredient, excipient.
- 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).
- substance MedicinalProductIngredientSubstance? - The ingredient substance.
- language code? - The base language in which the resource is written.
- allergenicIndicator boolean? - If the ingredient is a known or suspected allergen.
- manufacturer Reference[]? - Manufacturer of this Ingredient.
- 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.
- specifiedSubstance MedicinalProductIngredientSpecifiedSubstance[]? - A specified substance that comprises this ingredient.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductIngredientSpecifiedSubstance
FHIR MedicinalProductIngredientSpecifiedSubstance 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 - The specified substance.
- strength MedicinalProductIngredientSpecifiedSubstanceStrength[]? - Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.
- confidentiality CodeableConcept? - Confidentiality level of the specified substance as the ingredient.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- group CodeableConcept - The group of specified substance, e.g. group 1 to 4.
health.fhir.r4.international401: MedicinalProductIngredientSpecifiedSubstanceStrength
FHIR MedicinalProductIngredientSpecifiedSubstanceStrength datatype record.
Fields
- Fields Included from *BackboneElement
- concentrationLowLimit Ratio? - A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.
- presentation Ratio - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.
- country CodeableConcept[]? - The country or countries for which the strength range applies.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- referenceStrength MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength[]? - Strength expressed in terms of a reference substance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- concentration Ratio? - The strength per unitary volume (or mass).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- measurementPoint string? - For when strength is measured at a particular point or distance.
- presentationLowLimit Ratio? - A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.
health.fhir.r4.international401: MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength
FHIR MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength datatype record.
Fields
- Fields Included from *BackboneElement
- country CodeableConcept[]? - The country or countries for which the strength range applies.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Strength expressed in terms of a reference substance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Relevant reference substance.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- strengthLowLimit Ratio? - Strength expressed in terms of a reference substance.
- measurementPoint string? - For when strength is measured at a particular point or distance.
health.fhir.r4.international401: MedicinalProductIngredientSubstance
FHIR MedicinalProductIngredientSubstance 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 - The ingredient substance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicinalProductInteraction
FHIR MedicinalProductInteraction resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTINTERACTION(default RESOURCE_NAME_MEDICINALPRODUCTINTERACTION) - 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.
- subject Reference[]? - The medication for which this is a described interaction.
- 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 interaction described.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept? - The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.
- 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.
- management CodeableConcept? - Actions for managing the interaction.
- 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.
- effect CodeableConcept? - The effect of the interaction, for example 'reduced gastric absorption of primary medication'.
- 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.
- interactant MedicinalProductInteractionInteractant[]? - The specific medication, food or laboratory test that interacts.
- 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.
- incidence CodeableConcept? - The incidence of the interaction, e.g. theoretical, observed.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductInteractionInteractant
FHIR MedicinalProductInteractionInteractant datatype record.
Fields
- Fields Included from *BackboneElement
- itemReference Reference - The specific medication, food or laboratory test that interacts.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- itemCodeableConcept CodeableConcept - The specific medication, food or laboratory test that interacts.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: MedicinalProductManufactured
FHIR MedicinalProductManufactured resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED(default RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED) - 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.
- otherCharacteristics CodeableConcept[]? - Other codeable characteristics.
- ingredient Reference[]? - Ingredient.
- quantity Quantity - The quantity or 'count number' of the manufactured item.
- 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).
- physicalCharacteristics ProdCharacteristic? - Dimensions, color etc.
- language code? - The base language in which the resource is written.
- manufacturer Reference[]? - Manufacturer of the item (Note that this should be named 'manufacturer' but it currently causes technical issues).
- 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.
- unitOfPresentation CodeableConcept? - The “real world” units in which the quantity of the manufactured item is described.
- 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.
- manufacturedDoseForm CodeableConcept - Dose form as manufactured and before any transformation into the pharmaceutical product.
- 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.international401: MedicinalProductManufacturingBusinessOperation
FHIR MedicinalProductManufacturingBusinessOperation datatype record.
Fields
- Fields Included from *BackboneElement
- confidentialityIndicator CodeableConcept? - To indicate if this proces is commercially confidential.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- authorisationReferenceNumber Identifier? - Regulatory authorization reference number.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- regulator Reference? - A regulator which oversees the operation.
- operationType CodeableConcept? - The type of manufacturing operation.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- effectiveDate dateTime? - Regulatory authorization date.
- manufacturer Reference[]? - The manufacturer or establishment associated with the process.
health.fhir.r4.international401: MedicinalProductName
FHIR MedicinalProductName 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).
- countryLanguage MedicinalProductNameCountryLanguage[]? - Country where the name applies.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- namePart MedicinalProductNameNamePart[]? - Coding words or phrases of the name.
- productName string - The full product name.
health.fhir.r4.international401: MedicinalProductNameCountryLanguage
FHIR MedicinalProductNameCountryLanguage datatype record.
Fields
- Fields Included from *BackboneElement
- country CodeableConcept - Country code for where this name applies.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- jurisdiction CodeableConcept? - Jurisdiction code for where this name applies.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Language code 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.
health.fhir.r4.international401: MedicinalProductNameNamePart
FHIR MedicinalProductNameNamePart 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).
- part string - A fragment of a product 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.
- 'type Coding - Idenifying type for this part of the name (e.g. strength part).
health.fhir.r4.international401: MedicinalProductPackaged
FHIR MedicinalProductPackaged resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTPACKAGED(default RESOURCE_NAME_MEDICINALPRODUCTPACKAGED) - The type of the resource describes
- identifier Identifier[]? - Unique identifier.
- 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.
- marketingAuthorization Reference? - Manufacturer of this Package Item.
- subject Reference[]? - The product with this is a pack for.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - Textual description.
- language code? - The base language in which the resource is written.
- manufacturer Reference[]? - Manufacturer of this Package Item.
- marketingStatus MarketingStatus[]? - Marketing information.
- packageItem MedicinalProductPackagedPackageItem[] - A packaging item, as a contained for medicine, possibly with other packaging items within.
- 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.
- legalStatusOfSupply CodeableConcept? - The legal status of supply of the medicinal product as classified by the regulator.
- 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.
- batchIdentifier MedicinalProductPackagedBatchIdentifier[]? - Batch numbering.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductPackagedBatchIdentifier
FHIR MedicinalProductPackagedBatchIdentifier 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).
- immediatePackaging Identifier? - A number appearing on the immediate packaging (and not the outer packaging).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- outerPackaging Identifier - A number appearing on the outer packaging of a specific batch.
health.fhir.r4.international401: MedicinalProductPackagedPackageItem
FHIR MedicinalProductPackagedPackageItem datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier[]? - Including possibly Data Carrier Identifier.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- otherCharacteristics CodeableConcept[]? - Other codeable characteristics.
- quantity Quantity - The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1.
- manufacturedItem Reference[]? - The manufactured item as contained in the packaged medicinal product.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- physicalCharacteristics ProdCharacteristic? - Dimensions, color etc.
- 'type CodeableConcept - The physical type of the container of the medicine.
- manufacturer Reference[]? - Manufacturer of this Package Item.
- material CodeableConcept[]? - Material type of the package item.
- shelfLifeStorage ProductShelfLife[]? - Shelf Life and storage information.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- alternateMaterial CodeableConcept[]? - A possible alternate material for the packaging.
- device Reference[]? - A device accompanying a medicinal product.
health.fhir.r4.international401: MedicinalProductPharmaceutical
FHIR MedicinalProductPharmaceutical resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL(default RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL) - The type of the resource describes
- identifier Identifier[]? - An identifier for the pharmaceutical medicinal product.
- characteristics MedicinalProductPharmaceuticalCharacteristics[]? - Characteristics e.g. a products onset of action.
- 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.
- administrableDoseForm CodeableConcept - The administrable dose form, after necessary reconstitution.
- ingredient Reference[]? - Ingredient.
- 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).
- routeOfAdministration MedicinalProductPharmaceuticalRouteOfAdministration[] - The path by which the pharmaceutical product is taken into or makes contact with the body.
- language code? - The base language in which the resource is written.
- 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.
- unitOfPresentation CodeableConcept? - Todo.
- 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.
- device Reference[]? - Accompanying device.
- Element... - Rest field
health.fhir.r4.international401: MedicinalProductPharmaceuticalCharacteristics
FHIR MedicinalProductPharmaceuticalCharacteristics 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 coded characteristic.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- status CodeableConcept? - The status of characteristic e.g. assigned or pending.
health.fhir.r4.international401: MedicinalProductPharmaceuticalRouteOfAdministration
FHIR MedicinalProductPharmaceuticalRouteOfAdministration 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 - Coded expression for the route.
- maxSingleDose Quantity? - The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.
- maxTreatmentPeriod Duration? - The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- targetSpecies MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies[]? - A species for which this route applies.
- firstDose Quantity? - The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- maxDosePerDay Quantity? - The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.
- maxDosePerTreatmentPeriod Ratio? - The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.
health.fhir.r4.international401: MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies
FHIR MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies 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 - Coded expression for the species.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- withdrawalPeriod MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod[]? - A species specific time during which consumption of animal product is not appropriate.
- 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.international401: MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod
FHIR MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod 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).
- supportingInformation string? - Extra information about the withdrawal period.
- tissue CodeableConcept - Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value Quantity - A value for the time.
health.fhir.r4.international401: MedicinalProductSpecialDesignation
FHIR MedicinalProductSpecialDesignation datatype record.
Fields
- Fields Included from *BackboneElement
- date dateTime? - Date when the designation was granted.
- identifier Identifier[]? - Identifier for the designation, or procedure number.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- species CodeableConcept? - Animal species for which this applies.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- intendedUse CodeableConcept? - The intended use of the product, e.g. prevention, treatment.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- indicationReference Reference? - Condition for which the medicinal use applies.
- 'type CodeableConcept? - The type of special designation, e.g. orphan drug, minor use.
- indicationCodeableConcept CodeableConcept? - Condition for which the medicinal use applies.
- status CodeableConcept? - For example granted, pending, expired or withdrawn.
health.fhir.r4.international401: MedicinalProductUndesirableEffect
FHIR MedicinalProductUndesirableEffect resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT(default RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT) - 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.
- subject Reference[]? - The medication for which this is an indication.
- 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.
- classification CodeableConcept? - Classification of the effect.
- frequencyOfOccurrence CodeableConcept? - The frequency of occurrence of the effect.
- population Population[]? - The population group to which this applies.
- 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.
- symptomConditionEffect CodeableConcept? - The symptom, condition or undesirable effect.
- 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.international401: MessageDefinition
FHIR MessageDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MESSAGEDEFINITION(default RESOURCE_NAME_MESSAGEDEFINITION) - The type of the resource describes
- date dateTime - The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.
- parent canonical[]? - Identifies a protocol or workflow that this MessageDefinition represents a step in.
- copyright markdown? - A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
- 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.
- purpose markdown? - Explanation of why this message definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the message definition is intended to be used.
- 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 markdown? - A free text natural language description of the message definition from a consumer's perspective.
- focus MessageDefinitionFocus[]? - Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
- experimental boolean? - A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the message definition.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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.
- allowedResponse MessageDefinitionAllowedResponse[]? - Indicates what types of messages may be sent as an application-level response to this message.
- eventUri uri - Event code or link to the EventDefinition.
- identifier Identifier[]? - A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- replaces canonical[]? - A MessageDefinition that is superseded by this definition.
- eventCoding Coding - Event code or link to the EventDefinition.
- 'version string? - The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- graph canonical[]? - Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.
- responseRequired MessageDefinitionResponseRequired? - Declare at a message definition level whether a response is required or only upon error or success, or never.
- url uri? - The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.
- 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 string? - A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the message definition.
- category MessageDefinitionCategory? - The impact of the content of the message.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.
- base canonical? - The MessageDefinition that is the basis for the contents of this resource.
- status MessageDefinitionStatus - The status of this message definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: MessageDefinitionAllowedResponse
FHIR MessageDefinitionAllowedResponse 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.
- message canonical - A reference to the message definition that must be adhered to by this supported response.
- situation markdown? - Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).
health.fhir.r4.international401: MessageDefinitionFocus
FHIR MessageDefinitionFocus 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 code - The kind of resource that must be the focus for this message.
- min unsignedInt - Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
- max string? - Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- profile canonical? - A profile that reflects constraints for the focal resource (and potentially for related 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.
health.fhir.r4.international401: MessageHeader
FHIR MessageHeader resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MESSAGEHEADER(default RESOURCE_NAME_MESSAGEHEADER) - The type of the resource describes
- eventUri uri - Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value 'http://terminology.hl7.org/CodeSystem/message-events'. Alternatively uri to the EventDefinition.
- reason CodeableConcept? - Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
- 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.
- author Reference? - The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
- 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).
- destination MessageHeaderDestination[]? - The destination application which the message is intended for.
- focus Reference[]? - The actual data of the message - a reference to the root/focus class of the event.
- language code? - The base language in which the resource is written.
- 'source MessageHeaderSource - The source application from which this message originated.
- eventCoding Coding - Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value 'http://terminology.hl7.org/CodeSystem/message-events'. Alternatively uri to the EventDefinition.
- 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.
- sender Reference? - Identifies the sending system to allow the use of a trust relationship.
- 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.
- response MessageHeaderResponse? - Information about the message that this message is a response to. Only present if this message is a response.
- responsible Reference? - The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
- enterer Reference? - The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
- 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.
- definition canonical? - Permanent link to the MessageDefinition for this message.
- 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.international401: MessageHeaderDestination
FHIR MessageHeaderDestination datatype record.
Fields
- Fields Included from *BackboneElement
- endpoint urlType - Indicates where the message should be routed to.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- receiver Reference? - Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Human-readable name for the target system.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- target Reference? - Identifies the target end system in situations where the initial message transmission is to an intermediary system.
health.fhir.r4.international401: MessageHeaderResponse
FHIR MessageHeaderResponse datatype record.
Fields
- Fields Included from *BackboneElement
- identifier id - The MessageHeader.id of the message to which this message is a response.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 MessageHeaderResponseCode - Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- details Reference? - Full details of any issues found in the message.
- 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.international401: MessageHeaderSource
FHIR MessageHeaderSource datatype record.
Fields
- Fields Included from *BackboneElement
- endpoint urlType - Identifies the routing target to send acknowledgements to.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- software string? - May include configuration or other information useful in debugging.
- contact ContactPoint? - An e-mail, phone, website or other contact point to use to resolve issues with message communications.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Human-readable name for the source system.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version string? - Can convey versions of multiple systems in situations where a message passes through multiple hands.
health.fhir.r4.international401: MolecularSequence
FHIR MolecularSequence resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_MOLECULARSEQUENCE(default RESOURCE_NAME_MOLECULARSEQUENCE) - The type of the resource describes
- identifier Identifier[]? - A unique identifier for this particular sequence instance. This is a FHIR-defined id.
- 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.
- pointer Reference[]? - Pointer to next atomic sequence which at most contains one variant.
- performer Reference? - The organization or lab that should be responsible for this result.
- quantity Quantity? - The number of copies of the sequence of interest. (RNASeq).
- 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.
- observedSeq string? - Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.
- repository MolecularSequenceRepository[]? - Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.
- 'type MolecularSequenceType? - Amino Acid Sequence/ DNA Sequence / RNA Sequence.
- quality MolecularSequenceQuality[]? - An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score (SO:0001686).
- structureVariant MolecularSequenceStructureVariant[]? - Information about chromosome structure variation.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference? - The patient whose sequencing results are described by this resource.
- readCoverage integer? - Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.
- specimen Reference? - Specimen used for sequencing.
- variant MolecularSequenceVariant[]? - The definition of variant here originates from Sequence ontology (variant_of). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.
- 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.
- coordinateSystem integer - Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).
- 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.
- device Reference? - The method for sequencing, for example, chip information.
- referenceSeq MolecularSequenceReferenceSeq? - A sequence that is used as a reference to describe variants that are present in a sequence analyzed.
- Element... - Rest field
health.fhir.r4.international401: MolecularSequenceQuality
FHIR MolecularSequenceQuality 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.
- fScore decimal? - Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).
- method CodeableConcept? - Which method is used to get sequence quality.
- truthTP decimal? - True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.
- gtFP decimal? - The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- precision decimal? - QUERY.TP / (QUERY.TP + QUERY.FP).
- roc MolecularSequenceQualityRoc? - Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.
- queryTP decimal? - True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.
- 'start integer? - Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
- 'type MolecularSequenceQualityType - INDEL / SNP / Undefined variant.
- score Quantity? - The score of an experimentally derived feature such as a p-value (SO:0001685).
- standardSequence CodeableConcept? - Gold standard sequence used for comparing against.
- truthFN decimal? - False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.
- recall decimal? - TRUTH.TP / (TRUTH.TP + TRUTH.FN).
- end integer? - End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- queryFP decimal? - False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.
health.fhir.r4.international401: MolecularSequenceQualityRoc
FHIR MolecularSequenceQualityRoc datatype record.
Fields
- Fields Included from *BackboneElement
- score integer[]? - Invidual data point representing the GQ (genotype quality) score threshold.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- numFP integer[]? - The number of false positives if the GQ score threshold was set to 'score' field value.
- fMeasure decimal[]? - Calculated fScore if the GQ score threshold was set to 'score' field value.
- numTP integer[]? - The number of true positives if the GQ score threshold was set to 'score' field 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).
- precision decimal[]? - Calculated precision if the GQ score threshold was set to 'score' field value.
- numFN integer[]? - The number of false negatives if the GQ score threshold was set to 'score' field 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.
- sensitivity decimal[]? - Calculated sensitivity if the GQ score threshold was set to 'score' field value.
health.fhir.r4.international401: MolecularSequenceReferenceSeq
FHIR MolecularSequenceReferenceSeq 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.
- orientation MolecularSequenceReferenceSeqOrientation? - A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the 'sense' strand, and the opposite complementary strand is the 'antisense' strand.
- strand MolecularSequenceReferenceSeqStrand? - An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.
- referenceSeqString string? - A string like 'ACGT'.
- windowStart integer? - Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
- genomeBuild string? - The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used.
- chromosome CodeableConcept? - Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication (SO:0000340).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- windowEnd integer? - End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
- referenceSeqPointer Reference? - A pointer to another MolecularSequence entity as reference sequence.
- referenceSeqId CodeableConcept? - Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.
health.fhir.r4.international401: MolecularSequenceRepository
FHIR MolecularSequenceRepository 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.
- readsetId string? - Id of the read in this external repository.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - URI of an external repository which contains further details about the genetics data.
- datasetId string? - Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.
- 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 MolecularSequenceRepositoryType - Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.
- variantsetId string? - Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.
- url uri? - URI of an external repository which contains further details about the genetics data.
health.fhir.r4.international401: MolecularSequenceStructureVariant
FHIR MolecularSequenceStructureVariant datatype record.
Fields
- Fields Included from *BackboneElement
- variantType CodeableConcept? - Information about chromosome structure variation DNA change 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).
- exact boolean? - Used to indicate if the outer and inner start-end values have the same meaning.
- length integer? - Length of the variant chromosome.
- 'outer MolecularSequenceStructureVariantOuter? - Structural variant outer.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- inner MolecularSequenceStructureVariantInner? - Structural variant inner.
health.fhir.r4.international401: MolecularSequenceStructureVariantInner
FHIR MolecularSequenceStructureVariantInner 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).
- 'start integer? - Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
- end integer? - Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
- 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.international401: MolecularSequenceStructureVariantOuter
FHIR MolecularSequenceStructureVariantOuter 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).
- 'start integer? - Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
- end integer? - Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
- 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.international401: MolecularSequenceVariant
FHIR MolecularSequenceVariant 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).
- 'start integer? - Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
- end integer? - End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
- observedAllele string? - An allele is one of a set of coexisting sequence variants of a gene (SO:0001023). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
- referenceAllele string? - An allele is one of a set of coexisting sequence variants of a gene (SO:0001023). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- variantPointer Reference? - A pointer to an Observation containing variant information.
health.fhir.r4.international401: NamingSystem
FHIR NamingSystem resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_NAMINGSYSTEM(default RESOURCE_NAME_NAMINGSYSTEM) - The type of the resource describes
- date dateTime - The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.
- 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.
- kind NamingSystemKind - Indicates the purpose for the naming system - what kinds of things does it make unique?
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the naming system is intended to be used.
- 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).
- usage string? - Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
- description markdown? - A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept? - Categorizes a naming system for easier search by grouping related naming systems.
- 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.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- responsible string? - The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
- name string - A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the naming system.
- 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.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.
- uniqueId NamingSystemUniqueId[] - Indicates how the system may be identified when referenced in electronic exchange.
- status NamingSystemStatus - The status of this naming system. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: NamingSystemUniqueId
FHIR NamingSystemUniqueId 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? - Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- comment string? - Notes about the past or intended usage of this identifier.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type NamingSystemUniqueIdType - Identifies the unique identifier scheme used for this particular identifier.
- value string - The string that should be sent over the wire to identify the code system or identifier system.
- preferred boolean? - Indicates whether this identifier is the 'preferred' identifier of this type.
health.fhir.r4.international401: NutritionOrder
FHIR NutritionOrder resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_NUTRITIONORDER(default RESOURCE_NAME_NUTRITIONORDER) - The type of the resource describes
- dateTime dateTime - The date and time that this nutrition order was requested.
- instantiates uri[]? - The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
- note Annotation[]? - Comments made about the {{title}} by the requester, performer, subject or other participants.
- 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.
- 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 NutritionOrder.
- patient Reference - The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
- 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.
- foodPreferenceModifier CodeableConcept[]? - This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
- identifier Identifier[]? - Identifiers assigned to this order by the order sender or by the order receiver.
- enteralFormula NutritionOrderEnteralFormula? - Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
- oralDiet NutritionOrderOralDiet? - Diet given orally in contrast to enteral (tube) feeding.
- excludeFoodModifier CodeableConcept[]? - This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
- encounter Reference? - An encounter that provides additional information about the healthcare context in which this request is made.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
- intent NutritionOrderIntent - Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- supplement NutritionOrderSupplement[]? - Oral nutritional products given in order to add further nutritional value to the patient's diet.
- orderer Reference? - The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
- 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.
- allergyIntolerance Reference[]? - A link to a record of allergies or intolerances which should be included in the nutrition order.
- status NutritionOrderStatus - The workflow status of the nutrition order/request.
- Element... - Rest field
health.fhir.r4.international401: NutritionOrderEnteralFormula
FHIR NutritionOrderEnteralFormula 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.
- administrationInstruction string? - Free text formula administration, feeding instructions or additional instructions or information.
- baseFormulaProductName string? - The product or brand name of the enteral or infant formula product such as 'ACME Adult Standard Formula'.
- additiveType CodeableConcept? - Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.
- administration NutritionOrderEnteralFormulaAdministration[]? - Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.
- baseFormulaType CodeableConcept? - The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- caloricDensity Quantity? - The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.
- additiveProductName string? - The product or brand name of the type of modular component to be added to the formula.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- maxVolumeToDeliver Quantity? - The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.
- routeofAdministration CodeableConcept? - The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
health.fhir.r4.international401: NutritionOrderEnteralFormulaAdministration
FHIR NutritionOrderEnteralFormulaAdministration datatype record.
Fields
- Fields Included from *BackboneElement
- schedule Timing? - The time period and frequency at which the enteral formula should be delivered to the patient.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 volume of formula to provide to the patient per the specified administration schedule.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rateNutritionOrderRatio Ratio? - The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- rateNutritionOrderQuantity Quantity? - The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
health.fhir.r4.international401: NutritionOrderOralDiet
FHIR NutritionOrderOralDiet datatype record.
Fields
- Fields Included from *BackboneElement
- schedule Timing[]? - The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- nutrient NutritionOrderOralDietNutrient[]? - Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.
- instruction string? - Free text or additional instructions or information pertaining to the oral diet.
- texture NutritionOrderOralDietTexture[]? - Class that describes any texture modifications required for the patient to safely consume various types of solid foods.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- fluidConsistencyType CodeableConcept[]? - The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served 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.
- 'type CodeableConcept[]? - The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.
health.fhir.r4.international401: NutritionOrderOralDietNutrient
FHIR NutritionOrderOralDietNutrient datatype record.
Fields
- Fields Included from *BackboneElement
- amount Quantity? - The quantity of the specified nutrient to include in diet.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifier CodeableConcept? - The nutrient that is being modified such as carbohydrate or sodium.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: NutritionOrderOralDietTexture
FHIR NutritionOrderOralDietTexture 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.
- foodType CodeableConcept? - The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.
- modifier CodeableConcept? - Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: NutritionOrderSupplement
FHIR NutritionOrderSupplement datatype record.
Fields
- Fields Included from *BackboneElement
- schedule Timing[]? - The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 of the nutritional supplement to be given.
- instruction string? - Free text or additional instructions or information pertaining to the oral supplement.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 nutritional supplement product required such as a high protein or pediatric clear liquid supplement.
- productName string? - The product or brand name of the nutritional supplement such as 'Acme Protein Shake'.
health.fhir.r4.international401: Observation
FHIR Observation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATION(default RESOURCE_NAME_OBSERVATION) - The type of the resource describes
- valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note Annotation[]? - Comments about the observation or the results.
- partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.
- subject Reference? - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focus
element or 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.
- effectiveTiming Timing? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method CodeableConcept? - Indicates the mechanism used to perform the observation.
- hasMember Reference[]? - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component ObservationComponent[]? - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- referenceRange ObservationReferenceRange[]? - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRange
elements would be used.
- valueString string? - The 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.
- effectiveInstant instant? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- status ObservationStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.international401: ObservationComponent
FHIR ObservationComponent 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.international401: ObservationDefinition
FHIR ObservationDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OBSERVATIONDEFINITION(default RESOURCE_NAME_OBSERVATIONDEFINITION) - The type of the resource describes
- identifier Identifier[]? - A unique identifier assigned to this ObservationDefinition artifact.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - Describes what will be observed. Sometimes this is called the observation 'name'.
- validCodedValueSet Reference? - The set of valid coded results for the observations conforming to this ObservationDefinition.
- method CodeableConcept? - The method or technique used to perform the observation.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- preferredReportName string? - The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
- multipleResultsAllowed boolean? - Multiple results allowed for observations conforming to this ObservationDefinition.
- permittedDataType ObservationDefinitionPermittedDataType[]? - The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
- criticalCodedValueSet Reference? - The set of critical coded results for the observation conforming to this ObservationDefinition.
- 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.
- normalCodedValueSet Reference? - The set of normal coded results for the observations conforming to this ObservationDefinition.
- 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.
- quantitativeDetails ObservationDefinitionQuantitativeDetails? - Characteristics for quantitative results of this observation.
- qualifiedInterval ObservationDefinitionQualifiedInterval[]? - Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- category CodeableConcept[]? - A code that classifies the general type of observation.
- abnormalCodedValueSet Reference? - The set of abnormal coded results for the observation conforming to this ObservationDefinition.
- Element... - Rest field
health.fhir.r4.international401: ObservationDefinitionQualifiedInterval
FHIR ObservationDefinitionQualifiedInterval datatype record.
Fields
- Fields Included from *BackboneElement
- gestationalAge Range? - The gestational age to which this reference range is applicable, in the context of pregnancy.
- condition string? - Text based condition for which the reference range is valid.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ObservationDefinitionQualifiedIntervalGender? - Sex of the population the range applies 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).
- context CodeableConcept? - Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.
- appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to.
- range Range? - The low and high values determining the interval. There may be only one of the two.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category ObservationDefinitionQualifiedIntervalCategory? - The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.
- 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.international401: ObservationDefinitionQuantitativeDetails
FHIR ObservationDefinitionQuantitativeDetails 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.
- unit CodeableConcept? - SI unit used to report quantitative results of observations conforming to this ObservationDefinition.
- conversionFactor decimal? - Factor for converting value expressed with SI unit to value expressed with customary unit.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- customaryUnit CodeableConcept? - Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- decimalPrecision integer? - Number of digits after decimal separator when the results of such observations are of type Quantity.
health.fhir.r4.international401: ObservationReferenceRange
FHIR ObservationReferenceRange 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.international401: OperationDefinition
FHIR OperationDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OPERATIONDEFINITION(default RESOURCE_NAME_OPERATIONDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
- 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 code - The name used to invoke the operation.
- instance boolean - Indicates whether this operation can be invoked on a particular instance of one of the given types.
- purpose markdown? - Explanation of why this operation definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the operation definition is intended to be used.
- 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 markdown? - A free text natural language description of the operation definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the operation definition.
- 'type boolean - Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 'parameter OperationDefinitionParameter[]? - The parameters for the operation/query.
- 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.
- 'resource code[]? - The types on which this operation can be executed.
- inputProfile canonical? - Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
- kind OperationDefinitionKind - Whether this is an operation or a named query.
- affectsState boolean? - Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
- 'version string? - The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- overload OperationDefinitionOverload[]? - Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
- url uri? - An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
- outputProfile canonical? - Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
- 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.
- system boolean - Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- name string - A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the operation definition.
- comment markdown? - Additional information about how to use this operation or named query.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.
- base canonical? - Indicates that this operation definition is a constraining profile on the base.
- status OperationDefinitionStatus - The status of this operation definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: OperationDefinitionOverload
FHIR OperationDefinitionOverload 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).
- comment string? - Comments to go on overload.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- parameterName string[]? - Name of parameter to include in overload.
health.fhir.r4.international401: OperationDefinitionParameter
FHIR OperationDefinitionParameter 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.
- max string - The maximum number of times this element is permitted to appear in the request or response.
- searchType OperationDefinitionParameterSearchType? - How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
- use OperationDefinitionParameterUse - Whether this is an input or an output parameter.
- documentation string? - Describes the meaning or use of this parameter.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- binding OperationDefinitionParameterBinding? - Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
- 'type code? - The type for this parameter.
- referencedFrom OperationDefinitionParameterReferencedFrom[]? - Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.
- min integer - The minimum number of times this parameter SHALL appear in the request or response.
- name code - The name of used to identify the parameter.
- targetProfile canonical[]? - Used when the type is 'Reference' or 'canonical', and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
- 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.international401: OperationDefinitionParameterBinding
FHIR OperationDefinitionParameterBinding 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.
- valueSet canonical - Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
- strength OperationDefinitionParameterBindingStrength - Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: OperationDefinitionParameterReferencedFrom
FHIR OperationDefinitionParameterReferencedFrom datatype record.
Fields
- Fields Included from *BackboneElement
- sourceId string? - The id of the element in the referencing resource that is expected to resolve to this resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- 'source string - The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.
health.fhir.r4.international401: Organization
FHIR Organization resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ORGANIZATION(default RESOURCE_NAME_ORGANIZATION) - 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 OrganizationContact[]? - Contact for the organization for a certain purpose.
- name string? - A name associated with the organization.
- alias string[]? - A list of alternate names that the organization is known as, or was known as in the past.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A contact detail for the organization.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- Element... - Rest field
health.fhir.r4.international401: OrganizationAffiliation
FHIR OrganizationAffiliation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ORGANIZATIONAFFILIATION(default RESOURCE_NAME_ORGANIZATIONAFFILIATION) - The type of the resource describes
- identifier Identifier[]? - Business identifiers that are specific to 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.
- period Period? - The period during which the participatingOrganization is affiliated with the primary organization.
- specialty CodeableConcept[]? - Specific specialty of the participatingOrganization in the context of the role.
- code CodeableConcept[]? - Definition of the role the participatingOrganization plays in the association.
- 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 organization affiliation record is in active use.
- language code? - The base language in which the resource is written.
- network Reference[]? - Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
- 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 this role.
- healthcareService Reference[]? - Healthcare services provided through the role.
- 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? - Organization where the role is available (primary organization/has members).
- 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.
- participatingOrganization Reference? - The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
- location Reference[]? - The location(s) at which the role occurs.
- telecom ContactPoint[]? - Contact details at the participatingOrganization relevant to this Affiliation.
- 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.international401: OrganizationContact
FHIR OrganizationContact 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.international401: Parameters
FHIR Parameters resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PARAMETERS(default RESOURCE_NAME_PARAMETERS) - The type of the resource describes
- 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.
- 'parameter ParametersParameter[]? - A parameter passed to or received from the operation.
- 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.
- language code? - The base language in which the resource is written.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- Element... - Rest field
health.fhir.r4.international401: ParametersParameter
FHIR ParametersParameter datatype record.
Fields
- Fields Included from *BackboneElement
- valueTime time? - If the parameter is a data type.
- valueTriggerDefinition TriggerDefinition? - If the parameter is a data type.
- valueMoney Money? - If the parameter is a data type.
- valueSignature Signature? - If the parameter is a data type.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueUuid uuid? - If the parameter is a data type.
- valueRatio Ratio? - If the parameter is a data type.
- valueParameterDefinition ParameterDefinition? - If the parameter is a data 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.
- valueInteger integer? - If the parameter is a data type.
- valueUnsignedInt unsignedInt? - If the parameter is a data type.
- valueQuantity Quantity? - If the parameter is a data type.
- valueCanonical canonical? - If the parameter is a data type.
- valueCount Count? - If the parameter is a data type.
- valueId id? - If the parameter is a data type.
- 'resource Resource? - If the parameter is a whole resource.
- valueCode code? - If the parameter is a data type.
- valueAddress Address? - If the parameter is a data type.
- valueContactPoint ContactPoint? - If the parameter is a data type.
- valuePeriod Period? - If the parameter is a data type.
- valueSampledData SampledData? - If the parameter is a data type.
- valueTiming Timing? - If the parameter is a data type.
- name string - The name of the parameter (reference to the operation definition).
- valueInstant instant? - If the parameter is a data type.
- valueAge Age? - If the parameter is a data type.
- valueDosage Dosage? - If the parameter is a data type.
- valueBase64Binary base64Binary? - If the parameter is a data type.
- valueBoolean boolean? - If the parameter is a data type.
- valueCoding Coding? - If the parameter is a data 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.
- valueIdentifier Identifier? - If the parameter is a data type.
- valueExpression Expression? - If the parameter is a data type.
- valueReference Reference? - If the parameter is a data type.
- valueRange Range? - If the parameter is a data type.
- valueUri uri? - If the parameter is a data type.
- valueDistance Distance? - If the parameter is a data type.
- valueUrl urlType? - If the parameter is a data type.
- valueContactDetail ContactDetail? - If the parameter is a data type.
- valueMeta Meta? - If the parameter is a data type.
- valueCodeableConcept CodeableConcept? - If the parameter is a data type.
- valueMarkdown markdown? - If the parameter is a data type.
- valueAttachment Attachment? - If the parameter is a data type.
- valueUsageContext UsageContext? - If the parameter is a data type.
- valueDateTime dateTime? - If the parameter is a data type.
- valueHumanName HumanName? - If the parameter is a data type.
- valueRelatedArtifact RelatedArtifact? - If the parameter is a data type.
- valueDecimal decimal? - If the parameter is a data type.
- valueDate date? - If the parameter is a data type.
- valueOid oid? - If the parameter is a data type.
- valueContributor Contributor? - If the parameter is a data type.
- valueString string? - If the parameter is a data type.
- valuePositiveInt positiveInt? - If the parameter is a data type.
- valueDuration Duration? - If the parameter is a data type.
- valueDataRequirement DataRequirement? - If the parameter is a data type.
- valueAnnotation Annotation? - If the parameter is a data type.
health.fhir.r4.international401: Patient
FHIR Patient resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PATIENT(default RESOURCE_NAME_PATIENT) - 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 PatientGender? - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- link PatientLink[]? - Link to another patient resource that concerns the same actual patient.
- language code? - The base language in which the resource is written.
- contact PatientContact[]? - A contact party (e.g. guardian, partner, friend) for the patient.
- deceasedDateTime dateTime? - Indicates if the individual is deceased or not.
- generalPractitioner Reference[]? - Patient's nominated care provider.
- telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- communication PatientCommunication[]? - A language which may be used to communicate with the patient about his or her health.
- identifier Identifier[]? - An identifier for this patient.
- address Address[]? - An address for the individual.
- multipleBirthBoolean boolean? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- active boolean? - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- photo Attachment[]? - Image of the patient.
- birthDate date? - The date of birth for the individual.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- deceasedBoolean boolean? - Indicates if the individual is deceased or not.
- managingOrganization Reference? - Organization that is the custodian of the patient record.
- 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 HumanName[]? - A name associated with the individual.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- maritalStatus CodeableConcept? - This field contains a patient's most recent marital (civil) status.
- Element... - Rest field
health.fhir.r4.international401: PatientCommunication
FHIR PatientCommunication 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.international401: PatientContact
FHIR PatientContact 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 PatientContactGender? - Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- organization Reference? - Organization on behalf of which the contact is acting or for which the contact is working.
- name HumanName? - A name associated with the contact person.
- telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- relationship CodeableConcept[]? - The nature of the relationship between the patient and the contact person.
health.fhir.r4.international401: PatientLink
FHIR PatientLink 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 PatientLinkType - The type of link between this patient resource and another patient resource.
health.fhir.r4.international401: PaymentNotice
FHIR PaymentNotice resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PAYMENTNOTICE(default RESOURCE_NAME_PAYMENTNOTICE) - The type of the resource describes
- identifier Identifier[]? - A unique identifier assigned to this payment notice.
- request Reference? - Reference of resource for which payment is being made.
- amount Money - The amount sent to the payee.
- 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.
- created dateTime - The date when this resource was created.
- 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.
- payee Reference? - The party who will receive or has received payment that is the subject of this notification.
- 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.
- provider Reference? - The practitioner who is responsible for the services rendered to 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.
- response Reference? - Reference of response to resource for which payment is being made.
- recipient Reference - The party who is notified of the payment status.
- 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.
- payment Reference - A reference to the payment which is the subject of this notice.
- 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.
- paymentDate date? - The date when the above payment action occurred.
- paymentStatus CodeableConcept? - A code indicating whether payment has been sent or cleared.
- status PaymentNoticeStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: PaymentReconciliation
FHIR PaymentReconciliation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PAYMENTRECONCILIATION(default RESOURCE_NAME_PAYMENTRECONCILIATION) - The type of the resource describes
- identifier Identifier[]? - A unique identifier assigned to this payment reconciliation.
- request Reference? - Original request resource reference.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period of time for which payments have been gathered into this bulk payment for settlement.
- formCode CodeableConcept? - A code for the form to be used for printing the content.
- created dateTime - The date when the resource was created.
- 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.
- paymentAmount Money - Total payment amount as indicated on the financial instrument.
- processNote PaymentReconciliationProcessNote[]? - A note that describes or explains the processing in a human readable form.
- requestor Reference? - The practitioner who is responsible for the services rendered to the patient.
- paymentIssuer Reference? - The party who generated the payment.
- 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.
- disposition string? - A human readable description of the status of the request for the reconciliation.
- paymentIdentifier Identifier? - Issuer's unique identifier for the payment instrument.
- 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.
- detail PaymentReconciliationDetail[]? - Distribution of the payment amount for a previously acknowledged payable.
- 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.
- paymentDate date - The date of payment as indicated on the financial instrument.
- outcome PaymentReconciliationOutcome? - The outcome of a request for a reconciliation.
- status PaymentReconciliationStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: PaymentReconciliationDetail
FHIR PaymentReconciliationDetail datatype record.
Fields
- Fields Included from *BackboneElement
- date date? - The date from the response resource containing a commitment to pay.
- identifier Identifier? - Unique identifier for the current payment item for the referenced payable.
- request Reference? - A resource, such as a Claim, the evaluation of which could lead to payment.
- submitter Reference? - The party which submitted the claim or financial transaction.
- amount Money? - The monetary amount allocated from the total payment to the payable.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- predecessor Identifier? - Unique identifier for the prior payment item for the referenced payable.
- 'type CodeableConcept - Code to indicate the nature of the payment.
- payee Reference? - The party which is receiving the payment.
- response Reference? - A resource, such as a ClaimResponse, which contains a commitment to payment.
- responsible Reference? - A reference to the individual who is responsible for inquiries regarding the response and its payment.
- 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.international401: PaymentReconciliationProcessNote
FHIR PaymentReconciliationProcessNote 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.
- text string? - The explanation or description associated with the processing.
- 'type PaymentReconciliationProcessNoteType? - The business purpose of the note text.
health.fhir.r4.international401: Person
FHIR Person resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PERSON(default RESOURCE_NAME_PERSON) - The type of the resource describes
- identifier Identifier[]? - Identifier for a person within a particular scope.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- address Address[]? - One or more addresses for the person.
- gender PersonGender? - Administrative Gender.
- 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 PersonLink[]? - Link to a resource that concerns the same actual person.
- active boolean? - Whether this person's record is in active use.
- photo Attachment? - An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
- language code? - The base language in which the resource is written.
- birthDate date? - The birth date for the person.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- managingOrganization Reference? - The organization that is the custodian of the person 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.
- name HumanName[]? - A name associated with the person.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- Element... - Rest field
health.fhir.r4.international401: PersonLink
FHIR PersonLink datatype record.
Fields
- Fields Included from *BackboneElement
- assurance PersonLinkAssurance? - Level of assurance that this link is associated with the target resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- target Reference - The resource to which this actual person is associated.
health.fhir.r4.international401: PlanDefinition
FHIR PlanDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PLANDEFINITION(default RESOURCE_NAME_PLANDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
- copyright markdown? - A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the plan definition.
- purpose markdown? - Explanation of why this plan definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the plan definition is intended to be used.
- 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).
- usage string? - A detailed description of how the plan definition is used from a clinical perspective.
- description markdown? - A free text natural language description of the plan definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the plan definition.
- 'type CodeableConcept? - A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
- library canonical[]? - A reference to a Library resource containing any formal logic used by the plan definition.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- action PlanDefinitionAction[]? - An action or group of actions to be taken as part of the plan.
- 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.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- goal PlanDefinitionGoal[]? - Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the plan definition content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- subjectReference Reference? - A code or group definition that describes the intended subject of the plan definition.
- 'version string? - The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- url uri? - An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the plan definition giving additional information about its content.
- name string? - A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the plan definition.
- topic CodeableConcept[]? - Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
- status PlanDefinitionStatus - The status of this plan definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: PlanDefinitionAction
FHIR PlanDefinitionAction datatype record.
Fields
- Fields Included from *BackboneElement
- reason CodeableConcept[]? - A description of why this action is necessary or appropriate.
- cardinalityBehavior PlanDefinitionActionCardinalityBehavior? - Defines whether the action can be selected multiple times.
- definitionCanonical canonical? - A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept[]? - A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
- goalId id[]? - Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
- subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the action and its children, if any.
- prefix string? - A user-visible prefix for the action.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 brief description of the action used to provide a summary to display to the user.
- definitionUri uri? - A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
- title string? - The title of the action displayed to a user.
- 'type CodeableConcept? - The type of action to perform (create, update, remove).
- groupingBehavior PlanDefinitionActionGroupingBehavior? - Defines the grouping behavior for the action and its children.
- participant PlanDefinitionActionParticipant[]? - Indicates who should participate in performing the action described.
- output DataRequirement[]? - Defines the outputs of the action, if any.
- transform canonical? - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
- dynamicValue PlanDefinitionActionDynamicValue[]? - Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
- timingAge Age? - An optional value describing when the action should be performed.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- relatedAction PlanDefinitionActionRelatedAction[]? - A relationship to another action such as 'before' or '30-60 minutes after start of'.
- timingDuration Duration? - An optional value describing when the action should be performed.
- textEquivalent string? - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
- timingTiming Timing? - An optional value describing when the action should be performed.
- timingPeriod Period? - An optional value describing when the action should be performed.
- documentation RelatedArtifact[]? - Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
- trigger TriggerDefinition[]? - A description of when the action should be triggered.
- priority PlanDefinitionActionPriority? - Indicates how quickly the action should be addressed with respect to other actions.
- subjectReference Reference? - A code or group definition that describes the intended subject of the action and its children, if any.
- input DataRequirement[]? - Defines input data requirements for the action.
- requiredBehavior PlanDefinitionActionRequiredBehavior? - Defines the required behavior for the action.
- condition PlanDefinitionActionCondition[]? - An expression that describes applicability criteria or start/stop conditions for the action.
- selectionBehavior PlanDefinitionActionSelectionBehavior? - Defines the selection behavior for the action and its children.
- timingRange Range? - An optional value describing when the action should be performed.
- precheckBehavior PlanDefinitionActionPrecheckBehavior? - Defines whether the action should usually be preselected.
- timingDateTime dateTime? - An optional value describing when the action should be performed.
health.fhir.r4.international401: PlanDefinitionActionCondition
FHIR PlanDefinitionActionCondition 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.
- expression Expression? - An expression that returns true or false, indicating whether the condition is satisfied.
- kind PlanDefinitionActionConditionKind - The kind of 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).
- 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.international401: PlanDefinitionActionDynamicValue
FHIR PlanDefinitionActionDynamicValue datatype record.
Fields
- Fields Included from *BackboneElement
- path string? - The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- expression Expression? - An expression specifying the value of the customized element.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: PlanDefinitionActionParticipant
FHIR PlanDefinitionActionParticipant 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.
- role CodeableConcept? - The role the participant should play in performing the described action.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 PlanDefinitionActionParticipantType - The type of participant in the action.
health.fhir.r4.international401: PlanDefinitionActionRelatedAction
FHIR PlanDefinitionActionRelatedAction datatype record.
Fields
- Fields Included from *BackboneElement
- offsetPlanDefinitionRange Range? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- offsetPlanDefinitionDuration Duration? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- actionId id - The element id of the related action.
- 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 PlanDefinitionActionRelatedActionRelationship - The relationship of this action to the related action.
health.fhir.r4.international401: PlanDefinitionGoal
FHIR PlanDefinitionGoal datatype record.
Fields
- Fields Included from *BackboneElement
- addresses CodeableConcept[]? - Identifies problems, conditions, issues, or concerns the goal is intended to address.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- documentation RelatedArtifact[]? - Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'start CodeableConcept? - The event after which the goal should begin being pursued.
- description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- category CodeableConcept? - Indicates a category the goal falls within.
- priority CodeableConcept? - Identifies the expected level of importance associated with reaching/sustaining the defined goal.
- target PlanDefinitionGoalTarget[]? - Indicates what should be done and within what timeframe.
health.fhir.r4.international401: PlanDefinitionGoalTarget
FHIR PlanDefinitionGoalTarget datatype record.
Fields
- Fields Included from *BackboneElement
- detailPlanDefinitionCodeableConcept CodeableConcept? - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- measure CodeableConcept? - The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
- due Duration? - Indicates the timeframe after the start of the goal in which the goal should be met.
- detailPlanDefinitionQuantity Quantity? - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- detailPlanDefinitionRange Range? - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
health.fhir.r4.international401: Practitioner
FHIR Practitioner resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PRACTITIONER(default RESOURCE_NAME_PRACTITIONER) - 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 PractitionerGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active boolean? - Whether this practitioner's record is in active use.
- photo Attachment[]? - Image of the person.
- language code? - The base language in which the resource is written.
- birthDate date? - The date of birth for the practitioner.
- qualification PractitionerQualification[]? - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- 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 HumanName[]? - The name(s) associated with the practitioner.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A contact detail for the practitioner, e.g. a telephone number or an email address.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- communication CodeableConcept[]? - A language the practitioner can use in patient communication.
- Element... - Rest field
health.fhir.r4.international401: PractitionerQualification
FHIR PractitionerQualification 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.international401: PractitionerRole
FHIR PractitionerRole resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PRACTITIONERROLE(default RESOURCE_NAME_PRACTITIONERROLE) - The type of the resource describes
- identifier Identifier[]? - Business Identifiers that are specific to a role/location.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
- specialty CodeableConcept[]? - Specific specialty of the practitioner.
- code CodeableConcept[]? - Roles which this practitioner is authorized to perform for the organization.
- practitioner Reference? - Practitioner that is able to provide the defined services for the organization.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active boolean? - Whether this practitioner role record is in active use.
- language code? - The base language in which the resource is written.
- notAvailable PractitionerRoleNotAvailable[]? - The practitioner is not available or performing this role during this period of time due to the provided reason.
- availableTime PractitionerRoleAvailableTime[]? - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the practitioner with this role.
- healthcareService Reference[]? - The list of healthcare services that this worker provides for this role's Organization/Location(s).
- 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.international401: PractitionerRoleAvailableTime
FHIR PractitionerRoleAvailableTime 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 PractitionerRoleAvailableTimeDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.
- availableStartTime time? - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
health.fhir.r4.international401: PractitionerRoleNotAvailable
FHIR PractitionerRoleNotAvailable 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.international401: Procedure
FHIR Procedure resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PROCEDURE(default RESOURCE_NAME_PROCEDURE) - The type of the resource describes
- note Annotation[]? - Any other notes and comments about the procedure.
- partOf Reference[]? - A larger event of which this particular procedure is a component or step.
- complication CodeableConcept[]? - Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy').
- subject Reference - The person, animal or group on which the procedure was performed.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - The justification of why the procedure was performed.
- language code? - The base language in which the resource is written.
- performedRange Range? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performedAge Age? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- performedPeriod Period? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performedString string? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- followUp CodeableConcept[]? - If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
- statusReason CodeableConcept? - Captures the reason for the current state of the procedure.
- usedCode CodeableConcept[]? - Identifies coded items that were used as part of the procedure.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- performedDateTime dateTime? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- basedOn Reference[]? - A reference to a resource that contains details of the request for this procedure.
- outcome CodeableConcept? - The outcome of the procedure - did it resolve the reasons for the procedure being performed?
- identifier Identifier[]? - Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
- recorder Reference? - Individual who recorded the record and takes responsibility for its content.
- complicationDetail Reference[]? - Any complications that occurred during the procedure, or in the immediate post-performance period.
- performer ProcedurePerformer[]? - Limited to 'real' people rather than equipment.
- usedReference Reference[]? - Identifies medications, devices and any other substance used as part of the procedure.
- focalDevice ProcedureFocalDevice[]? - A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
- encounter Reference? - The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- bodySite CodeableConcept[]? - Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- asserter Reference? - Individual who is making the procedure statement.
- 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 ProcedureStatus - A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
- Element... - Rest field
health.fhir.r4.international401: ProcedureFocalDevice
FHIR ProcedureFocalDevice 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.international401: ProcedurePerformer
FHIR ProcedurePerformer 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.international401: Provenance
FHIR Provenance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_PROVENANCE(default RESOURCE_NAME_PROVENANCE) - The type of the resource describes
- reason CodeableConcept[]? - The reason that the activity was taking place.
- agent ProvenanceAgent[] - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- activity CodeableConcept? - An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
- signature Signature[]? - A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- occurredPeriod Period? - The period during which the activity occurred.
- recorded instant - The instant of time at which the activity was recorded.
- target Reference[] - The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location Reference? - Where the activity occurred, if relevant.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- entity ProvenanceEntity[]? - An entity used in this activity.
- occurredDateTime dateTime? - The period during which the activity occurred.
- policy uri[]? - Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
- Element... - Rest field
health.fhir.r4.international401: ProvenanceAgent
FHIR ProvenanceAgent 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.
- role CodeableConcept[]? - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- onBehalfOf Reference? - The individual, device, or organization for whom the change was made.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept? - The participation the agent had with respect to the activity.
- who Reference - The individual, device or organization that participated in the event.
health.fhir.r4.international401: ProvenanceEntity
FHIR ProvenanceEntity 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.
- role ProvenanceEntityRole - How the entity was used during the activity.
- what Reference - Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: Questionnaire
FHIR Questionnaire resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_QUESTIONNAIRE(default RESOURCE_NAME_QUESTIONNAIRE) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
- copyright markdown? - A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- code Coding[]? - An identifier for this question or group of questions in a particular terminology such as LOINC.
- purpose markdown? - Explanation of why this questionnaire is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the questionnaire is intended to be used.
- 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 markdown? - A free text natural language description of the questionnaire from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the questionnaire.
- subjectType code[]? - The types of subjects that can be the subject of responses created for the questionnaire.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- derivedFrom canonical[]? - The URL of a Questionnaire that this Questionnaire is based on.
- 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[]? - A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
- item QuestionnaireItem[]? - A particular question, question grouping or display text that is part of the questionnaire.
- effectivePeriod Period? - The period during which the questionnaire content was or is planned to be in active use.
- 'version string? - The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- name string? - A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the questionnaire.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
- status QuestionnaireStatus - The status of this questionnaire. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: QuestionnaireItem
FHIR QuestionnaireItem datatype record.
Fields
- Fields Included from *BackboneElement
- repeats boolean? - An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 Coding[]? - A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
- enableWhen QuestionnaireItemEnableWhen[]? - A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
- initial QuestionnaireItemInitial[]? - One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
- prefix string? - A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- readOnly boolean? - An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
- 'type QuestionnaireItemType - The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).
- required boolean? - An indication, if true, that the item must be present in a 'completed' QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
- linkId string - An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
- definition uri? - This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding) * options (ElementDefinition.binding).
- enableBehavior QuestionnaireItemEnableBehavior? - Controls how multiple enableWhen values are interpreted - whether all or any must be true.
- 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? - The name of a section, the text of a question or text content for a display item.
- answerOption QuestionnaireItemAnswerOption[]? - One of the permitted answers for a 'choice' or 'open-choice' question.
- answerValueSet canonical? - A reference to a value set containing a list of codes representing permitted answers for a 'choice' or 'open-choice' question.
- maxLength integer? - The maximum number of characters that are permitted in the answer to be considered a 'valid' QuestionnaireResponse.
health.fhir.r4.international401: QuestionnaireItemAnswerOption
FHIR QuestionnaireItemAnswerOption 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.
- valueQuestionnaireCoding Coding - A potential answer that's allowed as the answer to this question.
- initialSelected boolean? - Indicates whether the answer value is selected when the list of possible answers is initially shown.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- valueQuestionnaireInteger integer - A potential answer that's allowed as the answer to this question.
- valueQuestionnaireString string - A potential answer that's allowed as the answer to this question.
- valueQuestionnaireDate date - A potential answer that's allowed as the answer to this question.
- valueQuestionnaireTime time - A potential answer that's allowed as the answer to this question.
- valueQuestionnaireReference Reference - A potential answer that's allowed as the answer to this question.
health.fhir.r4.international401: QuestionnaireItemEnableWhen
FHIR QuestionnaireItemEnableWhen datatype record.
Fields
- Fields Included from *BackboneElement
- answerQuestionnaireReference Reference - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- answerQuestionnaireDate date - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- question string - The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
- answerQuestionnaireDecimal decimal - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- answerQuestionnaireTime time - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- answerQuestionnaireString string - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- answerQuestionnaireCoding Coding - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- answerQuestionnaireInteger integer - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- answerQuestionnaireQuantity Quantity - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- operator QuestionnaireItemEnableWhenOperator - Specifies the criteria by which the question is enabled.
- answerQuestionnaireDateTime dateTime - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- answerQuestionnaireBoolean boolean - A value that the referenced question is tested using the specified operator in order for the item to be enabled.
- 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.international401: QuestionnaireItemInitial
FHIR QuestionnaireItemInitial 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.
- valueQuestionnaireCoding Coding - The actual value to for an initial answer.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueQuestionnaireUri uri - The actual value to for an initial answer.
- valueQuestionnaireBoolean boolean - The actual value to for an initial answer.
- valueQuestionnaireAttachment Attachment - The actual value to for an initial answer.
- valueQuestionnaireReference Reference - The actual value to for an initial answer.
- valueQuestionnaireDecimal decimal - The actual value to for an initial answer.
- valueQuestionnaireDateTime dateTime - The actual value to for an initial answer.
- valueQuestionnaireQuantity Quantity - The actual value to for an initial answer.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueQuestionnaireInteger integer - The actual value to for an initial answer.
- valueQuestionnaireString string - The actual value to for an initial answer.
- valueQuestionnaireDate date - The actual value to for an initial answer.
- valueQuestionnaireTime time - The actual value to for an initial answer.
health.fhir.r4.international401: QuestionnaireResponse
FHIR QuestionnaireResponse resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_QUESTIONNAIRERESPONSE(default RESOURCE_NAME_QUESTIONNAIRERESPONSE) - The type of the resource describes
- authored dateTime? - The date and/or time that this set of answers were last changed.
- identifier Identifier? - A business identifier assigned to a particular completed (or partially completed) questionnaire.
- partOf Reference[]? - A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
- extension Extension[]? - 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.
- item QuestionnaireResponseItem[]? - A group or question item from the original questionnaire for which answers are provided.
- questionnaire canonical? - The Questionnaire that defines and organizes the questions for which answers are being provided.
- author Reference? - Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
- subject Reference? - The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- encounter Reference? - The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
- 'source Reference? - The person who answered the questions about the subject.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta 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.
- basedOn Reference[]? - The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
- status QuestionnaireResponseStatus - The position of the questionnaire response within its overall lifecycle.
- Element... - Rest field
health.fhir.r4.international401: QuestionnaireResponseItem
FHIR QuestionnaireResponseItem 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.
- linkId string - The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
- answer QuestionnaireResponseItemAnswer[]? - The respondent's answer(s) to the question.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- definition uri? - A reference to an ElementDefinition that provides the details for the item.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - Text that is displayed above the contents of the group or as the text of the question being answered.
health.fhir.r4.international401: QuestionnaireResponseItemAnswer
FHIR QuestionnaireResponseItemAnswer datatype record.
Fields
- Fields Included from *BackboneElement
- valueQuestionnaireResponseReference Reference? - The answer (or one of the answers) provided by the respondent to the question.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueQuestionnaireResponseAttachment Attachment? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseTime time? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseQuantity Quantity? - The answer (or one of the answers) provided by the respondent to the question.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueQuestionnaireResponseBoolean boolean? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseString string? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseUri uri? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseCoding Coding? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseDecimal decimal? - The answer (or one of the answers) provided by the respondent to the question.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueQuestionnaireResponseInteger integer? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseDate date? - The answer (or one of the answers) provided by the respondent to the question.
- valueQuestionnaireResponseDateTime dateTime? - The answer (or one of the answers) provided by the respondent to the question.
health.fhir.r4.international401: RelatedPerson
FHIR RelatedPerson resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RELATEDPERSON(default RESOURCE_NAME_RELATEDPERSON) - The type of the resource describes
- identifier Identifier[]? - Identifier for a person within a particular scope.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
- address Address[]? - Address where the related person can be contacted or visited.
- gender RelatedPersonGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active boolean? - Whether this related person record is in active use.
- photo Attachment[]? - Image of the person.
- language code? - The base language in which the resource is written.
- birthDate date? - The date on which the related person was born.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - The patient this person is related to.
- name HumanName[]? - A name associated with the person.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- communication RelatedPersonCommunication[]? - A language which may be used to communicate with about the patient's health.
- relationship CodeableConcept[]? - The nature of the relationship between a patient and the related person.
- Element... - Rest field
health.fhir.r4.international401: RelatedPersonCommunication
FHIR RelatedPersonCommunication 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.international401: RequestGroup
FHIR RequestGroup resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_REQUESTGROUP(default RESOURCE_NAME_REQUESTGROUP) - The type of the resource describes
- note Annotation[]? - Provides a mechanism to communicate additional information about the response.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code that identifies what the overall request group is.
- subject Reference? - The subject for which the request group was created.
- 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 request group.
- language code? - The base language in which the resource is written.
- instantiatesUri uri[]? - A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
- action RequestGroupAction[]? - The actions, if any, produced by the evaluation of the artifact.
- 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 the reason for the request group 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.
- basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this request.
- identifier Identifier[]? - Allows a service to provide a unique, business identifier for the request.
- authoredOn dateTime? - Indicates when the request group was created.
- author Reference? - Provides a reference to the author of the request group.
- replaces Reference[]? - Completed or terminated request(s) whose function is taken by this new request.
- encounter Reference? - Describes the context of the request group, if any.
- instantiatesCanonical canonical[]? - A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
- priority RequestGroupPriority? - Indicates how quickly the request should be addressed with respect to other requests.
- intent RequestGroupIntent - Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- 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, prescription or similar form.
- status RequestGroupStatus - The current state of the request. For request groups, the status reflects the status of all the requests in the group.
- Element... - Rest field
health.fhir.r4.international401: RequestGroupAction
FHIR RequestGroupAction datatype record.
Fields
- Fields Included from *BackboneElement
- cardinalityBehavior RequestGroupActionCardinalityBehavior? - Defines whether the action can be selected multiple times.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept[]? - A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.
- prefix string? - A user-visible prefix for the action.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 short description of the action used to provide a summary to display to the user.
- title string? - The title of the action displayed to a user.
- 'type CodeableConcept? - The type of action to perform (create, update, remove).
- groupingBehavior RequestGroupActionGroupingBehavior? - Defines the grouping behavior for the action and its children.
- participant Reference[]? - The participant that should perform or be responsible for this action.
- timingAge Age? - An optional value describing when the action should be performed.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- relatedAction RequestGroupActionRelatedAction[]? - A relationship to another action such as 'before' or '30-60 minutes after start of'.
- timingDuration Duration? - An optional value describing when the action should be performed.
- textEquivalent string? - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
- timingTiming Timing? - An optional value describing when the action should be performed.
- 'resource Reference? - The resource that is the target of the action (e.g. CommunicationRequest).
- timingPeriod Period? - An optional value describing when the action should be performed.
- documentation RelatedArtifact[]? - Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
- priority RequestGroupActionPriority? - Indicates how quickly the action should be addressed with respect to other actions.
- requiredBehavior RequestGroupActionRequiredBehavior? - Defines expectations around whether an action is required.
- condition RequestGroupActionCondition[]? - An expression that describes applicability criteria, or start/stop conditions for the action.
- selectionBehavior RequestGroupActionSelectionBehavior? - Defines the selection behavior for the action and its children.
- timingRange Range? - An optional value describing when the action should be performed.
- precheckBehavior RequestGroupActionPrecheckBehavior? - Defines whether the action should usually be preselected.
- timingDateTime dateTime? - An optional value describing when the action should be performed.
health.fhir.r4.international401: RequestGroupActionCondition
FHIR RequestGroupActionCondition 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.
- expression Expression? - An expression that returns true or false, indicating whether or not the condition is satisfied.
- kind RequestGroupActionConditionKind - The kind of 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).
- 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.international401: RequestGroupActionRelatedAction
FHIR RequestGroupActionRelatedAction 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.
- offsetRequestGroupDuration Duration? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- actionId id - The element id of the action this is related to.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- offsetRequestGroupRange Range? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
- relationship RequestGroupActionRelatedActionRelationship - The relationship of this action to the related action.
health.fhir.r4.international401: ResearchDefinition
FHIR ResearchDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RESEARCHDEFINITION(default RESOURCE_NAME_RESEARCHDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.
- copyright markdown? - A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- subjectCodeableConcept CodeableConcept? - The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.
- purpose markdown? - Explanation of why this research definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the research definition is intended to be used.
- 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).
- usage string? - A detailed description, from a clinical perspective, of how the ResearchDefinition is used.
- description markdown? - A free text natural language description of the research definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- shortTitle string? - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
- title string? - A short, descriptive, user-friendly title for the research definition.
- exposureAlternative Reference? - A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.
- library canonical[]? - A reference to a Library resource containing the formal logic used by the ResearchDefinition.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- outcome Reference? - A reference to a ResearchElementDefinition resomece that defines the outcome for the research.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the research definition content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- subjectReference Reference? - The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.
- 'version string? - The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- url uri? - An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.
- population Reference - A reference to a ResearchElementDefinition resource that defines the population for the research.
- 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.
- exposure Reference? - A reference to a ResearchElementDefinition resource that defines the exposure for the research.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the ResearchDefinition giving additional information about its content.
- name string? - A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the research definition.
- topic CodeableConcept[]? - Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.
- comment string[]? - A human-readable string to clarify or explain concepts about the resource.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.
- status ResearchDefinitionStatus - The status of this research definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: ResearchElementDefinition
FHIR ResearchElementDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RESEARCHELEMENTDEFINITION(default RESOURCE_NAME_RESEARCHELEMENTDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.
- copyright markdown? - A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- subjectCodeableConcept CodeableConcept? - The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.
- purpose markdown? - Explanation of why this research element definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the research element definition is intended to be used.
- 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).
- usage string? - A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.
- description markdown? - A free text natural language description of the research element definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- shortTitle string? - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
- title string? - A short, descriptive, user-friendly title for the research element definition.
- 'type ResearchElementDefinitionType - The type of research element, a population, an exposure, or an outcome.
- characteristic ResearchElementDefinitionCharacteristic[] - A characteristic that defines the members of the research element. Multiple characteristics are applied with 'and' semantics.
- variableType ResearchElementDefinitionVariableType? - The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).
- library canonical[]? - A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the research element definition content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- subjectReference Reference? - The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.
- 'version string? - The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
- url uri? - An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.
- 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.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- subtitle string? - An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.
- name string? - A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the research element definition.
- topic CodeableConcept[]? - Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.
- comment string[]? - A human-readable string to clarify or explain concepts about the resource.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.
- status ResearchElementDefinitionStatus - The status of this research element definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: ResearchElementDefinitionCharacteristic
FHIR ResearchElementDefinitionCharacteristic datatype record.
Fields
- Fields Included from *BackboneElement
- participantEffectiveTiming Timing? - Indicates what effective period the study covers.
- studyEffectivePeriod Period? - Indicates what effective period the study covers.
- definitionCodeableConcept CodeableConcept - Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- participantEffectivePeriod Period? - Indicates what effective period the study covers.
- studyEffectiveTiming Timing? - Indicates what effective period the study covers.
- usageContext UsageContext[]? - Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.
- definitionCanonical canonical - Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- unitOfMeasure CodeableConcept? - Specifies the UCUM unit for the outcome.
- definitionDataRequirement DataRequirement - Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- participantEffectiveDateTime dateTime? - Indicates what effective period the study covers.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- studyEffectiveDuration Duration? - Indicates what effective period the study covers.
- studyEffectiveDateTime dateTime? - Indicates what effective period the study covers.
- studyEffectiveTimeFromStart Duration? - Indicates duration from the study initiation.
- participantEffectiveGroupMeasure ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure? - Indicates how elements are aggregated within the study effective period.
- studyEffectiveGroupMeasure ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure? - Indicates how elements are aggregated within the study effective period.
- definitionExpression Expression - Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
- studyEffectiveDescription string? - A narrative description of the time period the study covers.
- exclude boolean? - When true, members with this characteristic are excluded from the element.
- participantEffectiveDuration Duration? - Indicates what effective period the study covers.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- participantEffectiveTimeFromStart Duration? - Indicates duration from the participant's study entry.
- participantEffectiveDescription string? - A narrative description of the time period the study covers.
health.fhir.r4.international401: ResearchStudy
FHIR ResearchStudy resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RESEARCHSTUDY(default RESOURCE_NAME_RESEARCHSTUDY) - The type of the resource describes
- note Annotation[]? - Comments made about the study by the performer, subject or other participants.
- partOf Reference[]? - A larger research study of which this particular study is a component or step.
- sponsor Reference? - An organization that initiates the investigation and is legally responsible for the study.
- 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.
- reasonStopped CodeableConcept? - A description and/or code explaining the premature termination of the 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 markdown? - A full description of how the study is being conducted.
- focus CodeableConcept[]? - The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
- primaryPurposeType CodeableConcept? - The type of study based upon the intent of the study's activities. A classification of the intent of the study.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive user-friendly label for the study.
- objective ResearchStudyObjective[]? - A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.
- protocol Reference[]? - The set of steps expected to be performed as part of the execution of the study.
- contact ContactDetail[]? - Contact details to assist a user in learning more about or engaging with the study.
- 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.
- keyword CodeableConcept[]? - Key terms to aid in searching for or filtering the study.
- arm ResearchStudyArm[]? - Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
- principalInvestigator Reference? - A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
- phase CodeableConcept? - The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
- identifier Identifier[]? - Identifiers assigned to this research study by the sponsor or other systems.
- period Period? - Identifies the start date and the expected (or actual, depending on status) end date for the study.
- relatedArtifact RelatedArtifact[]? - Citations, references and other related documents.
- enrollment Reference[]? - Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ' 200 female Europeans between the ages of 20 and 45 with early onset diabetes'.
- condition CodeableConcept[]? - The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion 'healthy volunteer', but the target condition code would be a Lupus SNOMED code.
- 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 Reference[]? - A facility in which study activities are conducted.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- location CodeableConcept[]? - Indicates a country, state or other region where the study is taking place.
- category CodeableConcept[]? - Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
- status ResearchStudyStatus - The current state of the study.
- Element... - Rest field
health.fhir.r4.international401: ResearchStudyArm
FHIR ResearchStudyArm 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 - Unique, human-readable label for this arm of the study.
- description string? - A succinct description of the path through the study that would be followed by a subject adhering to this arm.
- 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? - Categorization of study arm, e.g. experimental, active comparator, placebo comparater.
health.fhir.r4.international401: ResearchStudyObjective
FHIR ResearchStudyObjective 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? - Unique, human-readable label for this objective of the study.
- 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 study objective.
health.fhir.r4.international401: ResearchSubject
FHIR ResearchSubject resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RESEARCHSUBJECT(default RESOURCE_NAME_RESEARCHSUBJECT) - The type of the resource describes
- identifier Identifier[]? - Identifiers assigned to this research subject for a study.
- 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 dates the subject began and ended their participation in the study.
- study Reference - Reference to the study the subject is participating in.
- individual Reference - The record of the person or animal who is involved in the 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).
- language code? - The base language in which the resource is written.
- actualArm string? - The name of the arm in the study the subject actually followed as part of this study.
- consent Reference? - A record of the patient's informed agreement to participate in the study.
- 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.
- assignedArm string? - The name of the arm in the study the subject is expected to follow as part of this study.
- status ResearchSubjectStatus - The current state of the subject.
- Element... - Rest field
health.fhir.r4.international401: RiskAssessment
FHIR RiskAssessment resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RISKASSESSMENT(default RESOURCE_NAME_RISKASSESSMENT) - The type of the resource describes
- note Annotation[]? - Additional comments about the risk assessment.
- parent Reference? - A reference to a resource that this risk assessment is part of, such as a Procedure.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - The type of the risk assessment performed.
- subject Reference - The patient or group the risk assessment applies to.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Resources supporting the reason the risk assessment was performed.
- language code? - The base language in which the resource is written.
- 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 the risk assessment was performed.
- 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 reference to the request that is fulfilled by this risk assessment.
- identifier Identifier[]? - Business identifier assigned to the risk assessment.
- mitigation string? - A description of the steps that might be taken to reduce the identified risk(s).
- performer Reference? - The provider or software application that performed the assessment.
- method CodeableConcept? - The algorithm, process or mechanism used to evaluate the risk.
- encounter Reference? - The encounter where the assessment was performed.
- basis Reference[]? - Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
- condition Reference? - For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - The date (and possibly time) the risk assessment was performed.
- 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.
- prediction RiskAssessmentPrediction[]? - Describes the expected outcome for the subject.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - The date (and possibly time) the risk assessment was performed.
- status RiskAssessmentStatus - The status of the RiskAssessment, using the same statuses as an Observation.
- Element... - Rest field
health.fhir.r4.international401: RiskAssessmentPrediction
FHIR RiskAssessmentPrediction 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.
- qualitativeRisk CodeableConcept? - Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).
- relativeRisk decimal? - Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).
- probabilityRange Range? - Indicates how likely the outcome is (in the specified timeframe).
- whenPeriod Period? - Indicates the period of time or age range of the subject to which the specified probability applies.
- whenRange Range? - Indicates the period of time or age range of the subject to which the specified probability applies.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- probabilityDecimal decimal? - Indicates how likely the outcome is (in the specified timeframe).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- rationale string? - Additional information explaining the basis for the prediction.
- outcome CodeableConcept? - One of the potential outcomes for the patient (e.g. remission, death, a particular condition).
health.fhir.r4.international401: RiskEvidenceSynthesis
FHIR RiskEvidenceSynthesis resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_RISKEVIDENCESYNTHESIS(default RESOURCE_NAME_RISKEVIDENCESYNTHESIS) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the risk evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the risk evidence synthesis changes.
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- copyright markdown? - A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the risk evidence synthesis is intended to be used.
- 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 markdown? - A free text natural language description of the risk evidence synthesis from a consumer's perspective.
- language code? - The base language in which the resource is written.
- sampleSize RiskEvidenceSynthesisSampleSize? - A description of the size of the sample involved in the synthesis.
- title string? - A short, descriptive, user-friendly title for the risk evidence synthesis.
- studyType CodeableConcept? - Type of study eg randomized trial.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- 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.
- riskEstimate RiskEvidenceSynthesisRiskEstimate? - The estimated risk of the outcome.
- outcome Reference - A reference to a EvidenceVariable resomece that defines the outcome for the research.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- identifier Identifier[]? - A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the risk evidence synthesis content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- certainty RiskEvidenceSynthesisCertainty[]? - A description of the certainty of the risk estimate.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- 'version string? - The identifier that is used to identify this version of the risk evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the risk evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this risk evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this risk evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the risk evidence synthesis is stored on different servers.
- population Reference - A reference to a EvidenceVariable resource that defines the population for the research.
- 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.
- exposure Reference? - A reference to a EvidenceVariable resource that defines the exposure for the research.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- 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.
- synthesisType CodeableConcept? - Type of synthesis eg meta-analysis.
- name string? - A natural language name identifying the risk evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the risk evidence synthesis.
- topic CodeableConcept[]? - Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate risk evidence synthesis instances.
- status RiskEvidenceSynthesisStatus - The status of this risk evidence synthesis. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: RiskEvidenceSynthesisCertainty
FHIR RiskEvidenceSynthesisCertainty datatype record.
Fields
- Fields Included from *BackboneElement
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rating CodeableConcept[]? - A rating of the certainty of the effect estimate.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- certaintySubcomponent RiskEvidenceSynthesisCertaintyCertaintySubcomponent[]? - A description of a component of the overall certainty.
health.fhir.r4.international401: RiskEvidenceSynthesisCertaintyCertaintySubcomponent
FHIR RiskEvidenceSynthesisCertaintyCertaintySubcomponent datatype record.
Fields
- Fields Included from *BackboneElement
- note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- rating CodeableConcept[]? - A rating of a subcomponent of rating certainty.
- 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? - Type of subcomponent of certainty rating.
health.fhir.r4.international401: RiskEvidenceSynthesisRiskEstimate
FHIR RiskEvidenceSynthesisRiskEstimate datatype record.
Fields
- Fields Included from *BackboneElement
- numeratorCount integer? - The number of group members with the outcome of interest.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- unitOfMeasure CodeableConcept? - Specifies the UCUM unit for the outcome.
- denominatorCount integer? - The sample size for the group that was measured for this risk estimate.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- precisionEstimate RiskEvidenceSynthesisRiskEstimatePrecisionEstimate[]? - A description of the precision of the estimate for the effect.
- description string? - Human-readable summary of risk estimate.
- 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? - Examples include proportion and mean.
- value decimal? - The point estimate of the risk estimate.
health.fhir.r4.international401: RiskEvidenceSynthesisRiskEstimatePrecisionEstimate
FHIR RiskEvidenceSynthesisRiskEstimatePrecisionEstimate 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.
- level decimal? - Use 95 for a 95% confidence interval.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'from decimal? - Lower bound of confidence interval.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- to decimal? - Upper bound of confidence interval.
- 'type CodeableConcept? - Examples include confidence interval and interquartile range.
health.fhir.r4.international401: RiskEvidenceSynthesisSampleSize
FHIR RiskEvidenceSynthesisSampleSize datatype record.
Fields
- Fields Included from *BackboneElement
- numberOfParticipants integer? - Number of participants included in this evidence synthesis.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - Human-readable summary of sample size.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- numberOfStudies integer? - Number of studies included in this evidence synthesis.
health.fhir.r4.international401: Schedule
FHIR Schedule resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SCHEDULE(default RESOURCE_NAME_SCHEDULE) - The type of the resource describes
- serviceType CodeableConcept[]? - The specific service that is to be performed during this appointment.
- identifier Identifier[]? - External Ids for this item.
- 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.
- specialty CodeableConcept[]? - The specialty of a practitioner that would be required to perform the service requested in this appointment.
- 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 schedule record is in active use or should not be used (such as was entered in error).
- language code? - The base language in which the resource is written.
- serviceCategory CodeableConcept[]? - A broad categorization of the service that is to be performed during this appointment.
- planningHorizon Period? - The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a 'template' for planning outside these dates.
- actor Reference[] - Slots that reference this schedule resource provide the availability details to these referenced resource(s).
- 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.
- comment string? - Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
- 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.international401: SearchParameter
FHIR SearchParameter resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SEARCHPARAMETER(default RESOURCE_NAME_SEARCHPARAMETER) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
- 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 code - The code used in the URL or the parameter name in a parameters resource for this search parameter.
- purpose markdown? - Explanation of why this search parameter is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the search parameter is intended to be used.
- modifier SearchParameterModifier[]? - A modifier supported for the search parameter.
- 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 markdown - And how it used.
- experimental boolean? - A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- 'type SearchParameterType - The type of value that a search parameter may contain, and how the content is interpreted.
- xpath string? - An XPath expression that returns a set of elements for the search parameter.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- derivedFrom canonical? - Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
- xpathUsage SearchParameterXpathUsage? - How the search parameter relates to the set of elements returned by evaluating the xpath query.
- 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.
- chain string[]? - Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
- multipleAnd boolean? - Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
- expression string? - A FHIRPath expression that returns a set of elements for the search parameter.
- 'version string? - The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri - An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
- target code[]? - Types of resource (if a resource is referenced).
- comparator SearchParameterComparator[]? - Comparators supported for the search parameter.
- component SearchParameterComponent[]? - Used to define the parts of a composite search parameter.
- 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.
- multipleOr boolean? - Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- name string - A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the search parameter.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.
- base code[] - The base resource type(s) that this search parameter can be used against.
- status SearchParameterStatus - The status of this search parameter. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: SearchParameterComponent
FHIR SearchParameterComponent 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.
- expression string - A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- definition canonical - The definition of the search parameter that describes this part.
- 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.international401: ServiceRequest
FHIR ServiceRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SERVICEREQUEST(default RESOURCE_NAME_SERVICEREQUEST) - The type of the resource describes
- insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
- note Annotation[]? - Any other notes and comments made about the service request. For example, internal billing notes.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
- requisition Identifier? - A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
- subject Reference - On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- reasonReference Reference[]? - Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in
supportingInfo
.
- language code? - The base language in which the resource is written.
- instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
- relevantHistory Reference[]? - Key events in the history of the request.
- supportingInfo Reference[]? - Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
- specimen Reference[]? - One or more specimens that the laboratory procedure will use.
- quantityQuantity Quantity? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- quantityRatio Ratio? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- asNeededBoolean boolean? - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- locationReference Reference[]? - A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
- reasonCode CodeableConcept[]? - An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in
supportingInfo
.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- doNotPerform boolean? - Set this to true if the record is saying that the service/procedure should NOT be performed.
- basedOn Reference[]? - Plan/proposal/order fulfilled by this request.
- asNeededCodeableConcept CodeableConcept? - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.
- requester Reference? - The individual who initiated the request and has responsibility for its activation.
- identifier Identifier[]? - Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
- authoredOn dateTime? - When the request transitioned to being actionable.
- performer Reference[]? - The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
- replaces Reference[]? - The request takes the place of the referenced completed or terminated request(s).
- encounter Reference? - An encounter that provides additional information about the healthcare context in which this request is made.
- occurrenceTiming Timing? - The date/time at which the requested service should occur.
- quantityRange Range? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
- priority ServiceRequestPriority? - Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
- intent ServiceRequestIntent - Whether the request is a proposal, plan, an original order or a reflex order.
- performerType CodeableConcept? - Desired type of performer for doing the requested service.
- bodySite CodeableConcept[]? - Anatomic location where the procedure should be performed. This is the target site.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - The date/time at which the requested service should occur.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - The date/time at which the requested service should occur.
- orderDetail CodeableConcept[]? - Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
- category CodeableConcept[]? - A code that classifies the service for searching, sorting and display purposes (e.g. 'Surgical Procedure').
- locationCode CodeableConcept[]? - The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
- patientInstruction string? - Instructions in terms that are understood by the patient or consumer.
- status ServiceRequestStatus - The status of the order.
- Element... - Rest field
health.fhir.r4.international401: Slot
FHIR Slot resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SLOT(default RESOURCE_NAME_SLOT) - The type of the resource describes
- serviceType CodeableConcept[]? - The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
- appointmentType CodeableConcept? - The style of appointment or patient that may be booked in the slot (not service type).
- identifier Identifier[]? - External Ids for this item.
- 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.
- specialty CodeableConcept[]? - The specialty of a practitioner that would be required to perform the service requested in this appointment.
- 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).
- 'start instant - Date/Time that the slot is to begin.
- language code? - The base language in which the resource is written.
- serviceCategory CodeableConcept[]? - A broad categorization of the service that is to be performed during this appointment.
- schedule Reference - The schedule resource that this slot defines an interval of status information.
- 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.
- overbooked boolean? - This slot has already been overbooked, appointments are unlikely to be accepted for this time.
- 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.
- comment string? - Comments on the slot to describe any extended information. Such as custom constraints on the slot.
- end instant - Date/Time that the slot is to conclude.
- 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 SlotStatus - busy | free | busy-unavailable | busy-tentative | entered-in-error.
- Element... - Rest field
health.fhir.r4.international401: Specimen
FHIR Specimen resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SPECIMEN(default RESOURCE_NAME_SPECIMEN) - The type of the resource describes
- container SpecimenContainer[]? - 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 Reference? - 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 SpecimenCollection? - Details concerning the specimen collection.
- 'type CodeableConcept? - The kind of material that forms the specimen.
- 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 SpecimenProcessing[]? - 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 SpecimenStatus? - The availability of the specimen.
- Element... - Rest field
health.fhir.r4.international401: SpecimenCollection
FHIR SpecimenCollection datatype record.
Fields
- Fields Included from *BackboneElement
- duration Duration? - The span of time over which the collection of a specimen occurred.
- bodySite CodeableConcept? - Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 coded value specifying the technique that is used to perform the procedure.
- 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.international401: SpecimenContainer
FHIR SpecimenContainer 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.international401: SpecimenDefinition
FHIR SpecimenDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SPECIMENDEFINITION(default RESOURCE_NAME_SPECIMENDEFINITION) - The type of the resource describes
- identifier Identifier? - A business identifier associated with the kind of specimen.
- 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).
- patientPreparation CodeableConcept[]? - Preparation of the patient for specimen collection.
- timeAspect string? - Time aspect of specimen collection (duration or offset).
- language code? - The base language in which the resource is written.
- collection CodeableConcept[]? - The action to be performed for collecting 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.
- 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.
- typeCollected CodeableConcept? - The kind of material to be collected.
- typeTested SpecimenDefinitionTypeTested[]? - Specimen conditioned in a container as expected by the testing laboratory.
- Element... - Rest field
health.fhir.r4.international401: SpecimenDefinitionTypeTested
FHIR SpecimenDefinitionTypeTested datatype record.
Fields
- Fields Included from *BackboneElement
- container SpecimenDefinitionTypeTestedContainer? - The specimen's container.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- isDerived boolean? - Primary of secondary specimen.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- preference SpecimenDefinitionTypeTestedPreference - The preference for this type of conditioned specimen.
- rejectionCriterion CodeableConcept[]? - Criterion for rejection of the specimen in its container by the laboratory.
- handling SpecimenDefinitionTypeTestedHandling[]? - Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- requirement string? - Requirements for delivery and special handling of this kind of conditioned specimen.
- retentionTime Duration? - The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.
- 'type CodeableConcept? - The kind of specimen conditioned for testing expected by lab.
health.fhir.r4.international401: SpecimenDefinitionTypeTestedContainer
FHIR SpecimenDefinitionTypeTestedContainer 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.
- cap CodeableConcept? - Color of container cap.
- material CodeableConcept? - The type of material of the container.
- minimumVolumeSpecimenDefinitionString string? - The minimum volume to be conditioned in the container.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 textual description of the kind of 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 used to contain this kind of specimen.
- minimumVolumeSpecimenDefinitionQuantity Quantity? - The minimum volume to be conditioned in the container.
- additive SpecimenDefinitionTypeTestedContainerAdditive[]? - Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- capacity Quantity? - The capacity (volume or other measure) of this kind of container.
- preparation string? - Special processing that should be applied to the container for this kind of specimen.
health.fhir.r4.international401: SpecimenDefinitionTypeTestedContainerAdditive
FHIR SpecimenDefinitionTypeTestedContainerAdditive datatype record.
Fields
- Fields Included from *BackboneElement
- additiveSpecimenDefinitionReference Reference - Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- additiveSpecimenDefinitionCodeableConcept CodeableConcept - Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- 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.international401: SpecimenDefinitionTypeTestedHandling
FHIR SpecimenDefinitionTypeTestedHandling datatype record.
Fields
- Fields Included from *BackboneElement
- temperatureRange Range? - The temperature interval for this set of handling instructions.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- instruction string? - Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- maxDuration Duration? - The maximum time interval of preservation of the specimen with these conditions.
- temperatureQualifier CodeableConcept? - It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.
health.fhir.r4.international401: SpecimenProcessing
FHIR SpecimenProcessing 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.international401: StructureDefinition
FHIR StructureDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_STRUCTUREDEFINITION(default RESOURCE_NAME_STRUCTUREDEFINITION) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.
- copyright markdown? - A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
- 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.
- purpose markdown? - Explanation of why this structure definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the structure definition is intended to be used.
- 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 markdown? - A free text natural language description of the structure definition from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the structure definition.
- 'type uri - The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. 'string' is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
- differential StructureDefinitionDifferential? - A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- fhirVersion code? - The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
- context StructureDefinitionContext[]? - Identifies the types of resource or data type elements to which the extension can be applied.
- 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.
- keyword Coding[]? - A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.
- identifier Identifier[]? - A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- mapping StructureDefinitionMapping[]? - An external specification that the content is mapped to.
- kind StructureDefinitionKind - Defines the kind of structure that this definition is describing.
- 'abstract boolean - Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
- baseDefinition canonical? - An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
- 'version string? - The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri - An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.
- 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 string - A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the structure definition.
- derivation StructureDefinitionDerivation? - How the type relates to the baseDefinition.
- contextInvariant string[]? - A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.
- snapshot StructureDefinitionSnapshot? - A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.
- status StructureDefinitionStatus - The status of this structure definition. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: StructureDefinitionContext
FHIR StructureDefinitionContext 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.
- expression string - An expression that defines where an extension can be used in resources.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 StructureDefinitionContextType - Defines how to interpret the expression that defines what the context of the extension is.
health.fhir.r4.international401: StructureDefinitionDifferential
FHIR StructureDefinitionDifferential 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.
- element ElementDefinition[] - Captures constraints on each element within the resource.
health.fhir.r4.international401: StructureDefinitionMapping
FHIR StructureDefinitionMapping 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.
- identity id - An Internal id that is used to identify this mapping set when specific mappings are made.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - A name for the specification that is being mapped to.
- comment string? - Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- uri uri? - An absolute URI that identifies the specification that this mapping is expressed to.
health.fhir.r4.international401: StructureDefinitionSnapshot
FHIR StructureDefinitionSnapshot 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.
- element ElementDefinition[] - Captures constraints on each element within the resource.
health.fhir.r4.international401: StructureMap
FHIR StructureMap resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_STRUCTUREMAP(default RESOURCE_NAME_STRUCTUREMAP) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the structure map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.
- copyright markdown? - A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
- 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.
- 'import canonical[]? - Other maps used by this map (canonical URLs).
- purpose markdown? - Explanation of why this structure map is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the structure map is intended to be used.
- 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 markdown? - A free text natural language description of the structure map from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the structure map.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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.
- group StructureMapGroup[] - Organizes the mapping into manageable chunks for human review/ease of maintenance.
- identifier Identifier[]? - A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
- 'version string? - The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- structure StructureMapStructure[]? - A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
- url uri - An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.
- 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 string - A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- 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.
- publisher string? - The name of the organization or individual that published the structure map.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.
- status StructureMapStatus - The status of this structure map. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: StructureMapGroup
FHIR StructureMapGroup datatype record.
Fields
- Fields Included from *BackboneElement
- typeMode StructureMapGroupTypeMode - If this is the default rule set to apply for the source type or this combination of types.
- input StructureMapGroupInput[] - A name assigned to an instance of data. The instance must be provided when the mapping is invoked.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- extends id? - Another group that this group adds rules to.
- documentation string? - Additional supporting documentation that explains the purpose of the group and the types of mappings within it.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 id - A unique name for the group for the convenience of human readers.
- rule StructureMapGroupRule[] - Transform Rule from source to target.
- 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.international401: StructureMapGroupInput
FHIR StructureMapGroupInput datatype record.
Fields
- Fields Included from *BackboneElement
- mode StructureMapGroupInputMode - Mode for this instance of data.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- documentation string? - Documentation for this instance of data.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 id - Name for this instance of data.
- 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 string? - Type for this instance of data.
health.fhir.r4.international401: StructureMapGroupRule
FHIR StructureMapGroupRule 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.
- documentation string? - Documentation for this instance of data.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 id - Name of the rule for internal references.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'source StructureMapGroupRuleSource[] - Source inputs to the mapping.
- dependent StructureMapGroupRuleDependent[]? - Which other rules to apply in the context of this rule.
- target StructureMapGroupRuleTarget[]? - Content to create because of this mapping rule.
health.fhir.r4.international401: StructureMapGroupRuleDependent
FHIR StructureMapGroupRuleDependent 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 id - Name of a rule or group to apply.
- variable string[] - Variable to pass to the rule or group.
- 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.international401: StructureMapGroupRuleSource
FHIR StructureMapGroupRuleSource datatype record.
Fields
- Fields Included from *BackboneElement
- defaultValueStructureMapRange Range? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapAnnotation Annotation? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapAge Age? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapQuantity Quantity? - A value to use if there is no existing value in the source object.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- defaultValueStructureMapSignature Signature? - A value to use if there is no existing value in the source object.
- 'type string? - Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
- defaultValueStructureMapTime time? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapDataRequirement DataRequirement? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapUnsignedInt unsignedInt? - A value to use if there is no existing value in the source object.
- context id - Type or variable this rule applies to.
- defaultValueStructureMapTriggerDefinition TriggerDefinition? - A value to use if there is no existing value in the source object.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- element string? - Optional field for this source.
- defaultValueStructureMapDateTime dateTime? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapBoolean boolean? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapInteger integer? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapUuid uuid? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapPeriod Period? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapCodeableConcept CodeableConcept? - A value to use if there is no existing value in the source object.
- 'check string? - FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
- defaultValueStructureMapDate date? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapSampledData SampledData? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapUsageContext UsageContext? - A value to use if there is no existing value in the source object.
- condition string? - FHIRPath expression - must be true or the rule does not apply.
- defaultValueStructureMapInstant instant? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapRelatedArtifact RelatedArtifact? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapParameterDefinition ParameterDefinition? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapAddress Address? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapReference Reference? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapDosage Dosage? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapDecimal decimal? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapMoney Money? - A value to use if there is no existing value in the source object.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- defaultValueStructureMapString string? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapIdentifier Identifier? - A value to use if there is no existing value in the source object.
- logMessage string? - A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.
- defaultValueStructureMapExpression Expression? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapAttachment Attachment? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapOid oid? - A value to use if there is no existing value in the source object.
- listMode StructureMapGroupRuleSourceListMode? - How to handle the list mode for this element.
- defaultValueStructureMapDuration Duration? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapContactDetail ContactDetail? - A value to use if there is no existing value in the source object.
- min integer? - Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
- defaultValueStructureMapCoding Coding? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapRatio Ratio? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapDistance Distance? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapTiming Timing? - A value to use if there is no existing value in the source object.
- max string? - Specified maximum cardinality for the element - a number or a ''. This is optional; if present, it acts an implicit check on the input content ( just serves as documentation; it's the default value).
- defaultValueStructureMapContactPoint ContactPoint? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapCanonical canonical? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapCode code? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapCount Count? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapHumanName HumanName? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapMeta Meta? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapId id? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapUri uri? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapBase64Binary base64Binary? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapUrl urlType? - A value to use if there is no existing value in the source object.
- variable id? - Named context for field, if a field is specified.
- defaultValueStructureMapMarkdown markdown? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapPositiveInt positiveInt? - A value to use if there is no existing value in the source object.
- defaultValueStructureMapContributor Contributor? - A value to use if there is no existing value in the source object.
health.fhir.r4.international401: StructureMapGroupRuleTarget
FHIR StructureMapGroupRuleTarget datatype record.
Fields
- Fields Included from *BackboneElement
- listMode StructureMapGroupRuleTargetListMode[]? - If field is a list, how to manage the list.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- listRuleId id? - Internal rule reference for shared list items.
- transform StructureMapGroupRuleTargetTransform? - How the data is copied / created.
- contextType StructureMapGroupRuleTargetContextType? - How to interpret the context.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'parameter StructureMapGroupRuleTargetParameter[]? - Parameters to the transform.
- context id? - Type or variable this rule applies to.
- variable id? - Named context for field, if desired, and a field is specified.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- element string? - Field to create in the context.
health.fhir.r4.international401: StructureMapGroupRuleTargetParameter
FHIR StructureMapGroupRuleTargetParameter datatype record.
Fields
- Fields Included from *BackboneElement
- valueStructureMapDecimal decimal - Parameter value - variable or literal.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- valueStructureMapString string - Parameter value - variable or literal.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueStructureMapBoolean boolean - Parameter value - variable or literal.
- valueStructureMapInteger integer - Parameter value - variable or literal.
- valueStructureMapId id - Parameter value - variable or literal.
health.fhir.r4.international401: StructureMapStructure
FHIR StructureMapStructure datatype record.
Fields
- Fields Included from *BackboneElement
- mode StructureMapStructureMode - How the referenced structure is used in this mapping.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- documentation string? - Documentation that describes how the structure is used in the mapping.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- alias string? - The name used for this type in the map.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- url canonical - The canonical reference to the structure.
health.fhir.r4.international401: Subscription
FHIR Subscription resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSCRIPTION(default RESOURCE_NAME_SUBSCRIPTION) - The type of the resource describes
- reason string - A description of why this subscription is defined.
- 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.
- criteria string - The rules that the server should use to determine when to generate notifications for this subscription.
- 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).
- channel SubscriptionChannel - Details where to send notifications when resources are received that meet the criteria.
- language code? - The base language in which the resource is written.
- 'error string? - A record of the last error that occurred when the server processed a notification.
- 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.
- contact ContactPoint[]? - Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
- 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.
- end instant? - The time for the server to turn the subscription off.
- 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 SubscriptionStatus - The status of the subscription, which marks the server state for managing the subscription.
- Element... - Rest field
health.fhir.r4.international401: SubscriptionChannel
FHIR SubscriptionChannel datatype record.
Fields
- Fields Included from *BackboneElement
- endpoint urlType? - The url that describes the actual end-point to send messages to.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- payload code? - The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type 'text/plain' may also be used for Email and SMS subscriptions.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- header string[]? - Additional headers / information to send as part of the notification.
- 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 SubscriptionChannelType - The type of channel to send notifications on.
health.fhir.r4.international401: Substance
FHIR Substance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCE(default RESOURCE_NAME_SUBSTANCE) - The type of the resource describes
- identifier Identifier[]? - Unique identifier for the substance.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept - A code (or set of codes) that identify this substance.
- ingredient SubstanceIngredient[]? - A substance can be composed of other substances.
- instance SubstanceInstance[]? - Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string? - A description of the substance - its appearance, handling requirements, and other usage notes.
- language code? - The base language in which the resource is written.
- 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.
- category CodeableConcept[]? - A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
- status SubstanceStatus? - A code to indicate if the substance is actively used.
- Element... - Rest field
health.fhir.r4.international401: SubstanceIngredient
FHIR SubstanceIngredient 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.
- quantity Ratio? - The amount of the ingredient in the substance - a concentration ratio.
- substanceCodeableConcept CodeableConcept - Another substance that is a component of this substance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- substanceReference Reference - Another substance that is a component of this substance.
health.fhir.r4.international401: SubstanceInstance
FHIR SubstanceInstance datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier? - Identifier associated with the package/container (usually a label affixed directly).
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 of the substance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- expiry dateTime? - When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
- 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.international401: SubstanceNucleicAcid
FHIR SubstanceNucleicAcid resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCENUCLEICACID(default RESOURCE_NAME_SUBSTANCENUCLEICACID) - 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.
- 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.
- subunit SubstanceNucleicAcidSubunit[]? - Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.
- numberOfSubunits integer? - The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.
- 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.
- oligoNucleotideType CodeableConcept? - (TBC).
- 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.
- areaOfHybridisation string? - The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.
- sequenceType CodeableConcept? - The type of the sequence shall be specified based on a controlled vocabulary.
- Element... - Rest field
health.fhir.r4.international401: SubstanceNucleicAcidSubunit
FHIR SubstanceNucleicAcidSubunit datatype record.
Fields
- Fields Included from *BackboneElement
- sequence string? - Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- threePrime CodeableConcept? - The nucleotide present at the 3’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- fivePrime CodeableConcept? - The nucleotide present at the 5’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant.
- length integer? - The length of the sequence shall be captured.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- linkage SubstanceNucleicAcidSubunitLinkage[]? - The linkages between sugar residues will also be captured.
- subunit integer? - Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.
- sugar SubstanceNucleicAcidSubunitSugar[]? - 5.3.6.8.1 Sugar ID (Mandatory).
- sequenceAttachment Attachment? - (TBC).
health.fhir.r4.international401: SubstanceNucleicAcidSubunitLinkage
FHIR SubstanceNucleicAcidSubunitLinkage datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier? - Each linkage will be registered as a fragment and have an ID.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- connectivity string? - The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified.
- residueSite string? - Residues shall be captured as described in 5.3.6.8.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).
- name string? - Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.
- 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.international401: SubstanceNucleicAcidSubunitSugar
FHIR SubstanceNucleicAcidSubunitSugar datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier? - The Substance ID of the sugar or sugar-like component that make up the nucleotide.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- residueSite string? - The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 sugar or sugar-like component that make up the nucleotide.
- 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.international401: SubstancePolymer
FHIR SubstancePolymer resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCEPOLYMER(default RESOURCE_NAME_SUBSTANCEPOLYMER) - The type of the resource describes
- monomerSet SubstancePolymerMonomerSet[]? - Todo.
- 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.
- modification string[]? - Todo.
- 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.
- copolymerConnectivity CodeableConcept[]? - Todo.
- repeat SubstancePolymerRepeat[]? - Todo.
- 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.
- geometry CodeableConcept? - Todo.
- 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.
- 'class CodeableConcept? - Todo.
- Element... - Rest field
health.fhir.r4.international401: SubstancePolymerMonomerSet
FHIR SubstancePolymerMonomerSet datatype record.
Fields
- Fields Included from *BackboneElement
- startingMaterial SubstancePolymerMonomerSetStartingMaterial[]? - Todo.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- ratioType CodeableConcept? - Todo.
- 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.international401: SubstancePolymerMonomerSetStartingMaterial
FHIR SubstancePolymerMonomerSetStartingMaterial datatype record.
Fields
- Fields Included from *BackboneElement
- amount SubstanceAmount? - Todo.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- material CodeableConcept? - Todo.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Todo.
- isDefining boolean? - Todo.
health.fhir.r4.international401: SubstancePolymerRepeat
FHIR SubstancePolymerRepeat datatype record.
Fields
- Fields Included from *BackboneElement
- repeatUnit SubstancePolymerRepeatRepeatUnit[]? - Todo.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- numberOfUnits integer? - Todo.
- repeatUnitAmountType CodeableConcept? - Todo.
- averageMolecularFormula string? - Todo.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: SubstancePolymerRepeatRepeatUnit
FHIR SubstancePolymerRepeatRepeatUnit datatype record.
Fields
- Fields Included from *BackboneElement
- structuralRepresentation SubstancePolymerRepeatRepeatUnitStructuralRepresentation[]? - Todo.
- repeatUnit string? - Todo.
- amount SubstanceAmount? - Todo.
- degreeOfPolymerisation SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation[]? - Todo.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- orientationOfPolymerisation CodeableConcept? - Todo.
health.fhir.r4.international401: SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation
FHIR SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation datatype record.
Fields
- Fields Included from *BackboneElement
- amount SubstanceAmount? - Todo.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- degree CodeableConcept? - Todo.
- 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.international401: SubstancePolymerRepeatRepeatUnitStructuralRepresentation
FHIR SubstancePolymerRepeatRepeatUnitStructuralRepresentation 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.
- attachment Attachment? - Todo.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Todo.
- representation string? - Todo.
health.fhir.r4.international401: SubstanceProtein
FHIR SubstanceProtein resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCEPROTEIN(default RESOURCE_NAME_SUBSTANCEPROTEIN) - The type of the resource describes
- 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.
- 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.
- 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.
- 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).
- disulfideLinkage string[]? - The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.
- 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.
- language code? - The base language in which the resource is written.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- subunit SubstanceProteinSubunit[]? - This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.
- 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.
- numberOfSubunits integer? - Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.
- sequenceType CodeableConcept? - The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.
- Element... - Rest field
health.fhir.r4.international401: SubstanceProteinSubunit
FHIR SubstanceProteinSubunit datatype record.
Fields
- Fields Included from *BackboneElement
- sequence string? - The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- cTerminalModification string? - The modification at the C-terminal shall be specified.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- length integer? - Length of linear sequences of amino acids contained in the subunit.
- nTerminalModification string? - The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- nTerminalModificationId Identifier? - Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.
- subunit integer? - Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.
- cTerminalModificationId Identifier? - Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.
- sequenceAttachment Attachment? - The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.
health.fhir.r4.international401: SubstanceReferenceInformation
FHIR SubstanceReferenceInformation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCEREFERENCEINFORMATION(default RESOURCE_NAME_SUBSTANCEREFERENCEINFORMATION) - 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.
- gene SubstanceReferenceInformationGene[]? - Todo.
- 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.
- classification SubstanceReferenceInformationClassification[]? - Todo.
- target SubstanceReferenceInformationTarget[]? - Todo.
- geneElement SubstanceReferenceInformationGeneElement[]? - Todo.
- 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.
- comment string? - Todo.
- 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.international401: SubstanceReferenceInformationClassification
FHIR SubstanceReferenceInformationClassification 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.
- subtype CodeableConcept[]? - Todo.
- domain CodeableConcept? - Todo.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- 'source Reference[]? - Todo.
- classification CodeableConcept? - Todo.
health.fhir.r4.international401: SubstanceReferenceInformationGene
FHIR SubstanceReferenceInformationGene 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.
- gene CodeableConcept? - Todo.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- 'source Reference[]? - Todo.
- geneSequenceOrigin CodeableConcept? - Todo.
health.fhir.r4.international401: SubstanceReferenceInformationGeneElement
FHIR SubstanceReferenceInformationGeneElement 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.
- 'source Reference[]? - Todo.
- 'type CodeableConcept? - Todo.
- element Identifier? - Todo.
health.fhir.r4.international401: SubstanceReferenceInformationTarget
FHIR SubstanceReferenceInformationTarget datatype record.
Fields
- Fields Included from *BackboneElement
- amountType CodeableConcept? - Todo.
- organismType CodeableConcept? - Todo.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- organism CodeableConcept? - Todo.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'source Reference[]? - Todo.
- 'type CodeableConcept? - Todo.
- target Identifier? - Todo.
- amountQuantity Quantity? - Todo.
- amountString string? - Todo.
- amountRange Range? - Todo.
- interaction CodeableConcept? - Todo.
- 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.international401: SubstanceSourceMaterial
FHIR SubstanceSourceMaterial resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCESOURCEMATERIAL(default RESOURCE_NAME_SUBSTANCESOURCEMATERIAL) - 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.
- geographicalLocation string[]? - The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
- organism SubstanceSourceMaterialOrganism? - This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.
- 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.
- sourceMaterialType CodeableConcept? - The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.
- 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.
- organismId Identifier? - The unique identifier associated with the source material parent organism shall be specified.
- parentSubstanceName string[]? - The parent substance of the Herbal Drug, or Herbal preparation.
- developmentStage CodeableConcept? - Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).
- 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.
- organismName string? - The organism accepted Scientific name shall be provided based on the organism taxonomy.
- partDescription SubstanceSourceMaterialPartDescription[]? - To do.
- 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.
- sourceMaterialClass CodeableConcept? - General high level classification of the source material specific to the origin of the material.
- countryOfOrigin CodeableConcept[]? - The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- sourceMaterialState CodeableConcept? - The state of the source material when extracted.
- 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.
- parentSubstanceId Identifier[]? - The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).
- fractionDescription SubstanceSourceMaterialFractionDescription[]? - Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.
- Element... - Rest field
health.fhir.r4.international401: SubstanceSourceMaterialFractionDescription
FHIR SubstanceSourceMaterialFractionDescription 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.
- materialType CodeableConcept? - The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- fraction string? - This element is capturing information about the fraction of a plant part, or human plasma for fractionation.
health.fhir.r4.international401: SubstanceSourceMaterialOrganism
FHIR SubstanceSourceMaterialOrganism 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.
- hybrid SubstanceSourceMaterialOrganismHybrid? - 4.9.13.8.1 Hybrid species maternal organism ID (Optional).
- intraspecificType CodeableConcept? - The Intraspecific type of an organism shall be specified.
- genus CodeableConcept? - The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies.
- species CodeableConcept? - The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies.
- author SubstanceSourceMaterialOrganismAuthor[]? - 4.9.13.6.1 Author type (Conditional).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- organismGeneral SubstanceSourceMaterialOrganismOrganismGeneral? - 4.9.13.7.1 Kingdom (Conditional).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- family CodeableConcept? - The family of an organism shall be specified.
- intraspecificDescription string? - The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention.
health.fhir.r4.international401: SubstanceSourceMaterialOrganismAuthor
FHIR SubstanceSourceMaterialOrganismAuthor 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.
- authorType CodeableConcept? - The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- authorDescription string? - The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank).
- 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.international401: SubstanceSourceMaterialOrganismHybrid
FHIR SubstanceSourceMaterialOrganismHybrid datatype record.
Fields
- Fields Included from *BackboneElement
- maternalOrganismName string? - The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- maternalOrganismId string? - The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal.
- paternalOrganismId string? - The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- hybridType CodeableConcept? - The hybrid type of an organism shall be specified.
- paternalOrganismName string? - The name of the paternal species constituting the hybrid organism shall be specified.
- 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.international401: SubstanceSourceMaterialOrganismOrganismGeneral
FHIR SubstanceSourceMaterialOrganismOrganismGeneral 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.
- phylum CodeableConcept? - The phylum of an organism shall be specified.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'class CodeableConcept? - The class of an organism shall be specified.
- kingdom CodeableConcept? - The kingdom of an organism shall be specified.
- 'order CodeableConcept? - The order of an organism shall be specified,.
health.fhir.r4.international401: SubstanceSourceMaterialPartDescription
FHIR SubstanceSourceMaterialPartDescription 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).
- part CodeableConcept? - Entity of anatomical origin of source material within an organism.
- partLocation CodeableConcept? - The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.
- 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.international401: SubstanceSpecification
FHIR SubstanceSpecification resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUBSTANCESPECIFICATION(default RESOURCE_NAME_SUBSTANCESPECIFICATION) - The type of the resource describes
- polymer Reference? - Data items specific to polymers.
- 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 SubstanceSpecificationCode[]? - Codes associated with the substance.
- 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? - Textual description of the substance.
- language code? - The base language in which the resource is written.
- 'source Reference[]? - Supporting literature.
- 'type CodeableConcept? - High level categorization, e.g. polymer or nucleic acid.
- moiety SubstanceSpecificationMoiety[]? - Moiety, for structural modifications.
- protein Reference? - Data items specific to proteins.
- property SubstanceSpecificationProperty[]? - General specifications for this substance, including how it is related to other substances.
- 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.
- relationship SubstanceSpecificationRelationship[]? - A link between this substance and another, with details of the relationship.
- identifier Identifier? - Identifier by which this substance is known.
- referenceInformation Reference? - General information detailing this substance.
- structure SubstanceSpecificationStructure? - Structural information.
- sourceMaterial Reference? - Material or taxonomic/anatomical source for the substance.
- 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.
- nucleicAcid Reference? - Data items specific to nucleic acids.
- 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.
- domain CodeableConcept? - If the substance applies to only human or veterinary use.
- name SubstanceSpecificationName[]? - Names applicable to this substance.
- 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.
- comment string? - Textual comment about this record of a substance.
- status CodeableConcept? - Status of substance within the catalogue e.g. approved.
- Element... - Rest field
health.fhir.r4.international401: SubstanceSpecificationCode
FHIR SubstanceSpecificationCode datatype record.
Fields
- Fields Included from *BackboneElement
- statusDate dateTime? - The date at which the code status is changed as part of the terminology maintenance.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - The specific code.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- comment string? - Any comment can be provided in this field, if necessary.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'source Reference[]? - Supporting literature.
- status CodeableConcept? - Status of the code assignment.
health.fhir.r4.international401: SubstanceSpecificationMoiety
FHIR SubstanceSpecificationMoiety datatype record.
Fields
- Fields Included from *BackboneElement
- amountQuantity Quantity? - Quantitative value for this moiety.
- identifier Identifier? - Identifier by which this moiety substance 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.
- role CodeableConcept? - Role that the moiety is playing.
- amountString string? - Quantitative value for this moiety.
- opticalActivity CodeableConcept? - Optical activity type.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- molecularFormula string? - Molecular formula.
- name string? - Textual name for this moiety substance.
- stereochemistry CodeableConcept? - Stereochemistry type.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.international401: SubstanceSpecificationName
FHIR SubstanceSpecificationName 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.
- domain CodeableConcept[]? - The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.
- jurisdiction CodeableConcept[]? - The jurisdiction where this name applies.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 actual name.
- official SubstanceSpecificationNameOfficial[]? - Details of the official nature of this name.
- language CodeableConcept[]? - Language of the 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.
- 'source Reference[]? - Supporting literature.
- 'type CodeableConcept? - Name type.
- preferred boolean? - If this is the preferred name for this substance.
- status CodeableConcept? - The status of the name.
health.fhir.r4.international401: SubstanceSpecificationNameOfficial
FHIR SubstanceSpecificationNameOfficial datatype record.
Fields
- Fields Included from *BackboneElement
- date dateTime? - Date of official name change.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- authority CodeableConcept? - Which authority uses this official name.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- status CodeableConcept? - The status of the official name.
health.fhir.r4.international401: SubstanceSpecificationProperty
FHIR SubstanceSpecificationProperty datatype record.
Fields
- Fields Included from *BackboneElement
- amountQuantity Quantity? - Quantitative value for this property.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - Property type e.g. viscosity, pH, isoelectric point.
- amountString string? - Quantitative value for this property.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- category CodeableConcept? - A category for this property, e.g. Physical, Chemical, Enzymatic.
- parameters string? - Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).
- definingSubstanceReference Reference? - A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).
- definingSubstanceCodeableConcept CodeableConcept? - A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).
health.fhir.r4.international401: SubstanceSpecificationRelationship
FHIR SubstanceSpecificationRelationship datatype record.
Fields
- Fields Included from *BackboneElement
- amountRatio Ratio? - A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
- amountType CodeableConcept? - An operator for the amount, for example 'average', 'approximately', 'less than'.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- substanceCodeableConcept CodeableConcept? - A pointer to another substance, as a resource or just a representational code.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'source Reference[]? - Supporting literature.
- amountRatioLowLimit Ratio? - For use when the numeric.
- isDefining boolean? - For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.
- amountQuantity Quantity? - A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
- amountString string? - A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
- amountRange Range? - A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
- 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? - For example 'salt to parent', 'active moiety', 'starting material'.
- substanceReference Reference? - A pointer to another substance, as a resource or just a representational code.
health.fhir.r4.international401: SubstanceSpecificationStructure
FHIR SubstanceSpecificationStructure 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.
- opticalActivity CodeableConcept? - Optical activity type.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- molecularFormula string? - Molecular formula.
- molecularFormulaByMoiety string? - Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.
- stereochemistry CodeableConcept? - Stereochemistry 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.
- isotope SubstanceSpecificationStructureIsotope[]? - Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.
- 'source Reference[]? - Supporting literature.
- representation SubstanceSpecificationStructureRepresentation[]? - Molecular structural representation.
health.fhir.r4.international401: SubstanceSpecificationStructureIsotope
FHIR SubstanceSpecificationStructureIsotope datatype record.
Fields
- Fields Included from *BackboneElement
- identifier Identifier? - Substance identifier for each non-natural or radioisotope.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableConcept? - The type of isotopic substitution present in a single substance.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 CodeableConcept? - Substance name for each non-natural or radioisotope.
- molecularWeight SubstanceSpecificationStructureIsotopeMolecularWeight? - The molecular weight or weight range (for proteins, polymers or nucleic acids).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- halfLife Quantity? - Half life - for a non-natural nuclide.
health.fhir.r4.international401: SubstanceSpecificationStructureIsotopeMolecularWeight
FHIR SubstanceSpecificationStructureIsotopeMolecularWeight datatype record.
Fields
- Fields Included from *BackboneElement
- amount Quantity? - Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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? - The method by which the molecular weight was determined.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - Type of molecular weight such as exact, average (also known as. number average), weight average.
health.fhir.r4.international401: SubstanceSpecificationStructureRepresentation
FHIR SubstanceSpecificationStructureRepresentation 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.
- attachment Attachment? - An attached file with the structural representation.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 structure (e.g. Full, Partial, Representative).
- representation string? - The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.
health.fhir.r4.international401: SupplyDelivery
FHIR SupplyDelivery resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUPPLYDELIVERY(default RESOURCE_NAME_SUPPLYDELIVERY) - The type of the resource describes
- identifier Identifier[]? - Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
- 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.
- receiver Reference[]? - Identifies the person who picked up the Supply.
- 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).
- destination Reference? - Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
- language code? - The base language in which the resource is written.
- occurrenceTiming Timing? - The date or time(s) the activity occurred.
- 'type CodeableConcept? - Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - The date or time(s) the activity occurred.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference? - A link to a resource representing the person whom the delivered item is for.
- supplier Reference? - The individual responsible for dispensing the medication, supplier or device.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - The date or time(s) the activity occurred.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event.
- suppliedItem SupplyDeliverySuppliedItem? - The item that is being delivered or has been supplied.
- status SupplyDeliveryStatus? - A code specifying the state of the dispense event.
- Element... - Rest field
health.fhir.r4.international401: SupplyDeliverySuppliedItem
FHIR SupplyDeliverySuppliedItem datatype record.
Fields
- Fields Included from *BackboneElement
- itemReference Reference? - Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 of supply that has been dispensed. Includes unit of measure.
- itemCodeableConcept CodeableConcept? - Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: SupplyRequest
FHIR SupplyRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_SUPPLYREQUEST(default RESOURCE_NAME_SUPPLYREQUEST) - 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.
- deliverFrom Reference? - Where the supply is expected to come from.
- 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 reason why the supply item was requested.
- language code? - The base language in which the resource is written.
- deliverTo Reference? - Where the supply is destined to go.
- itemCodeableConcept CodeableConcept - The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
- 'parameter SupplyRequestParameter[]? - Specific parameters for the ordered item. For example, the size of the indicated item.
- supplier Reference[]? - Who is intended to fulfill the request.
- 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 why the supply item was requested.
- 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.
- requester Reference? - The device, practitioner, etc. who initiated the request.
- identifier Identifier[]? - Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
- authoredOn dateTime? - When the request was made.
- quantity Quantity - The amount that is being ordered of the indicated item.
- occurrenceTiming Timing? - When the request should be fulfilled.
- priority SupplyRequestPriority? - Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
- itemReference Reference - The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- occurrencePeriod Period? - When the request should be fulfilled.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- occurrenceDateTime dateTime? - When the request should be fulfilled.
- category CodeableConcept? - Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
- status SupplyRequestStatus? - Status of the supply request.
- Element... - Rest field
health.fhir.r4.international401: SupplyRequestParameter
FHIR SupplyRequestParameter datatype record.
Fields
- Fields Included from *BackboneElement
- valueCodeableConcept CodeableConcept? - The value of the device detail.
- valueBoolean boolean? - The value of the device detail.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A code or string that identifies the device detail being asserted.
- valueRange Range? - The value of the device detail.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - The value of the device detail.
health.fhir.r4.international401: Task
FHIR Task resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_TASK(default RESOURCE_NAME_TASK) - The type of the resource describes
- insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
- note Annotation[]? - Free-text information captured about the task as it progresses.
- partOf Reference[]? - Task that this particular task is part of.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - A name or code (or both) briefly describing what the task involves.
- 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).
- for Reference? - The entity who benefits from the performance of the service specified in the task (e.g., the patient).
- description string? - A free-text description of what is to be performed.
- focus Reference? - The request being actioned or the resource being manipulated by this task.
- reasonReference Reference? - A resource reference indicating why this task needs to be performed.
- 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 Task.
- relevantHistory Reference[]? - Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
- output TaskOutput[]? - Outputs produced by the Task.
- statusReason CodeableConcept? - An explanation as to why this task is held, failed, was refused, etc.
- executionPeriod Period? - Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
- 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 description or code indicating why this task needs to be performed.
- 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[]? - BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a 'request' resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the 'request' resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
- owner Reference? - Individual organization or Device currently responsible for task execution.
- requester Reference? - The creator of the task.
- identifier Identifier[]? - The business identifier for this task.
- authoredOn dateTime? - The date and time this task was created.
- businessStatus CodeableConcept? - Contains business-specific nuances of the business state.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
- instantiatesCanonical canonical? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
- priority TaskPriority? - Indicates how quickly the Task should be addressed with respect to other requests.
- intent TaskIntent - Indicates the 'level' of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
- performerType CodeableConcept[]? - The kind of participant that should perform the task.
- input TaskInput[]? - Additional information that may be needed in the execution of the task.
- 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.
- restriction TaskRestriction? - If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
- 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? - Principal physical location where the this task is performed.
- lastModified dateTime? - The date and time of last modification to this task.
- groupIdentifier Identifier? - An identifier that links together multiple tasks and other requests that were created in the same context.
- status TaskStatus - The current status of the task.
- Element... - Rest field
health.fhir.r4.international401: TaskInput
FHIR TaskInput datatype record.
Fields
- Fields Included from *BackboneElement
- valueTime time - The value of the input parameter as a basic type.
- valueTriggerDefinition TriggerDefinition - The value of the input parameter as a basic type.
- valueMoney Money - The value of the input parameter as a basic type.
- valueSignature Signature - The value of the input parameter as a basic type.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'type CodeableConcept - A code or description indicating how the input is intended to be used as part of the task execution.
- valueUuid uuid - The value of the input parameter as a basic type.
- valueRatio Ratio - The value of the input parameter as a basic type.
- valueParameterDefinition ParameterDefinition - The value of the input parameter as a basic 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.
- valueInteger integer - The value of the input parameter as a basic type.
- valueUnsignedInt unsignedInt - The value of the input parameter as a basic type.
- valueQuantity Quantity - The value of the input parameter as a basic type.
- valueCanonical canonical - The value of the input parameter as a basic type.
- valueCount Count - The value of the input parameter as a basic type.
- valueId id - The value of the input parameter as a basic type.
- valueCode code - The value of the input parameter as a basic type.
- valueAddress Address - The value of the input parameter as a basic type.
- valueContactPoint ContactPoint - The value of the input parameter as a basic type.
- valuePeriod Period - The value of the input parameter as a basic type.
- valueSampledData SampledData - The value of the input parameter as a basic type.
- valueTiming Timing - The value of the input parameter as a basic type.
- valueInstant instant - The value of the input parameter as a basic type.
- valueAge Age - The value of the input parameter as a basic type.
- valueDosage Dosage - The value of the input parameter as a basic type.
- valueBase64Binary base64Binary - The value of the input parameter as a basic type.
- valueBoolean boolean - The value of the input parameter as a basic type.
- valueCoding Coding - The value of the input parameter as a basic 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.
- valueIdentifier Identifier - The value of the input parameter as a basic type.
- valueExpression Expression - The value of the input parameter as a basic type.
- valueReference Reference - The value of the input parameter as a basic type.
- valueRange Range - The value of the input parameter as a basic type.
- valueUri uri - The value of the input parameter as a basic type.
- valueDistance Distance - The value of the input parameter as a basic type.
- valueUrl urlType - The value of the input parameter as a basic type.
- valueContactDetail ContactDetail - The value of the input parameter as a basic type.
- valueMeta Meta - The value of the input parameter as a basic type.
- valueCodeableConcept CodeableConcept - The value of the input parameter as a basic type.
- valueMarkdown markdown - The value of the input parameter as a basic type.
- valueAttachment Attachment - The value of the input parameter as a basic type.
- valueUsageContext UsageContext - The value of the input parameter as a basic type.
- valueDateTime dateTime - The value of the input parameter as a basic type.
- valueHumanName HumanName - The value of the input parameter as a basic type.
- valueRelatedArtifact RelatedArtifact - The value of the input parameter as a basic type.
- valueDecimal decimal - The value of the input parameter as a basic type.
- valueDate date - The value of the input parameter as a basic type.
- valueOid oid - The value of the input parameter as a basic type.
- valueContributor Contributor - The value of the input parameter as a basic type.
- valueString string - The value of the input parameter as a basic type.
- valuePositiveInt positiveInt - The value of the input parameter as a basic type.
- valueDuration Duration - The value of the input parameter as a basic type.
- valueDataRequirement DataRequirement - The value of the input parameter as a basic type.
- valueAnnotation Annotation - The value of the input parameter as a basic type.
health.fhir.r4.international401: TaskOutput
FHIR TaskOutput datatype record.
Fields
- Fields Included from *BackboneElement
- valueTime time - The value of the Output parameter as a basic type.
- valueTriggerDefinition TriggerDefinition - The value of the Output parameter as a basic type.
- valueMoney Money - The value of the Output parameter as a basic type.
- valueSignature Signature - The value of the Output parameter as a basic type.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'type CodeableConcept - The name of the Output parameter.
- valueUuid uuid - The value of the Output parameter as a basic type.
- valueRatio Ratio - The value of the Output parameter as a basic type.
- valueParameterDefinition ParameterDefinition - The value of the Output parameter as a basic 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.
- valueInteger integer - The value of the Output parameter as a basic type.
- valueUnsignedInt unsignedInt - The value of the Output parameter as a basic type.
- valueQuantity Quantity - The value of the Output parameter as a basic type.
- valueCanonical canonical - The value of the Output parameter as a basic type.
- valueCount Count - The value of the Output parameter as a basic type.
- valueId id - The value of the Output parameter as a basic type.
- valueCode code - The value of the Output parameter as a basic type.
- valueAddress Address - The value of the Output parameter as a basic type.
- valueContactPoint ContactPoint - The value of the Output parameter as a basic type.
- valuePeriod Period - The value of the Output parameter as a basic type.
- valueSampledData SampledData - The value of the Output parameter as a basic type.
- valueTiming Timing - The value of the Output parameter as a basic type.
- valueInstant instant - The value of the Output parameter as a basic type.
- valueAge Age - The value of the Output parameter as a basic type.
- valueDosage Dosage - The value of the Output parameter as a basic type.
- valueBase64Binary base64Binary - The value of the Output parameter as a basic type.
- valueBoolean boolean - The value of the Output parameter as a basic type.
- valueCoding Coding - The value of the Output parameter as a basic 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.
- valueIdentifier Identifier - The value of the Output parameter as a basic type.
- valueExpression Expression - The value of the Output parameter as a basic type.
- valueReference Reference - The value of the Output parameter as a basic type.
- valueRange Range - The value of the Output parameter as a basic type.
- valueUri uri - The value of the Output parameter as a basic type.
- valueDistance Distance - The value of the Output parameter as a basic type.
- valueUrl urlType - The value of the Output parameter as a basic type.
- valueContactDetail ContactDetail - The value of the Output parameter as a basic type.
- valueMeta Meta - The value of the Output parameter as a basic type.
- valueCodeableConcept CodeableConcept - The value of the Output parameter as a basic type.
- valueMarkdown markdown - The value of the Output parameter as a basic type.
- valueAttachment Attachment - The value of the Output parameter as a basic type.
- valueUsageContext UsageContext - The value of the Output parameter as a basic type.
- valueDateTime dateTime - The value of the Output parameter as a basic type.
- valueHumanName HumanName - The value of the Output parameter as a basic type.
- valueRelatedArtifact RelatedArtifact - The value of the Output parameter as a basic type.
- valueDecimal decimal - The value of the Output parameter as a basic type.
- valueDate date - The value of the Output parameter as a basic type.
- valueOid oid - The value of the Output parameter as a basic type.
- valueContributor Contributor - The value of the Output parameter as a basic type.
- valueString string - The value of the Output parameter as a basic type.
- valuePositiveInt positiveInt - The value of the Output parameter as a basic type.
- valueDuration Duration - The value of the Output parameter as a basic type.
- valueDataRequirement DataRequirement - The value of the Output parameter as a basic type.
- valueAnnotation Annotation - The value of the Output parameter as a basic type.
health.fhir.r4.international401: TaskRestriction
FHIR TaskRestriction 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? - Over what time-period is fulfillment sought.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- recipient Reference[]? - For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- repetitions positiveInt? - Indicates the number of times the requested action should occur.
health.fhir.r4.international401: TerminologyCapabilities
FHIR TerminologyCapabilities resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_TERMINOLOGYCAPABILITIES(default RESOURCE_NAME_TERMINOLOGYCAPABILITIES) - The type of the resource describes
- date dateTime - The date (and optionally time) when the terminology capabilities was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.
- copyright markdown? - A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.
- 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.
- software TerminologyCapabilitiesSoftware? - Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.
- purpose markdown? - Explanation of why this terminology capabilities is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the terminology capabilities is intended to be used.
- 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).
- codeSearch TerminologyCapabilitiesCodeSearch? - The degree to which the server supports the code search parameter on ValueSet, if it is supported.
- description markdown? - A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
- validateCode TerminologyCapabilitiesValidateCode? - Information about the ValueSet/$validate-code operation.
- experimental boolean? - A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the terminology capabilities.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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.
- closure TerminologyCapabilitiesClosure? - Whether the $closure operation is supported.
- codeSystem TerminologyCapabilitiesCodeSystem[]? - Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.
- kind TerminologyCapabilitiesKind - The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
- implementation TerminologyCapabilitiesImplementation? - Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.
- lockedDate boolean? - Whether the server supports lockedDate.
- 'version string? - The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri? - An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.
- expansion TerminologyCapabilitiesExpansion? - Information about the ValueSet/$expand operation.
- 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 string? - A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- translation TerminologyCapabilitiesTranslation? - Information about the ConceptMap/$translate operation.
- 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.
- publisher string? - The name of the organization or individual that published the terminology capabilities.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.
- status TerminologyCapabilitiesStatus - The status of this terminology capabilities. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: TerminologyCapabilitiesClosure
FHIR TerminologyCapabilitiesClosure 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).
- translation boolean? - If cross-system closure is supported.
- 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.international401: TerminologyCapabilitiesCodeSystem
FHIR TerminologyCapabilitiesCodeSystem 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).
- subsumption boolean? - True if subsumption is supported for this version of the code system.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- uri canonical? - URI for the Code System.
- 'version TerminologyCapabilitiesCodeSystemVersion[]? - For the code system, a list of versions that are supported by the server.
health.fhir.r4.international401: TerminologyCapabilitiesCodeSystemVersion
FHIR TerminologyCapabilitiesCodeSystemVersion datatype record.
Fields
- Fields Included from *BackboneElement
- filter TerminologyCapabilitiesCodeSystemVersionFilter[]? - Filter Properties supported.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- isDefault boolean? - If this is the default version for this code system.
- code string? - For version-less code systems, there should be a single version with no identifier.
- compositional boolean? - If the compositional grammar defined by the code system is supported.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- property code[]? - Properties supported for $lookup.
- language code[]? - Language Displays supported.
- 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.international401: TerminologyCapabilitiesCodeSystemVersionFilter
FHIR TerminologyCapabilitiesCodeSystemVersionFilter datatype record.
Fields
- Fields Included from *BackboneElement
- op code[] - Operations supported for the property.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code - Code of the property supported.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: TerminologyCapabilitiesExpansion
FHIR TerminologyCapabilitiesExpansion datatype record.
Fields
- Fields Included from *BackboneElement
- textFilter markdown? - Documentation about text searching works.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- incomplete boolean? - Allow request for incomplete expansions?
- hierarchical boolean? - Whether the server can return nested value sets.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'parameter TerminologyCapabilitiesExpansionParameter[]? - Supported expansion parameter.
- paging boolean? - Whether the server supports paging on expansion.
- 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.international401: TerminologyCapabilitiesExpansionParameter
FHIR TerminologyCapabilitiesExpansionParameter 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.
- documentation string? - Description of support for parameter.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 code - Expansion Parameter 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.
health.fhir.r4.international401: TerminologyCapabilitiesImplementation
FHIR TerminologyCapabilitiesImplementation 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 - Information about the specific installation that this terminology capability statement relates to.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- url urlType? - An absolute base URL for the implementation.
health.fhir.r4.international401: TerminologyCapabilitiesSoftware
FHIR TerminologyCapabilitiesSoftware 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 - Name the software is known by.
- 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 identifier for the software covered by this statement.
health.fhir.r4.international401: TerminologyCapabilitiesTranslation
FHIR TerminologyCapabilitiesTranslation 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).
- needsMap boolean - Whether the client must identify the map.
- 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.international401: TerminologyCapabilitiesValidateCode
FHIR TerminologyCapabilitiesValidateCode 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.
- translations boolean - Whether translations are validated.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: TestReport
FHIR TestReport resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_TESTREPORT(default RESOURCE_NAME_TESTREPORT) - The type of the resource describes
- identifier Identifier? - Identifier for the TestScript assigned for external purposes outside the context of FHIR.
- 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.
- test TestReportTest[]? - A test executed from the test script.
- 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).
- tester string? - Name of the tester producing this report (Organization or individual).
- language code? - The base language in which the resource is written.
- participant TestReportParticipant[]? - A participant in the test execution, either the execution engine, a client, or a server.
- result TestReportResult - The overall result from the execution of the TestScript.
- score decimal? - The final score (percentage of tests passed) resulting from the execution of the TestScript.
- 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.
- testScript Reference - Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the
TestScript.url
.
- name string? - A free text natural language name identifying the executed TestScript.
- 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.
- setup TestReportSetup? - The results of the series of required setup operations before the tests were executed.
- 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 dateTime? - When the TestScript was executed and this TestReport was generated.
- teardown TestReportTeardown? - The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).
- status TestReportStatus - The current state of this test report.
- Element... - Rest field
health.fhir.r4.international401: TestReportParticipant
FHIR TestReportParticipant 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.
- display string? - The display name of the participant.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 TestReportParticipantType - The type of participant.
- uri uri - The uri of the participant. An absolute URL is preferred.
health.fhir.r4.international401: TestReportSetup
FHIR TestReportSetup 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 TestReportSetupAction[] - Action would contain either an operation or an assertion.
- 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.international401: TestReportSetupAction
FHIR TestReportSetupAction 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.
- assert TestReportSetupActionAssert? - The results of the assertion performed on the previous operations.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- operation TestReportSetupActionOperation? - The operation performed.
health.fhir.r4.international401: TestReportSetupActionAssert
FHIR TestReportSetupActionAssert datatype record.
Fields
- Fields Included from *BackboneElement
- result TestReportSetupActionAssertResult - The result of this assertion.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- detail string? - A link to further details on the result.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- message markdown? - An explanatory message associated with the result.
health.fhir.r4.international401: TestReportSetupActionOperation
FHIR TestReportSetupActionOperation datatype record.
Fields
- Fields Included from *BackboneElement
- result TestReportSetupActionOperationResult - The result of this operation.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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).
- detail uri? - A link to further details on the result.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- message markdown? - An explanatory message associated with the result.
health.fhir.r4.international401: TestReportTeardown
FHIR TestReportTeardown 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 TestReportTeardownAction[] - The teardown action will only contain an operation.
- 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.international401: TestReportTeardownAction
FHIR TestReportTeardownAction 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.
health.fhir.r4.international401: TestReportTest
FHIR TestReportTest 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 this test used for tracking/logging purposes by test engines.
- action TestReportTestAction[] - Action would contain either an operation or an assertion.
- description string? - A short description of the test used by test engines for tracking and reporting purposes.
- 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.international401: TestReportTestAction
FHIR TestReportTestAction 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.
health.fhir.r4.international401: TestScript
FHIR TestScript resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_TESTSCRIPT(default RESOURCE_NAME_TESTSCRIPT) - The type of the resource describes
- date dateTime? - The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
- copyright markdown? - A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
- 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.
- metadata TestScriptMetadata? - The required capability must exist and are assumed to function correctly on the FHIR server being tested.
- purpose markdown? - Explanation of why this test script is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the test script is intended to be used.
- 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).
- origin TestScriptOrigin[]? - An abstract server used in operations within this test script in the origin element.
- destination TestScriptDestination[]? - An abstract server used in operations within this test script in the destination element.
- description markdown? - A free text natural language description of the test script from a consumer's perspective.
- experimental boolean? - A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language code? - The base language in which the resource is written.
- title string? - A short, descriptive, user-friendly title for the test script.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- 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.
- teardown TestScriptTeardown? - A series of operations required to clean up after all the tests are executed (successfully or otherwise).
- identifier Identifier? - A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
- test TestScriptTest[]? - A test in this script.
- profile Reference[]? - Reference to the profile to be used for validation.
- 'version string? - The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url uri - An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.
- fixture TestScriptFixture[]? - Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
- 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 string - A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- variable TestScriptVariable[]? - Variable is set based either on element value in response body or on header field value in the response headers.
- 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.
- publisher string? - The name of the organization or individual that published the test script.
- setup TestScriptSetup? - A series of required setup operations before tests are executed.
- useContext UsageContext[]? - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.
- status TestScriptStatus - The status of this test script. Enables tracking the life-cycle of the content.
- Element... - Rest field
health.fhir.r4.international401: TestScriptDestination
FHIR TestScriptDestination 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).
- profile Coding - The type of destination profile the test system supports.
- index integer - Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
- 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.international401: TestScriptFixture
FHIR TestScriptFixture 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.
- 'resource Reference? - Reference to the resource (containing the contents of the resource needed for operations).
- autocreate boolean - Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.
- autodelete boolean - Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.international401: TestScriptMetadata
FHIR TestScriptMetadata datatype record.
Fields
- Fields Included from *BackboneElement
- capability TestScriptMetadataCapability[] - Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 TestScriptMetadataLink[]? - A link to the FHIR specification that this test is covering.
- 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.international401: TestScriptMetadataCapability
FHIR TestScriptMetadataCapability 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.
- capabilities canonical - Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.
- validated boolean - Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- origin integer[]? - Which origin server these requirements apply to.
- destination integer? - Which server these requirements apply to.
- link uri[]? - Links to the FHIR specification that describes this interaction and the resources involved in more detail.
- description string? - Description of the capabilities that this test script is requiring the server to support.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- required boolean - Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
health.fhir.r4.international401: TestScriptMetadataLink
FHIR TestScriptMetadataLink 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? - Short description of the link.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- url uri - URL to a particular requirement or feature within the FHIR specification.
health.fhir.r4.international401: TestScriptOrigin
FHIR TestScriptOrigin 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).
- profile Coding - The type of origin profile the test system supports.
- index integer - Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.
- 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.international401: TestScriptSetup
FHIR TestScriptSetup 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 TestScriptSetupAction[] - Action would contain either an operation or an assertion.
- 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.international401: TestScriptSetupAction
FHIR TestScriptSetupAction 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.
- assert TestScriptSetupActionAssert? - Evaluates the results of previous operations to determine if the server under test behaves appropriately.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- operation TestScriptSetupActionOperation? - The operation to perform.
health.fhir.r4.international401: TestScriptSetupActionAssert
FHIR TestScriptSetupActionAssert datatype record.
Fields
- Fields Included from *BackboneElement
- sourceId id? - Fixture to evaluate the XPath/JSONPath expression or the headerField against.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- headerField string? - The HTTP header field name e.g. 'Location'.
- minimumId string? - The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- requestMethod TestScriptSetupActionAssertRequestMethod? - The request method or HTTP operation code to compare against that used by the client system under test.
- description string? - The description would be used by test engines for tracking and reporting purposes.
- operator TestScriptSetupActionAssertOperator? - The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
- responseCode string? - The value of the HTTP response code to be tested.
- path string? - The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
- requestURL string? - The value to use in a comparison against the request URL path string.
- validateProfileId id? - The ID of the Profile to validate against.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- contentType code? - The mime-type contents to compare against the request or response message 'Content-Type' header.
- value string? - The value to compare to.
- direction TestScriptSetupActionAssertDirection? - The direction to use for the assertion.
- compareToSourceId string? - Id of the source fixture used as the contents to be evaluated by either the 'source/expression' or 'sourceId/path' definition.
- expression string? - The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.
- 'resource code? - The type of the resource. See http://build.fhir.org/resourcelist.html.
- compareToSourcePath string? - XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
- label string? - The label would be used for tracking/logging purposes by test engines.
- compareToSourceExpression string? - The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
- navigationLinks boolean? - Whether or not the test execution performs validation on the bundle navigation links.
- response TestScriptSetupActionAssertResponse? - okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
- warningOnly boolean - Whether or not the test execution will produce a warning only on error for this assert.
health.fhir.r4.international401: TestScriptSetupActionOperation
FHIR TestScriptSetupActionOperation datatype record.
Fields
- Fields Included from *BackboneElement
- sourceId id? - The id of the fixture used as the body of a PUT or POST request.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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 TestScriptSetupActionOperationMethod? - The HTTP method the test engine MUST use for this operation regardless of any other operation details.
- targetId id? - Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
- 'resource code? - The type of the resource. See http://build.fhir.org/resourcelist.html.
- encodeRequestUrl boolean - Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- origin integer? - The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
- destination integer? - The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
- description string? - The description would be used by test engines for tracking and reporting purposes.
- label string? - The label would be used for tracking/logging purposes by test engines.
- params string? - Path plus parameters after [type]. Used to set parts of the request URL explicitly.
- 'type Coding? - Server interaction or operation type.
- url string? - Complete request URL.
- accept code? - The mime-type to use for RESTful operation in the 'Accept' header.
- requestId id? - The fixture id (maybe new) to map to the request.
- requestHeader TestScriptSetupActionOperationRequestHeader[]? - Header elements would be used to set HTTP headers.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- contentType code? - The mime-type to use for RESTful operation in the 'Content-Type' header.
- responseId id? - The fixture id (maybe new) to map to the response.
health.fhir.r4.international401: TestScriptSetupActionOperationRequestHeader
FHIR TestScriptSetupActionOperationRequestHeader 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.
- 'field string - The HTTP header field e.g. 'Accept'.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- value string - The value of the header e.g. 'application/fhir+xml'.
health.fhir.r4.international401: TestScriptTeardown
FHIR TestScriptTeardown 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 TestScriptTeardownAction[] - The teardown action will only contain an operation.
- 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.international401: TestScriptTeardownAction
FHIR TestScriptTeardownAction 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.
health.fhir.r4.international401: TestScriptTest
FHIR TestScriptTest 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 this test used for tracking/logging purposes by test engines.
- action TestScriptTestAction[] - Action would contain either an operation or an assertion.
- description string? - A short description of the test used by test engines for tracking and reporting purposes.
- 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.international401: TestScriptTestAction
FHIR TestScriptTestAction 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.
health.fhir.r4.international401: TestScriptVariable
FHIR TestScriptVariable datatype record.
Fields
- Fields Included from *BackboneElement
- sourceId id? - Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
- path string? - XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- headerField string? - Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
- expression string? - The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
- defaultValue string? - A default, hard-coded, or user-defined value for this variable.
- hint string? - Displayable text string with hint help information to the user when entering a default 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).
- name string - Descriptive name for this variable.
- description string? - A free text natural language description of the variable and its purpose.
- 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.international401: VerificationResult
FHIR VerificationResult resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_VERIFICATIONRESULT(default RESOURCE_NAME_VERIFICATIONRESULT) - The type of the resource describes
- statusDate dateTime? - When the validation status was updated.
- nextScheduled date? - The date when target is next validated, if appropriate.
- primarySource VerificationResultPrimarySource[]? - Information about the primary source(s) involved in validation.
- 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.
- attestation VerificationResultAttestation? - Information about the entity attesting to information.
- failureAction CodeableConcept? - The result if validation fails (fatal; warning; record only; none).
- need CodeableConcept? - The frequency with which the target must be validated (none; initial; periodic).
- 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).
- validationType CodeableConcept? - What the target is validated against (nothing; primary source; multiple sources).
- validator VerificationResultValidator[]? - Information about the entity validating information.
- language code? - The base language in which the resource is written.
- targetLocation string[]? - The fhirpath location(s) within the resource that was validated.
- frequency Timing? - Frequency of revalidation.
- target Reference[]? - A resource that was validated.
- 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.
- lastPerformed dateTime? - The date/time validation was last completed (including failed validations).
- 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.
- validationProcess CodeableConcept[]? - The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
- status VerificationResultStatus - The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
- Element... - Rest field
health.fhir.r4.international401: VerificationResultAttestation
FHIR VerificationResultAttestation datatype record.
Fields
- Fields Included from *BackboneElement
- date date? - The date the information was attested to.
- sourceIdentityCertificate string? - A digital identity certificate associated with the attestation source.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- proxyIdentityCertificate string? - A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.
- communicationMethod CodeableConcept? - The method by which attested information was submitted/retrieved (manual; API; Push).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? - When the who is asserting on behalf of another (organization or individual).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- proxySignature Signature? - Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.
- sourceSignature Signature? - Signed assertion by the attestation source that they have attested to the information.
- who Reference? - The individual or organization attesting to information.
health.fhir.r4.international401: VerificationResultPrimarySource
FHIR VerificationResultPrimarySource 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.
- pushTypeAvailable CodeableConcept[]? - Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).
- communicationMethod CodeableConcept[]? - Method for communicating with the primary source (manual; API; Push).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
- validationDate dateTime? - When the target was validated against the primary source.
- 'type CodeableConcept[]? - Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).
- validationStatus CodeableConcept? - Status of the validation of the target against the primary source (successful; failed; unknown).
- canPushUpdates CodeableConcept? - Ability of the primary source to push updates/alerts (yes; no; undetermined).
- who Reference? - Reference to the primary source.
health.fhir.r4.international401: VerificationResultValidator
FHIR VerificationResultValidator 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).
- organization Reference - Reference to the organization validating information.
- identityCertificate string? - A digital identity certificate associated with the validator.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- attestationSignature Signature? - Signed assertion by the validator that they have validated the information.
health.fhir.r4.international401: VisionPrescription
FHIR VisionPrescription resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_VISIONPRESCRIPTION(default RESOURCE_NAME_VISIONPRESCRIPTION) - The type of the resource describes
- prescriber Reference - The healthcare professional responsible for authorizing the prescription.
- identifier Identifier[]? - A unique identifier assigned to this vision prescription.
- 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.
- created dateTime - The date this resource was created.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- encounter Reference? - A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.
- lensSpecification VisionPrescriptionLensSpecification[] - Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.
- dateWritten dateTime - The date (and perhaps time) when the prescription was written.
- contained Resource[]? - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- meta Meta? - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- patient Reference - A resource reference to the person to whom the vision prescription applies.
- 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 VisionPrescriptionStatus - The status of the resource instance.
- Element... - Rest field
health.fhir.r4.international401: VisionPrescriptionLensSpecification
FHIR VisionPrescriptionLensSpecification datatype record.
Fields
- Fields Included from *BackboneElement
- add decimal? - Power adjustment for multifocal lenses measured in dioptres (0.25 units).
- note Annotation[]? - Notes for special requirements such as coatings and lens materials.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- product CodeableConcept - Identifies the type of vision correction product which is required for the patient.
- backCurve decimal? - Back curvature measured in millimetres.
- color string? - Special color or pattern.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- axis integer? - Adjustment for astigmatism measured in integer degrees.
- duration Quantity? - The recommended maximum wear period for the lens.
- eye VisionPrescriptionLensSpecificationEye - The eye for which the lens specification applies.
- diameter decimal? - Contact lens diameter measured in millimetres.
- sphere decimal? - Lens power measured in dioptres (0.25 units).
- cylinder decimal? - Power adjustment for astigmatism measured in dioptres (0.25 units).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- power decimal? - Contact lens power measured in dioptres (0.25 units).
- brand string? - Brand recommendations or restrictions.
- prism VisionPrescriptionLensSpecificationPrism[]? - Allows for adjustment on two axis.
health.fhir.r4.international401: VisionPrescriptionLensSpecificationPrism
FHIR VisionPrescriptionLensSpecificationPrism datatype record.
Fields
- Fields Included from *BackboneElement
- amount decimal - Amount of prism to compensate for eye alignment in fractional units.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
- base VisionPrescriptionLensSpecificationPrismBase - The relative base, or reference lens edge, for the prism.
Import
import ballerinax/health.fhir.r4.international401;
Metadata
Released date: 12 months ago
Version: 1.0.2
Compatibility
Platform: any
Ballerina version: 2201.7.0
Pull count
Total: 248
Current verison: 96
Weekly downloads
Keywords
Healthcare
FHIR
R4
International
Contributors