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