Module health.fhir.r5.international500

ballerinax/health.fhir.r5.international500 Ballerina library

1.0.1

Ballerina package containing FHIR resource data models compliant with http://hl7.org/fhir/ implementation guide.

FHIR R5 health_fhir_r5_international500 package

Package Overview


FHIR version	R5
Implementation Guide	http://hl7.org/fhir/R5

Note: This package only supports FHIR JSON payload format only. FHIR XML payload support will be added soon.

Capabilities and features

Supported FHIR resource types


1). Appointment	[Definition] [Ballerina Record]
2). RequestOrchestration	[Definition] [Ballerina Record]
3). MessageDefinition	[Definition] [Ballerina Record]
4). Endpoint	[Definition] [Ballerina Record]
5). Consent	[Definition] [Ballerina Record]
6). ArtifactAssessment	[Definition] [Ballerina Record]
7). Measure	[Definition] [Ballerina Record]
8). Permission	[Definition] [Ballerina Record]
9). ActorDefinition	[Definition] [Ballerina Record]
10). ConditionDefinition	[Definition] [Ballerina Record]
11). DocumentReference	[Definition] [Ballerina Record]
12). GraphDefinition	[Definition] [Ballerina Record]
13). Parameters	[Definition] [Ballerina Record]
14). PublishableNamingSystem	[Definition] [Ballerina Record]
15). MeasureReport	[Definition] [Ballerina Record]
16). PractitionerRole	[Definition] [Ballerina Record]
17). CDSHooksGuidanceResponse	[Definition] [Ballerina Record]
18). DeviceUsage	[Definition] [Ballerina Record]
19). PackagedProductDefinition	[Definition] [Ballerina Record]
20). ServiceRequest	[Definition] [Ballerina Record]
21). BodyStructure	[Definition] [Ballerina Record]
22). Slot	[Definition] [Ballerina Record]
23). PublishableActivityDefinition	[Definition] [Ballerina Record]
24). SubscriptionTopic	[Definition] [Ballerina Record]
25). PaymentNotice	[Definition] [Ballerina Record]
26). Group	[Definition] [Ballerina Record]
27). ImplementationGuide	[Definition] [Ballerina Record]
28). CareTeam	[Definition] [Ballerina Record]
29). ImagingStudy	[Definition] [Ballerina Record]
30). ClinicalUseDefinition	[Definition] [Ballerina Record]
31). FamilyMemberHistory	[Definition] [Ballerina Record]
32). Observationheartrate	[Definition] [Ballerina Record]
33). ObservationDefinition	[Definition] [Ballerina Record]
34). Substance	[Definition] [Ballerina Record]
35). Communication	[Definition] [Ballerina Record]
36). ShareableLibrary	[Definition] [Ballerina Record]
37). ShareableConceptMap	[Definition] [Ballerina Record]
38). DocumentStructure	[Definition] [Ballerina Record]
39). ImmunizationEvaluation	[Definition] [Ballerina Record]
40). EBMRecommendation	[Definition] [Ballerina Record]
41). Observationbodytemp	[Definition] [Ballerina Record]
42). ActualGroup	[Definition] [Ballerina Record]
43). MessageHeader	[Definition] [Ballerina Record]
44). ManufacturedItemDefinition	[Definition] [Ballerina Record]
45). Provenance	[Definition] [Ballerina Record]
46). Questionnaire	[Definition] [Ballerina Record]
47). PublishableLibrary	[Definition] [Ballerina Record]
48). Observationbodyweight	[Definition] [Ballerina Record]
49). ExplanationOfBenefit	[Definition] [Ballerina Record]
50). ResearchStudy	[Definition] [Ballerina Record]
51). DeviceAssociation	[Definition] [Ballerina Record]
52). StructureDefinition	[Definition] [Ballerina Record]
53). Observationvitalspanel	[Definition] [Ballerina Record]
54). CarePlan	[Definition] [Ballerina Record]
55). Procedure	[Definition] [Ballerina Record]
56). List	[Definition] [Ballerina Record]
57). ConceptMap	[Definition] [Ballerina Record]
58). ELMLibrary	[Definition] [Ballerina Record]
59). Immunization	[Definition] [Ballerina Record]
60). BiologicallyDerivedProduct	[Definition] [Ballerina Record]
61). VisionPrescription	[Definition] [Ballerina Record]
62). EvidenceVariable	[Definition] [Ballerina Record]
63). ImagingSelection	[Definition] [Ballerina Record]
64). DeviceMetric	[Definition] [Ballerina Record]
65). ProfileForCatalog	[Definition] [Ballerina Record]
66). CDSHooksServicePlanDefinition	[Definition] [Ballerina Record]
67). AdverseEvent	[Definition] [Ballerina Record]
68). MedicinalProductDefinition	[Definition] [Ballerina Record]
69). GuidanceResponse	[Definition] [Ballerina Record]
70). Observation	[Definition] [Ballerina Record]
71). MedicationAdministration	[Definition] [Ballerina Record]
72). EnrollmentResponse	[Definition] [Ballerina Record]
73). Binary	[Definition] [Ballerina Record]
74). ShareablePlanDefinition	[Definition] [Ballerina Record]
75). TestScript	[Definition] [Ballerina Record]
76). GenomicStudy	[Definition] [Ballerina Record]
77). InventoryItem	[Definition] [Ballerina Record]
78). SubstancePolymer	[Definition] [Ballerina Record]
79). ClaimResponse	[Definition] [Ballerina Record]
80). MedicationDispense	[Definition] [Ballerina Record]
81). ExampleLipidProfile	[Definition] [Ballerina Record]
82). OrganizationAffiliation	[Definition] [Ballerina Record]
83). DiagnosticReport	[Definition] [Ballerina Record]
84). Observationbp	[Definition] [Ballerina Record]
85). NutritionOrder	[Definition] [Ballerina Record]
86). TerminologyCapabilities	[Definition] [Ballerina Record]
87). Evidence	[Definition] [Ballerina Record]
88). Citation	[Definition] [Ballerina Record]
89). Condition	[Definition] [Ballerina Record]
90). Composition	[Definition] [Ballerina Record]
91). Observationoxygensat	[Definition] [Ballerina Record]
92). DeviceMetricObservationProfile	[Definition] [Ballerina Record]
93). Patient	[Definition] [Ballerina Record]
94). Coverage	[Definition] [Ballerina Record]
95). QuestionnaireResponse	[Definition] [Ballerina Record]
96). Observationbmi	[Definition] [Ballerina Record]
97). NamingSystem	[Definition] [Ballerina Record]
98). ExampleScenario	[Definition] [Ballerina Record]
99). SupplyDelivery	[Definition] [Ballerina Record]
100). Schedule	[Definition] [Ballerina Record]
101). DeviceDefinition	[Definition] [Ballerina Record]
102). PlanDefinition	[Definition] [Ballerina Record]
103). Location	[Definition] [Ballerina Record]
104). AdministrableProductDefinition	[Definition] [Ballerina Record]
105). Account	[Definition] [Ballerina Record]
106). ShareableMeasure	[Definition] [Ballerina Record]
107). Invoice	[Definition] [Ballerina Record]
108). Observationheadcircum	[Definition] [Ballerina Record]
109). EventDefinition	[Definition] [Ballerina Record]
110). FormularyItem	[Definition] [Ballerina Record]
111). Goal	[Definition] [Ballerina Record]
112). DocumentSectionLibrary	[Definition] [Ballerina Record]
113). EnrollmentRequest	[Definition] [Ballerina Record]
114). PublishableMeasure	[Definition] [Ballerina Record]
115). GroupDefinition	[Definition] [Ballerina Record]
116). Medication	[Definition] [Ballerina Record]
117). Observationvitalsigns	[Definition] [Ballerina Record]
118). CapabilityStatement	[Definition] [Ballerina Record]
119). FamilyMemberHistoryForGeneticsAnalysis	[Definition] [Ballerina Record]
120). ResearchSubject	[Definition] [Ballerina Record]
121). Subscription	[Definition] [Ballerina Record]
122). MetadataResource	[Definition] [Ballerina Record]
123). LogicLibrary	[Definition] [Ballerina Record]
124). CoverageEligibilityResponse	[Definition] [Ballerina Record]
125). ModuleDefinitionLibrary	[Definition] [Ballerina Record]
126). SubstanceReferenceInformation	[Definition] [Ballerina Record]
127). ProvenanceRelevantHistory	[Definition] [Ballerina Record]
128). RelatedPerson	[Definition] [Ballerina Record]
129). SupplyRequest	[Definition] [Ballerina Record]
130). Practitioner	[Definition] [Ballerina Record]
131). VerificationResult	[Definition] [Ballerina Record]
132). NutritionProduct	[Definition] [Ballerina Record]
133). SubstanceProtein	[Definition] [Ballerina Record]
134). ComputablePlanDefinition	[Definition] [Ballerina Record]
135). Transport	[Definition] [Ballerina Record]
136). Contract	[Definition] [Ballerina Record]
137). Person	[Definition] [Ballerina Record]
138). RiskAssessment	[Definition] [Ballerina Record]
139). SubstanceDefinition	[Definition] [Ballerina Record]
140). Organization	[Definition] [Ballerina Record]
141). PublishablePlanDefinition	[Definition] [Ballerina Record]
142). ChargeItem	[Definition] [Ballerina Record]
143). ClinicalDocument	[Definition] [Ballerina Record]
144). Encounter	[Definition] [Ballerina Record]
145). SearchParameter	[Definition] [Ballerina Record]
146). InsurancePlan	[Definition] [Ballerina Record]
147). ActivityDefinition	[Definition] [Ballerina Record]
148). Linkage	[Definition] [Ballerina Record]
149). SubstanceSourceMaterial	[Definition] [Ballerina Record]
150). ModelInfoLibrary	[Definition] [Ballerina Record]
151). Ingredient	[Definition] [Ballerina Record]
152). DeviceDispense	[Definition] [Ballerina Record]
153). ShareableNamingSystem	[Definition] [Ballerina Record]
154). DeviceRequest	[Definition] [Ballerina Record]
155). ImmunizationRecommendation	[Definition] [Ballerina Record]
156). Task	[Definition] [Ballerina Record]
157). TestPlan	[Definition] [Ballerina Record]
158). BiologicallyDerivedProductDispense	[Definition] [Ballerina Record]
159). Requirements	[Definition] [Ballerina Record]
160). Specimen	[Definition] [Ballerina Record]
161). AllergyIntolerance	[Definition] [Ballerina Record]
162). ChargeItemDefinition	[Definition] [Ballerina Record]
163). EpisodeOfCare	[Definition] [Ballerina Record]
164). OperationDefinition	[Definition] [Ballerina Record]
165). Observationresprate	[Definition] [Ballerina Record]
166). MedicationRequest	[Definition] [Ballerina Record]
167). ShareableActivityDefinition	[Definition] [Ballerina Record]
168). Device	[Definition] [Ballerina Record]
169). EncounterHistory	[Definition] [Ballerina Record]
170). MolecularSequence	[Definition] [Ballerina Record]
171). Flag	[Definition] [Ballerina Record]
172). SubstanceNucleicAcid	[Definition] [Ballerina Record]
173). AppointmentResponse	[Definition] [Ballerina Record]
174). StructureMap	[Definition] [Ballerina Record]
175). RegulatedAuthorization	[Definition] [Ballerina Record]
176). Library	[Definition] [Ballerina Record]
177). MedicationStatement	[Definition] [Ballerina Record]
178). CommunicationRequest	[Definition] [Ballerina Record]
179). Basic	[Definition] [Ballerina Record]
180). TestReport	[Definition] [Ballerina Record]
181). Observationbodyheight	[Definition] [Ballerina Record]
182). HealthcareService	[Definition] [Ballerina Record]
183). InventoryReport	[Definition] [Ballerina Record]
184). EvidenceReport	[Definition] [Ballerina Record]
185). ShareableTestScript	[Definition] [Ballerina Record]
186). PublishableConceptMap	[Definition] [Ballerina Record]
187). AuditEvent	[Definition] [Ballerina Record]
188). PaymentReconciliation	[Definition] [Ballerina Record]
189). SpecimenDefinition	[Definition] [Ballerina Record]
190). CQLLibrary	[Definition] [Ballerina Record]
191). DetectedIssue	[Definition] [Ballerina Record]
192). CompartmentDefinition	[Definition] [Ballerina Record]
193). FHIRPathLibrary	[Definition] [Ballerina Record]
194). MedicationKnowledge	[Definition] [Ballerina Record]
195). CoverageEligibilityRequest	[Definition] [Ballerina Record]
196). SubscriptionStatus	[Definition] [Ballerina Record]
197). CDSHooksRequestOrchestration	[Definition] [Ballerina Record]
198). ClinicalImpression	[Definition] [Ballerina Record]
199). NutritionIntake	[Definition] [Ballerina Record]
200). CanonicalResource	[Definition] [Ballerina Record]
201). Claim	[Definition] [Ballerina Record]

Functions

initialize

Isolated Function

function initialize()

This empty function is used to initialize the module by other modules/packages.

Constants

health.fhir.r5.international500: PROFILE_BASE_ACCOUNT

string "http://hl7.org/fhir/StructureDefinition/Account"

health.fhir.r5.international500: PROFILE_BASE_ACTIVITYDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"

health.fhir.r5.international500: PROFILE_BASE_ACTORDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ActorDefinition"

health.fhir.r5.international500: PROFILE_BASE_ACTUALGROUP

string "http://hl7.org/fhir/StructureDefinition/actualgroup"

health.fhir.r5.international500: PROFILE_BASE_ADMINISTRABLEPRODUCTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition"

health.fhir.r5.international500: PROFILE_BASE_ADVERSEEVENT

string "http://hl7.org/fhir/StructureDefinition/AdverseEvent"

health.fhir.r5.international500: PROFILE_BASE_ALLERGYINTOLERANCE

string "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"

health.fhir.r5.international500: PROFILE_BASE_APPOINTMENT

string "http://hl7.org/fhir/StructureDefinition/Appointment"

health.fhir.r5.international500: PROFILE_BASE_APPOINTMENTRESPONSE

string "http://hl7.org/fhir/StructureDefinition/AppointmentResponse"

health.fhir.r5.international500: PROFILE_BASE_ARTIFACTASSESSMENT

string "http://hl7.org/fhir/StructureDefinition/ArtifactAssessment"

health.fhir.r5.international500: PROFILE_BASE_AUDITEVENT

string "http://hl7.org/fhir/StructureDefinition/AuditEvent"

health.fhir.r5.international500: PROFILE_BASE_BASIC

string "http://hl7.org/fhir/StructureDefinition/Basic"

health.fhir.r5.international500: PROFILE_BASE_BINARY

string "http://hl7.org/fhir/StructureDefinition/Binary"

health.fhir.r5.international500: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCT

string "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"

health.fhir.r5.international500: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCTDISPENSE

string "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProductDispense"

health.fhir.r5.international500: PROFILE_BASE_BODYSTRUCTURE

string "http://hl7.org/fhir/StructureDefinition/BodyStructure"

health.fhir.r5.international500: PROFILE_BASE_CANONICALRESOURCE

string "http://hl7.org/fhir/StructureDefinition/CanonicalResource"

health.fhir.r5.international500: PROFILE_BASE_CAPABILITYSTATEMENT

string "http://hl7.org/fhir/StructureDefinition/CapabilityStatement"

health.fhir.r5.international500: PROFILE_BASE_CAREPLAN

string "http://hl7.org/fhir/StructureDefinition/CarePlan"

health.fhir.r5.international500: PROFILE_BASE_CARETEAM

string "http://hl7.org/fhir/StructureDefinition/CareTeam"

health.fhir.r5.international500: PROFILE_BASE_CDSHOOKSGUIDANCERESPONSE

string "http://hl7.org/fhir/StructureDefinition/cdshooksguidanceresponse"

health.fhir.r5.international500: PROFILE_BASE_CDSHOOKSREQUESTORCHESTRATION

string "http://hl7.org/fhir/StructureDefinition/cdshooksrequestorchestration"

health.fhir.r5.international500: PROFILE_BASE_CDSHOOKSSERVICEPLANDEFINITION

string "http://hl7.org/fhir/StructureDefinition/cdshooksserviceplandefinition"

health.fhir.r5.international500: PROFILE_BASE_CHARGEITEM

string "http://hl7.org/fhir/StructureDefinition/ChargeItem"

health.fhir.r5.international500: PROFILE_BASE_CHARGEITEMDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"

health.fhir.r5.international500: PROFILE_BASE_CITATION

string "http://hl7.org/fhir/StructureDefinition/Citation"

health.fhir.r5.international500: PROFILE_BASE_CLAIM

string "http://hl7.org/fhir/StructureDefinition/Claim"

health.fhir.r5.international500: PROFILE_BASE_CLAIMRESPONSE

string "http://hl7.org/fhir/StructureDefinition/ClaimResponse"

health.fhir.r5.international500: PROFILE_BASE_CLINICALDOCUMENT

string "http://hl7.org/fhir/StructureDefinition/clinicaldocument"

health.fhir.r5.international500: PROFILE_BASE_CLINICALIMPRESSION

string "http://hl7.org/fhir/StructureDefinition/ClinicalImpression"

health.fhir.r5.international500: PROFILE_BASE_CLINICALUSEDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ClinicalUseDefinition"

health.fhir.r5.international500: PROFILE_BASE_COMMUNICATION

string "http://hl7.org/fhir/StructureDefinition/Communication"

health.fhir.r5.international500: PROFILE_BASE_COMMUNICATIONREQUEST

string "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"

health.fhir.r5.international500: PROFILE_BASE_COMPARTMENTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"

health.fhir.r5.international500: PROFILE_BASE_COMPOSITION

string "http://hl7.org/fhir/StructureDefinition/Composition"

health.fhir.r5.international500: PROFILE_BASE_COMPUTABLEPLANDEFINITION

string "http://hl7.org/fhir/StructureDefinition/computableplandefinition"

health.fhir.r5.international500: PROFILE_BASE_CONCEPTMAP

string "http://hl7.org/fhir/StructureDefinition/ConceptMap"

health.fhir.r5.international500: PROFILE_BASE_CONDITION

string "http://hl7.org/fhir/StructureDefinition/Condition"

health.fhir.r5.international500: PROFILE_BASE_CONDITIONDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ConditionDefinition"

health.fhir.r5.international500: PROFILE_BASE_CONSENT

string "http://hl7.org/fhir/StructureDefinition/Consent"

health.fhir.r5.international500: PROFILE_BASE_CONTRACT

string "http://hl7.org/fhir/StructureDefinition/Contract"

health.fhir.r5.international500: PROFILE_BASE_COVERAGE

string "http://hl7.org/fhir/StructureDefinition/Coverage"

health.fhir.r5.international500: PROFILE_BASE_COVERAGEELIGIBILITYREQUEST

string "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"

health.fhir.r5.international500: PROFILE_BASE_COVERAGEELIGIBILITYRESPONSE

string "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse"

health.fhir.r5.international500: PROFILE_BASE_CQLLIBRARY

string "http://hl7.org/fhir/StructureDefinition/cqllibrary"

health.fhir.r5.international500: PROFILE_BASE_DETECTEDISSUE

string "http://hl7.org/fhir/StructureDefinition/DetectedIssue"

health.fhir.r5.international500: PROFILE_BASE_DEVICE

string "http://hl7.org/fhir/StructureDefinition/Device"

health.fhir.r5.international500: PROFILE_BASE_DEVICEASSOCIATION

string "http://hl7.org/fhir/StructureDefinition/DeviceAssociation"

health.fhir.r5.international500: PROFILE_BASE_DEVICEDEFINITION

string "http://hl7.org/fhir/StructureDefinition/DeviceDefinition"

health.fhir.r5.international500: PROFILE_BASE_DEVICEDISPENSE

string "http://hl7.org/fhir/StructureDefinition/DeviceDispense"

health.fhir.r5.international500: PROFILE_BASE_DEVICEMETRIC

string "http://hl7.org/fhir/StructureDefinition/DeviceMetric"

health.fhir.r5.international500: PROFILE_BASE_DEVICEMETRICOBSERVATIONPROFILE

string "http://hl7.org/fhir/StructureDefinition/devicemetricobservation"

health.fhir.r5.international500: PROFILE_BASE_DEVICEREQUEST

string "http://hl7.org/fhir/StructureDefinition/DeviceRequest"

health.fhir.r5.international500: PROFILE_BASE_DEVICEUSAGE

string "http://hl7.org/fhir/StructureDefinition/DeviceUsage"

health.fhir.r5.international500: PROFILE_BASE_DIAGNOSTICREPORT

string "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"

health.fhir.r5.international500: PROFILE_BASE_DOCUMENTREFERENCE

string "http://hl7.org/fhir/StructureDefinition/DocumentReference"

health.fhir.r5.international500: PROFILE_BASE_DOCUMENTSECTIONLIBRARY

string "http://hl7.org/fhir/StructureDefinition/example-section-library"

health.fhir.r5.international500: PROFILE_BASE_DOCUMENTSTRUCTURE

string "http://hl7.org/fhir/StructureDefinition/example-composition"

health.fhir.r5.international500: PROFILE_BASE_EBMRECOMMENDATION

string "http://hl7.org/fhir/StructureDefinition/ebmrecommendation"

health.fhir.r5.international500: PROFILE_BASE_ELMLIBRARY

string "http://hl7.org/fhir/StructureDefinition/elmlibrary"

health.fhir.r5.international500: PROFILE_BASE_ENCOUNTER

string "http://hl7.org/fhir/StructureDefinition/Encounter"

health.fhir.r5.international500: PROFILE_BASE_ENCOUNTERHISTORY

string "http://hl7.org/fhir/StructureDefinition/EncounterHistory"

health.fhir.r5.international500: PROFILE_BASE_ENDPOINT

string "http://hl7.org/fhir/StructureDefinition/Endpoint"

health.fhir.r5.international500: PROFILE_BASE_ENROLLMENTREQUEST

string "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"

health.fhir.r5.international500: PROFILE_BASE_ENROLLMENTRESPONSE

string "http://hl7.org/fhir/StructureDefinition/EnrollmentResponse"

health.fhir.r5.international500: PROFILE_BASE_EPISODEOFCARE

string "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"

health.fhir.r5.international500: PROFILE_BASE_EVENTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/EventDefinition"

health.fhir.r5.international500: PROFILE_BASE_EVIDENCE

string "http://hl7.org/fhir/StructureDefinition/Evidence"

health.fhir.r5.international500: PROFILE_BASE_EVIDENCEREPORT

string "http://hl7.org/fhir/StructureDefinition/EvidenceReport"

health.fhir.r5.international500: PROFILE_BASE_EVIDENCEVARIABLE

string "http://hl7.org/fhir/StructureDefinition/EvidenceVariable"

health.fhir.r5.international500: PROFILE_BASE_EXAMPLELIPIDPROFILE

string "http://hl7.org/fhir/StructureDefinition/triglyceride"

health.fhir.r5.international500: PROFILE_BASE_EXAMPLESCENARIO

string "http://hl7.org/fhir/StructureDefinition/ExampleScenario"

health.fhir.r5.international500: PROFILE_BASE_EXPLANATIONOFBENEFIT

string "http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit"

health.fhir.r5.international500: PROFILE_BASE_FAMILYMEMBERHISTORY

string "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"

health.fhir.r5.international500: PROFILE_BASE_FAMILYMEMBERHISTORYFORGENETICSANALYSIS

string "http://hl7.org/fhir/StructureDefinition/familymemberhistory-genetic"

health.fhir.r5.international500: PROFILE_BASE_FHIRPATHLIBRARY

string "http://hl7.org/fhir/StructureDefinition/fhirpathlibrary"

health.fhir.r5.international500: PROFILE_BASE_FLAG

string "http://hl7.org/fhir/StructureDefinition/Flag"

health.fhir.r5.international500: PROFILE_BASE_FORMULARYITEM

string "http://hl7.org/fhir/StructureDefinition/FormularyItem"

health.fhir.r5.international500: PROFILE_BASE_GENOMICSTUDY

string "http://hl7.org/fhir/StructureDefinition/GenomicStudy"

health.fhir.r5.international500: PROFILE_BASE_GOAL

string "http://hl7.org/fhir/StructureDefinition/Goal"

health.fhir.r5.international500: PROFILE_BASE_GRAPHDEFINITION

string "http://hl7.org/fhir/StructureDefinition/GraphDefinition"

health.fhir.r5.international500: PROFILE_BASE_GROUP

string "http://hl7.org/fhir/StructureDefinition/Group"

health.fhir.r5.international500: PROFILE_BASE_GROUPDEFINITION

string "http://hl7.org/fhir/StructureDefinition/groupdefinition"

health.fhir.r5.international500: PROFILE_BASE_GUIDANCERESPONSE

string "http://hl7.org/fhir/StructureDefinition/GuidanceResponse"

health.fhir.r5.international500: PROFILE_BASE_HEALTHCARESERVICE

string "http://hl7.org/fhir/StructureDefinition/HealthcareService"

health.fhir.r5.international500: PROFILE_BASE_IMAGINGSELECTION

string "http://hl7.org/fhir/StructureDefinition/ImagingSelection"

health.fhir.r5.international500: PROFILE_BASE_IMAGINGSTUDY

string "http://hl7.org/fhir/StructureDefinition/ImagingStudy"

health.fhir.r5.international500: PROFILE_BASE_IMMUNIZATION

string "http://hl7.org/fhir/StructureDefinition/Immunization"

health.fhir.r5.international500: PROFILE_BASE_IMMUNIZATIONEVALUATION

string "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"

health.fhir.r5.international500: PROFILE_BASE_IMMUNIZATIONRECOMMENDATION

string "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"

health.fhir.r5.international500: PROFILE_BASE_IMPLEMENTATIONGUIDE

string "http://hl7.org/fhir/StructureDefinition/ImplementationGuide"

health.fhir.r5.international500: PROFILE_BASE_INGREDIENT

string "http://hl7.org/fhir/StructureDefinition/Ingredient"

health.fhir.r5.international500: PROFILE_BASE_INSURANCEPLAN

string "http://hl7.org/fhir/StructureDefinition/InsurancePlan"

health.fhir.r5.international500: PROFILE_BASE_INVENTORYITEM

string "http://hl7.org/fhir/StructureDefinition/InventoryItem"

health.fhir.r5.international500: PROFILE_BASE_INVENTORYREPORT

string "http://hl7.org/fhir/StructureDefinition/InventoryReport"

health.fhir.r5.international500: PROFILE_BASE_INVOICE

string "http://hl7.org/fhir/StructureDefinition/Invoice"

health.fhir.r5.international500: PROFILE_BASE_LIBRARY

string "http://hl7.org/fhir/StructureDefinition/Library"

health.fhir.r5.international500: PROFILE_BASE_LINKAGE

string "http://hl7.org/fhir/StructureDefinition/Linkage"

health.fhir.r5.international500: PROFILE_BASE_LIST

string "http://hl7.org/fhir/StructureDefinition/List"

health.fhir.r5.international500: PROFILE_BASE_LOCATION

string "http://hl7.org/fhir/StructureDefinition/Location"

health.fhir.r5.international500: PROFILE_BASE_LOGICLIBRARY

string "http://hl7.org/fhir/StructureDefinition/logiclibrary"

health.fhir.r5.international500: PROFILE_BASE_MANUFACTUREDITEMDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ManufacturedItemDefinition"

health.fhir.r5.international500: PROFILE_BASE_MEASURE

string "http://hl7.org/fhir/StructureDefinition/Measure"

health.fhir.r5.international500: PROFILE_BASE_MEASUREREPORT

string "http://hl7.org/fhir/StructureDefinition/MeasureReport"

health.fhir.r5.international500: PROFILE_BASE_MEDICATION

string "http://hl7.org/fhir/StructureDefinition/Medication"

health.fhir.r5.international500: PROFILE_BASE_MEDICATIONADMINISTRATION

string "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"

health.fhir.r5.international500: PROFILE_BASE_MEDICATIONDISPENSE

string "http://hl7.org/fhir/StructureDefinition/MedicationDispense"

health.fhir.r5.international500: PROFILE_BASE_MEDICATIONKNOWLEDGE

string "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge"

health.fhir.r5.international500: PROFILE_BASE_MEDICATIONREQUEST

string "http://hl7.org/fhir/StructureDefinition/MedicationRequest"

health.fhir.r5.international500: PROFILE_BASE_MEDICATIONSTATEMENT

string "http://hl7.org/fhir/StructureDefinition/MedicationStatement"

health.fhir.r5.international500: PROFILE_BASE_MEDICINALPRODUCTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition"

health.fhir.r5.international500: PROFILE_BASE_MESSAGEDEFINITION

string "http://hl7.org/fhir/StructureDefinition/MessageDefinition"

health.fhir.r5.international500: PROFILE_BASE_MESSAGEHEADER

string "http://hl7.org/fhir/StructureDefinition/MessageHeader"

health.fhir.r5.international500: PROFILE_BASE_METADATARESOURCE

string "http://hl7.org/fhir/StructureDefinition/MetadataResource"

health.fhir.r5.international500: PROFILE_BASE_MODELINFOLIBRARY

string "http://hl7.org/fhir/StructureDefinition/modelinfolibrary"

health.fhir.r5.international500: PROFILE_BASE_MODULEDEFINITIONLIBRARY

string "http://hl7.org/fhir/StructureDefinition/moduledefinitionlibrary"

health.fhir.r5.international500: PROFILE_BASE_MOLECULARSEQUENCE

string "http://hl7.org/fhir/StructureDefinition/MolecularSequence"

health.fhir.r5.international500: PROFILE_BASE_NAMINGSYSTEM

string "http://hl7.org/fhir/StructureDefinition/NamingSystem"

health.fhir.r5.international500: PROFILE_BASE_NUTRITIONINTAKE

string "http://hl7.org/fhir/StructureDefinition/NutritionIntake"

health.fhir.r5.international500: PROFILE_BASE_NUTRITIONORDER

string "http://hl7.org/fhir/StructureDefinition/NutritionOrder"

health.fhir.r5.international500: PROFILE_BASE_NUTRITIONPRODUCT

string "http://hl7.org/fhir/StructureDefinition/NutritionProduct"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATION

string "http://hl7.org/fhir/StructureDefinition/Observation"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONBMI

string "http://hl7.org/fhir/StructureDefinition/bmi"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONBODYHEIGHT

string "http://hl7.org/fhir/StructureDefinition/bodyheight"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONBODYTEMP

string "http://hl7.org/fhir/StructureDefinition/bodytemp"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONBODYWEIGHT

string "http://hl7.org/fhir/StructureDefinition/bodyweight"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONBP

string "http://hl7.org/fhir/StructureDefinition/bp"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ObservationDefinition"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONHEADCIRCUM

string "http://hl7.org/fhir/StructureDefinition/headcircum"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONHEARTRATE

string "http://hl7.org/fhir/StructureDefinition/heartrate"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONOXYGENSAT

string "http://hl7.org/fhir/StructureDefinition/oxygensat"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONRESPRATE

string "http://hl7.org/fhir/StructureDefinition/resprate"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONVITALSIGNS

string "http://hl7.org/fhir/StructureDefinition/vitalsigns"

health.fhir.r5.international500: PROFILE_BASE_OBSERVATIONVITALSPANEL

string "http://hl7.org/fhir/StructureDefinition/vitalspanel"

health.fhir.r5.international500: PROFILE_BASE_OPERATIONDEFINITION

string "http://hl7.org/fhir/StructureDefinition/OperationDefinition"

health.fhir.r5.international500: PROFILE_BASE_ORGANIZATION

string "http://hl7.org/fhir/StructureDefinition/Organization"

health.fhir.r5.international500: PROFILE_BASE_ORGANIZATIONAFFILIATION

string "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation"

health.fhir.r5.international500: PROFILE_BASE_PACKAGEDPRODUCTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/PackagedProductDefinition"

health.fhir.r5.international500: PROFILE_BASE_PARAMETERS

string "http://hl7.org/fhir/StructureDefinition/Parameters"

health.fhir.r5.international500: PROFILE_BASE_PATIENT

string "http://hl7.org/fhir/StructureDefinition/Patient"

health.fhir.r5.international500: PROFILE_BASE_PAYMENTNOTICE

string "http://hl7.org/fhir/StructureDefinition/PaymentNotice"

health.fhir.r5.international500: PROFILE_BASE_PAYMENTRECONCILIATION

string "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"

health.fhir.r5.international500: PROFILE_BASE_PERMISSION

string "http://hl7.org/fhir/StructureDefinition/Permission"

health.fhir.r5.international500: PROFILE_BASE_PERSON

string "http://hl7.org/fhir/StructureDefinition/Person"

health.fhir.r5.international500: PROFILE_BASE_PLANDEFINITION

string "http://hl7.org/fhir/StructureDefinition/PlanDefinition"

health.fhir.r5.international500: PROFILE_BASE_PRACTITIONER

string "http://hl7.org/fhir/StructureDefinition/Practitioner"

health.fhir.r5.international500: PROFILE_BASE_PRACTITIONERROLE

string "http://hl7.org/fhir/StructureDefinition/PractitionerRole"

health.fhir.r5.international500: PROFILE_BASE_PROCEDURE

string "http://hl7.org/fhir/StructureDefinition/Procedure"

health.fhir.r5.international500: PROFILE_BASE_PROFILEFORCATALOG

string "http://hl7.org/fhir/StructureDefinition/catalog"

health.fhir.r5.international500: PROFILE_BASE_PROVENANCE

string "http://hl7.org/fhir/StructureDefinition/Provenance"

health.fhir.r5.international500: PROFILE_BASE_PROVENANCERELEVANTHISTORY

string "http://hl7.org/fhir/StructureDefinition/provenance-relevant-history"

health.fhir.r5.international500: PROFILE_BASE_PUBLISHABLEACTIVITYDEFINITION

string "http://hl7.org/fhir/StructureDefinition/publishableactivitydefinition"

health.fhir.r5.international500: PROFILE_BASE_PUBLISHABLECONCEPTMAP

string "http://hl7.org/fhir/StructureDefinition/publishableconceptmap"

health.fhir.r5.international500: PROFILE_BASE_PUBLISHABLELIBRARY

string "http://hl7.org/fhir/StructureDefinition/publishablelibrary"

health.fhir.r5.international500: PROFILE_BASE_PUBLISHABLEMEASURE

string "http://hl7.org/fhir/StructureDefinition/publishablemeasure"

health.fhir.r5.international500: PROFILE_BASE_PUBLISHABLENAMINGSYSTEM

string "http://hl7.org/fhir/StructureDefinition/publishablenamingsystem"

health.fhir.r5.international500: PROFILE_BASE_PUBLISHABLEPLANDEFINITION

string "http://hl7.org/fhir/StructureDefinition/publishableplandefinition"

health.fhir.r5.international500: PROFILE_BASE_QUESTIONNAIRE

string "http://hl7.org/fhir/StructureDefinition/Questionnaire"

health.fhir.r5.international500: PROFILE_BASE_QUESTIONNAIRERESPONSE

string "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"

health.fhir.r5.international500: PROFILE_BASE_REGULATEDAUTHORIZATION

string "http://hl7.org/fhir/StructureDefinition/RegulatedAuthorization"

health.fhir.r5.international500: PROFILE_BASE_RELATEDPERSON

string "http://hl7.org/fhir/StructureDefinition/RelatedPerson"

health.fhir.r5.international500: PROFILE_BASE_REQUESTORCHESTRATION

string "http://hl7.org/fhir/StructureDefinition/RequestOrchestration"

health.fhir.r5.international500: PROFILE_BASE_REQUIREMENTS

string "http://hl7.org/fhir/StructureDefinition/Requirements"

health.fhir.r5.international500: PROFILE_BASE_RESEARCHSTUDY

string "http://hl7.org/fhir/StructureDefinition/ResearchStudy"

health.fhir.r5.international500: PROFILE_BASE_RESEARCHSUBJECT

string "http://hl7.org/fhir/StructureDefinition/ResearchSubject"

health.fhir.r5.international500: PROFILE_BASE_RISKASSESSMENT

string "http://hl7.org/fhir/StructureDefinition/RiskAssessment"

health.fhir.r5.international500: PROFILE_BASE_SCHEDULE

string "http://hl7.org/fhir/StructureDefinition/Schedule"

health.fhir.r5.international500: PROFILE_BASE_SEARCHPARAMETER

string "http://hl7.org/fhir/StructureDefinition/SearchParameter"

health.fhir.r5.international500: PROFILE_BASE_SERVICEREQUEST

string "http://hl7.org/fhir/StructureDefinition/ServiceRequest"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLEACTIVITYDEFINITION

string "http://hl7.org/fhir/StructureDefinition/shareableactivitydefinition"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLECONCEPTMAP

string "http://hl7.org/fhir/StructureDefinition/shareableconceptmap"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLELIBRARY

string "http://hl7.org/fhir/StructureDefinition/shareablelibrary"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLEMEASURE

string "http://hl7.org/fhir/StructureDefinition/shareablemeasure"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLENAMINGSYSTEM

string "http://hl7.org/fhir/StructureDefinition/shareablenamingsystem"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLEPLANDEFINITION

string "http://hl7.org/fhir/StructureDefinition/shareableplandefinition"

health.fhir.r5.international500: PROFILE_BASE_SHAREABLETESTSCRIPT

string "http://hl7.org/fhir/StructureDefinition/shareabletestscript"

health.fhir.r5.international500: PROFILE_BASE_SLOT

string "http://hl7.org/fhir/StructureDefinition/Slot"

health.fhir.r5.international500: PROFILE_BASE_SPECIMEN

string "http://hl7.org/fhir/StructureDefinition/Specimen"

health.fhir.r5.international500: PROFILE_BASE_SPECIMENDEFINITION

string "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"

health.fhir.r5.international500: PROFILE_BASE_STRUCTUREDEFINITION

string "http://hl7.org/fhir/StructureDefinition/StructureDefinition"

health.fhir.r5.international500: PROFILE_BASE_STRUCTUREMAP

string "http://hl7.org/fhir/StructureDefinition/StructureMap"

health.fhir.r5.international500: PROFILE_BASE_SUBSCRIPTION

string "http://hl7.org/fhir/StructureDefinition/Subscription"

health.fhir.r5.international500: PROFILE_BASE_SUBSCRIPTIONSTATUS

string "http://hl7.org/fhir/StructureDefinition/SubscriptionStatus"

health.fhir.r5.international500: PROFILE_BASE_SUBSCRIPTIONTOPIC

string "http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCE

string "http://hl7.org/fhir/StructureDefinition/Substance"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCEDEFINITION

string "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCENUCLEICACID

string "http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCEPOLYMER

string "http://hl7.org/fhir/StructureDefinition/SubstancePolymer"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCEPROTEIN

string "http://hl7.org/fhir/StructureDefinition/SubstanceProtein"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCEREFERENCEINFORMATION

string "http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation"

health.fhir.r5.international500: PROFILE_BASE_SUBSTANCESOURCEMATERIAL

string "http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial"

health.fhir.r5.international500: PROFILE_BASE_SUPPLYDELIVERY

string "http://hl7.org/fhir/StructureDefinition/SupplyDelivery"

health.fhir.r5.international500: PROFILE_BASE_SUPPLYREQUEST

string "http://hl7.org/fhir/StructureDefinition/SupplyRequest"

health.fhir.r5.international500: PROFILE_BASE_TASK

string "http://hl7.org/fhir/StructureDefinition/Task"

health.fhir.r5.international500: PROFILE_BASE_TERMINOLOGYCAPABILITIES

string "http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities"

health.fhir.r5.international500: PROFILE_BASE_TESTPLAN

string "http://hl7.org/fhir/StructureDefinition/TestPlan"

health.fhir.r5.international500: PROFILE_BASE_TESTREPORT

string "http://hl7.org/fhir/StructureDefinition/TestReport"

health.fhir.r5.international500: PROFILE_BASE_TESTSCRIPT

string "http://hl7.org/fhir/StructureDefinition/TestScript"

health.fhir.r5.international500: PROFILE_BASE_TRANSPORT

string "http://hl7.org/fhir/StructureDefinition/Transport"

health.fhir.r5.international500: PROFILE_BASE_VERIFICATIONRESULT

string "http://hl7.org/fhir/StructureDefinition/VerificationResult"

health.fhir.r5.international500: PROFILE_BASE_VISIONPRESCRIPTION

string "http://hl7.org/fhir/StructureDefinition/VisionPrescription"

health.fhir.r5.international500: RESOURCE_NAME_ACCOUNT

string "Account"

health.fhir.r5.international500: RESOURCE_NAME_ACTIVITYDEFINITION

string "ActivityDefinition"

health.fhir.r5.international500: RESOURCE_NAME_ACTORDEFINITION

string "ActorDefinition"

health.fhir.r5.international500: RESOURCE_NAME_ACTUALGROUP

string "Group"

health.fhir.r5.international500: RESOURCE_NAME_ADMINISTRABLEPRODUCTDEFINITION

string "AdministrableProductDefinition"

health.fhir.r5.international500: RESOURCE_NAME_ADVERSEEVENT

string "AdverseEvent"

health.fhir.r5.international500: RESOURCE_NAME_ALLERGYINTOLERANCE

string "AllergyIntolerance"

health.fhir.r5.international500: RESOURCE_NAME_APPOINTMENT

string "Appointment"

health.fhir.r5.international500: RESOURCE_NAME_APPOINTMENTRESPONSE

string "AppointmentResponse"

health.fhir.r5.international500: RESOURCE_NAME_ARTIFACTASSESSMENT

string "ArtifactAssessment"

health.fhir.r5.international500: RESOURCE_NAME_AUDITEVENT

string "AuditEvent"

health.fhir.r5.international500: RESOURCE_NAME_BASIC

string "Basic"

health.fhir.r5.international500: RESOURCE_NAME_BINARY

string "Binary"

health.fhir.r5.international500: RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT

string "BiologicallyDerivedProduct"

health.fhir.r5.international500: RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCTDISPENSE

string "BiologicallyDerivedProductDispense"

health.fhir.r5.international500: RESOURCE_NAME_BODYSTRUCTURE

string "BodyStructure"

health.fhir.r5.international500: RESOURCE_NAME_CANONICALRESOURCE

string "CanonicalResource"

health.fhir.r5.international500: RESOURCE_NAME_CAPABILITYSTATEMENT

string "CapabilityStatement"

health.fhir.r5.international500: RESOURCE_NAME_CAREPLAN

string "CarePlan"

health.fhir.r5.international500: RESOURCE_NAME_CARETEAM

string "CareTeam"

health.fhir.r5.international500: RESOURCE_NAME_CDSHOOKSGUIDANCERESPONSE

string "GuidanceResponse"

health.fhir.r5.international500: RESOURCE_NAME_CDSHOOKSREQUESTORCHESTRATION

string "RequestOrchestration"

health.fhir.r5.international500: RESOURCE_NAME_CDSHOOKSSERVICEPLANDEFINITION

string "PlanDefinition"

health.fhir.r5.international500: RESOURCE_NAME_CHARGEITEM

string "ChargeItem"

health.fhir.r5.international500: RESOURCE_NAME_CHARGEITEMDEFINITION

string "ChargeItemDefinition"

health.fhir.r5.international500: RESOURCE_NAME_CITATION

string "Citation"

health.fhir.r5.international500: RESOURCE_NAME_CLAIM

string "Claim"

health.fhir.r5.international500: RESOURCE_NAME_CLAIMRESPONSE

string "ClaimResponse"

health.fhir.r5.international500: RESOURCE_NAME_CLINICALDOCUMENT

string "Composition"

health.fhir.r5.international500: RESOURCE_NAME_CLINICALIMPRESSION

string "ClinicalImpression"

health.fhir.r5.international500: RESOURCE_NAME_CLINICALUSEDEFINITION

string "ClinicalUseDefinition"

health.fhir.r5.international500: RESOURCE_NAME_COMMUNICATION

string "Communication"

health.fhir.r5.international500: RESOURCE_NAME_COMMUNICATIONREQUEST

string "CommunicationRequest"

health.fhir.r5.international500: RESOURCE_NAME_COMPARTMENTDEFINITION

string "CompartmentDefinition"

health.fhir.r5.international500: RESOURCE_NAME_COMPOSITION

string "Composition"

health.fhir.r5.international500: RESOURCE_NAME_COMPUTABLEPLANDEFINITION

string "PlanDefinition"

health.fhir.r5.international500: RESOURCE_NAME_CONCEPTMAP

string "ConceptMap"

health.fhir.r5.international500: RESOURCE_NAME_CONDITION

string "Condition"

health.fhir.r5.international500: RESOURCE_NAME_CONDITIONDEFINITION

string "ConditionDefinition"

health.fhir.r5.international500: RESOURCE_NAME_CONSENT

string "Consent"

health.fhir.r5.international500: RESOURCE_NAME_CONTRACT

string "Contract"

health.fhir.r5.international500: RESOURCE_NAME_COVERAGE

string "Coverage"

health.fhir.r5.international500: RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST

string "CoverageEligibilityRequest"

health.fhir.r5.international500: RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE

string "CoverageEligibilityResponse"

health.fhir.r5.international500: RESOURCE_NAME_CQLLIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_DETECTEDISSUE

string "DetectedIssue"

health.fhir.r5.international500: RESOURCE_NAME_DEVICE

string "Device"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEASSOCIATION

string "DeviceAssociation"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEDEFINITION

string "DeviceDefinition"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEDISPENSE

string "DeviceDispense"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEMETRIC

string "DeviceMetric"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEMETRICOBSERVATIONPROFILE

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEREQUEST

string "DeviceRequest"

health.fhir.r5.international500: RESOURCE_NAME_DEVICEUSAGE

string "DeviceUsage"

health.fhir.r5.international500: RESOURCE_NAME_DIAGNOSTICREPORT

string "DiagnosticReport"

health.fhir.r5.international500: RESOURCE_NAME_DOCUMENTREFERENCE

string "DocumentReference"

health.fhir.r5.international500: RESOURCE_NAME_DOCUMENTSECTIONLIBRARY

string "Composition"

health.fhir.r5.international500: RESOURCE_NAME_DOCUMENTSTRUCTURE

string "Composition"

health.fhir.r5.international500: RESOURCE_NAME_EBMRECOMMENDATION

string "ArtifactAssessment"

health.fhir.r5.international500: RESOURCE_NAME_ELMLIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_ENCOUNTER

string "Encounter"

health.fhir.r5.international500: RESOURCE_NAME_ENCOUNTERHISTORY

string "EncounterHistory"

health.fhir.r5.international500: RESOURCE_NAME_ENDPOINT

string "Endpoint"

health.fhir.r5.international500: RESOURCE_NAME_ENROLLMENTREQUEST

string "EnrollmentRequest"

health.fhir.r5.international500: RESOURCE_NAME_ENROLLMENTRESPONSE

string "EnrollmentResponse"

health.fhir.r5.international500: RESOURCE_NAME_EPISODEOFCARE

string "EpisodeOfCare"

health.fhir.r5.international500: RESOURCE_NAME_EVENTDEFINITION

string "EventDefinition"

health.fhir.r5.international500: RESOURCE_NAME_EVIDENCE

string "Evidence"

health.fhir.r5.international500: RESOURCE_NAME_EVIDENCEREPORT

string "EvidenceReport"

health.fhir.r5.international500: RESOURCE_NAME_EVIDENCEVARIABLE

string "EvidenceVariable"

health.fhir.r5.international500: RESOURCE_NAME_EXAMPLELIPIDPROFILE

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_EXAMPLESCENARIO

string "ExampleScenario"

health.fhir.r5.international500: RESOURCE_NAME_EXPLANATIONOFBENEFIT

string "ExplanationOfBenefit"

health.fhir.r5.international500: RESOURCE_NAME_FAMILYMEMBERHISTORY

string "FamilyMemberHistory"

health.fhir.r5.international500: RESOURCE_NAME_FAMILYMEMBERHISTORYFORGENETICSANALYSIS

string "FamilyMemberHistory"

health.fhir.r5.international500: RESOURCE_NAME_FHIRPATHLIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_FLAG

string "Flag"

health.fhir.r5.international500: RESOURCE_NAME_FORMULARYITEM

string "FormularyItem"

health.fhir.r5.international500: RESOURCE_NAME_GENOMICSTUDY

string "GenomicStudy"

health.fhir.r5.international500: RESOURCE_NAME_GOAL

string "Goal"

health.fhir.r5.international500: RESOURCE_NAME_GRAPHDEFINITION

string "GraphDefinition"

health.fhir.r5.international500: RESOURCE_NAME_GROUP

string "Group"

health.fhir.r5.international500: RESOURCE_NAME_GROUPDEFINITION

string "Group"

health.fhir.r5.international500: RESOURCE_NAME_GUIDANCERESPONSE

string "GuidanceResponse"

health.fhir.r5.international500: RESOURCE_NAME_HEALTHCARESERVICE

string "HealthcareService"

health.fhir.r5.international500: RESOURCE_NAME_IMAGINGSELECTION

string "ImagingSelection"

health.fhir.r5.international500: RESOURCE_NAME_IMAGINGSTUDY

string "ImagingStudy"

health.fhir.r5.international500: RESOURCE_NAME_IMMUNIZATION

string "Immunization"

health.fhir.r5.international500: RESOURCE_NAME_IMMUNIZATIONEVALUATION

string "ImmunizationEvaluation"

health.fhir.r5.international500: RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION

string "ImmunizationRecommendation"

health.fhir.r5.international500: RESOURCE_NAME_IMPLEMENTATIONGUIDE

string "ImplementationGuide"

health.fhir.r5.international500: RESOURCE_NAME_INGREDIENT

string "Ingredient"

health.fhir.r5.international500: RESOURCE_NAME_INSURANCEPLAN

string "InsurancePlan"

health.fhir.r5.international500: RESOURCE_NAME_INVENTORYITEM

string "InventoryItem"

health.fhir.r5.international500: RESOURCE_NAME_INVENTORYREPORT

string "InventoryReport"

health.fhir.r5.international500: RESOURCE_NAME_INVOICE

string "Invoice"

health.fhir.r5.international500: RESOURCE_NAME_LIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_LINKAGE

string "Linkage"

health.fhir.r5.international500: RESOURCE_NAME_LIST

string "List"

health.fhir.r5.international500: RESOURCE_NAME_LOCATION

string "Location"

health.fhir.r5.international500: RESOURCE_NAME_LOGICLIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_MANUFACTUREDITEMDEFINITION

string "ManufacturedItemDefinition"

health.fhir.r5.international500: RESOURCE_NAME_MEASURE

string "Measure"

health.fhir.r5.international500: RESOURCE_NAME_MEASUREREPORT

string "MeasureReport"

health.fhir.r5.international500: RESOURCE_NAME_MEDICATION

string "Medication"

health.fhir.r5.international500: RESOURCE_NAME_MEDICATIONADMINISTRATION

string "MedicationAdministration"

health.fhir.r5.international500: RESOURCE_NAME_MEDICATIONDISPENSE

string "MedicationDispense"

health.fhir.r5.international500: RESOURCE_NAME_MEDICATIONKNOWLEDGE

string "MedicationKnowledge"

health.fhir.r5.international500: RESOURCE_NAME_MEDICATIONREQUEST

string "MedicationRequest"

health.fhir.r5.international500: RESOURCE_NAME_MEDICATIONSTATEMENT

string "MedicationStatement"

health.fhir.r5.international500: RESOURCE_NAME_MEDICINALPRODUCTDEFINITION

string "MedicinalProductDefinition"

health.fhir.r5.international500: RESOURCE_NAME_MESSAGEDEFINITION

string "MessageDefinition"

health.fhir.r5.international500: RESOURCE_NAME_MESSAGEHEADER

string "MessageHeader"

health.fhir.r5.international500: RESOURCE_NAME_METADATARESOURCE

string "MetadataResource"

health.fhir.r5.international500: RESOURCE_NAME_MODELINFOLIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_MODULEDEFINITIONLIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_MOLECULARSEQUENCE

string "MolecularSequence"

health.fhir.r5.international500: RESOURCE_NAME_NAMINGSYSTEM

string "NamingSystem"

health.fhir.r5.international500: RESOURCE_NAME_NUTRITIONINTAKE

string "NutritionIntake"

health.fhir.r5.international500: RESOURCE_NAME_NUTRITIONORDER

string "NutritionOrder"

health.fhir.r5.international500: RESOURCE_NAME_NUTRITIONPRODUCT

string "NutritionProduct"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATION

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONBMI

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONBODYHEIGHT

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONBODYTEMP

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONBODYWEIGHT

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONBP

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONDEFINITION

string "ObservationDefinition"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONHEADCIRCUM

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONHEARTRATE

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONOXYGENSAT

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONRESPRATE

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONVITALSIGNS

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OBSERVATIONVITALSPANEL

string "Observation"

health.fhir.r5.international500: RESOURCE_NAME_OPERATIONDEFINITION

string "OperationDefinition"

health.fhir.r5.international500: RESOURCE_NAME_ORGANIZATION

string "Organization"

health.fhir.r5.international500: RESOURCE_NAME_ORGANIZATIONAFFILIATION

string "OrganizationAffiliation"

health.fhir.r5.international500: RESOURCE_NAME_PACKAGEDPRODUCTDEFINITION

string "PackagedProductDefinition"

health.fhir.r5.international500: RESOURCE_NAME_PARAMETERS

string "Parameters"

health.fhir.r5.international500: RESOURCE_NAME_PATIENT

string "Patient"

health.fhir.r5.international500: RESOURCE_NAME_PAYMENTNOTICE

string "PaymentNotice"

health.fhir.r5.international500: RESOURCE_NAME_PAYMENTRECONCILIATION

string "PaymentReconciliation"

health.fhir.r5.international500: RESOURCE_NAME_PERMISSION

string "Permission"

health.fhir.r5.international500: RESOURCE_NAME_PERSON

string "Person"

health.fhir.r5.international500: RESOURCE_NAME_PLANDEFINITION

string "PlanDefinition"

health.fhir.r5.international500: RESOURCE_NAME_PRACTITIONER

string "Practitioner"

health.fhir.r5.international500: RESOURCE_NAME_PRACTITIONERROLE

string "PractitionerRole"

health.fhir.r5.international500: RESOURCE_NAME_PROCEDURE

string "Procedure"

health.fhir.r5.international500: RESOURCE_NAME_PROFILEFORCATALOG

string "Composition"

health.fhir.r5.international500: RESOURCE_NAME_PROVENANCE

string "Provenance"

health.fhir.r5.international500: RESOURCE_NAME_PROVENANCERELEVANTHISTORY

string "Provenance"

health.fhir.r5.international500: RESOURCE_NAME_PUBLISHABLEACTIVITYDEFINITION

string "ActivityDefinition"

health.fhir.r5.international500: RESOURCE_NAME_PUBLISHABLECONCEPTMAP

string "ConceptMap"

health.fhir.r5.international500: RESOURCE_NAME_PUBLISHABLELIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_PUBLISHABLEMEASURE

string "Measure"

health.fhir.r5.international500: RESOURCE_NAME_PUBLISHABLENAMINGSYSTEM

string "NamingSystem"

health.fhir.r5.international500: RESOURCE_NAME_PUBLISHABLEPLANDEFINITION

string "PlanDefinition"

health.fhir.r5.international500: RESOURCE_NAME_QUESTIONNAIRE

string "Questionnaire"

health.fhir.r5.international500: RESOURCE_NAME_QUESTIONNAIRERESPONSE

string "QuestionnaireResponse"

health.fhir.r5.international500: RESOURCE_NAME_REGULATEDAUTHORIZATION

string "RegulatedAuthorization"

health.fhir.r5.international500: RESOURCE_NAME_RELATEDPERSON

string "RelatedPerson"

health.fhir.r5.international500: RESOURCE_NAME_REQUESTORCHESTRATION

string "RequestOrchestration"

health.fhir.r5.international500: RESOURCE_NAME_REQUIREMENTS

string "Requirements"

health.fhir.r5.international500: RESOURCE_NAME_RESEARCHSTUDY

string "ResearchStudy"

health.fhir.r5.international500: RESOURCE_NAME_RESEARCHSUBJECT

string "ResearchSubject"

health.fhir.r5.international500: RESOURCE_NAME_RISKASSESSMENT

string "RiskAssessment"

health.fhir.r5.international500: RESOURCE_NAME_SCHEDULE

string "Schedule"

health.fhir.r5.international500: RESOURCE_NAME_SEARCHPARAMETER

string "SearchParameter"

health.fhir.r5.international500: RESOURCE_NAME_SERVICEREQUEST

string "ServiceRequest"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLEACTIVITYDEFINITION

string "ActivityDefinition"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLECONCEPTMAP

string "ConceptMap"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLELIBRARY

string "Library"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLEMEASURE

string "Measure"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLENAMINGSYSTEM

string "NamingSystem"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLEPLANDEFINITION

string "PlanDefinition"

health.fhir.r5.international500: RESOURCE_NAME_SHAREABLETESTSCRIPT

string "TestScript"

health.fhir.r5.international500: RESOURCE_NAME_SLOT

string "Slot"

health.fhir.r5.international500: RESOURCE_NAME_SPECIMEN

string "Specimen"

health.fhir.r5.international500: RESOURCE_NAME_SPECIMENDEFINITION

string "SpecimenDefinition"

health.fhir.r5.international500: RESOURCE_NAME_STRUCTUREDEFINITION

string "StructureDefinition"

health.fhir.r5.international500: RESOURCE_NAME_STRUCTUREMAP

string "StructureMap"

health.fhir.r5.international500: RESOURCE_NAME_SUBSCRIPTION

string "Subscription"

health.fhir.r5.international500: RESOURCE_NAME_SUBSCRIPTIONSTATUS

string "SubscriptionStatus"

health.fhir.r5.international500: RESOURCE_NAME_SUBSCRIPTIONTOPIC

string "SubscriptionTopic"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCE

string "Substance"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCEDEFINITION

string "SubstanceDefinition"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCENUCLEICACID

string "SubstanceNucleicAcid"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCEPOLYMER

string "SubstancePolymer"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCEPROTEIN

string "SubstanceProtein"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCEREFERENCEINFORMATION

string "SubstanceReferenceInformation"

health.fhir.r5.international500: RESOURCE_NAME_SUBSTANCESOURCEMATERIAL

string "SubstanceSourceMaterial"

health.fhir.r5.international500: RESOURCE_NAME_SUPPLYDELIVERY

string "SupplyDelivery"

health.fhir.r5.international500: RESOURCE_NAME_SUPPLYREQUEST

string "SupplyRequest"

health.fhir.r5.international500: RESOURCE_NAME_TASK

string "Task"

health.fhir.r5.international500: RESOURCE_NAME_TERMINOLOGYCAPABILITIES

string "TerminologyCapabilities"

health.fhir.r5.international500: RESOURCE_NAME_TESTPLAN

string "TestPlan"

health.fhir.r5.international500: RESOURCE_NAME_TESTREPORT

string "TestReport"

health.fhir.r5.international500: RESOURCE_NAME_TESTSCRIPT

string "TestScript"

health.fhir.r5.international500: RESOURCE_NAME_TRANSPORT

string "Transport"

health.fhir.r5.international500: RESOURCE_NAME_VERIFICATIONRESULT

string "VerificationResult"

health.fhir.r5.international500: RESOURCE_NAME_VISIONPRESCRIPTION

string "VisionPrescription"

Enums

health.fhir.r5.international500: AccountStatus

AccountStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ActivityDefinitionIntent

ActivityDefinitionIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: ActivityDefinitionParticipantType

ActivityDefinitionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: ActivityDefinitionPriority

ActivityDefinitionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: ActivityDefinitionStatus

ActivityDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ActorDefinitionStatus

ActorDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ActorDefinitionType

ActorDefinitionType enum

Members

CODE_TYPE_SYSTEM

CODE_TYPE_PERSON

health.fhir.r5.international500: ActualGroupMembership

ActualGroupMembership enum

Members

CODE_MEMBERSHIP_DEFINITIONAL

CODE_MEMBERSHIP_ENUMERATED

health.fhir.r5.international500: ActualGroupType

ActualGroupType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PERSON

CODE_TYPE_ORGANIZATION

CODE_TYPE_SPECIMEN

CODE_TYPE_ANIMAL

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

health.fhir.r5.international500: AdministrableProductDefinitionStatus

AdministrableProductDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: AdverseEventActuality

AdverseEventActuality enum

Members

CODE_ACTUALITY_ACTUAL

CODE_ACTUALITY_POTENTIAL

health.fhir.r5.international500: AdverseEventStatus

AdverseEventStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: AllergyIntoleranceCategory

AllergyIntoleranceCategory enum

Members

CODE_CATEGORY_ENVIRONMENT

CODE_CATEGORY_BIOLOGIC

CODE_CATEGORY_MEDICATION

CODE_CATEGORY_FOOD

health.fhir.r5.international500: AllergyIntoleranceCriticality

AllergyIntoleranceCriticality enum

Members

CODE_CRITICALITY_HIGH

CODE_CRITICALITY_LOW

CODE_CRITICALITY_UNABLE_TO_ASSESS

health.fhir.r5.international500: AllergyIntoleranceReactionSeverity

AllergyIntoleranceReactionSeverity enum

Members

CODE_SEVERITY_MILD

CODE_SEVERITY_SEVERE

CODE_SEVERITY_MODERATE

health.fhir.r5.international500: AppointmentParticipantStatus

AppointmentParticipantStatus enum

Members

CODE_STATUS_DECLINED

CODE_STATUS_NEEDS_ACTION

CODE_STATUS_ACCEPTED

CODE_STATUS_TENTATIVE

health.fhir.r5.international500: AppointmentResponseParticipantStatus

AppointmentResponseParticipantStatus enum

Members

CODE_PARTICIPANTSTATUS_DECLINED

CODE_PARTICIPANTSTATUS_NEEDS_ACTION

CODE_PARTICIPANTSTATUS_ACCEPTED

CODE_PARTICIPANTSTATUS_TENTATIVE

CODE_PARTICIPANTSTATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: AppointmentStatus

AppointmentStatus enum

Members

CODE_STATUS_ARRIVED

CODE_STATUS_BOOKED

CODE_STATUS_PROPOSED

CODE_STATUS_PENDING

CODE_STATUS_FULFILLED

CODE_STATUS_CANCELLED

CODE_STATUS_NOSHOW

CODE_STATUS_WAITLIST

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_CHECKED_IN

health.fhir.r5.international500: ArtifactAssessmentContentInformationType

ArtifactAssessmentContentInformationType enum

Members

CODE_INFORMATIONTYPE_CONTAINER

CODE_INFORMATIONTYPE_RESPONSE

CODE_INFORMATIONTYPE_CHANGE_REQUEST

CODE_INFORMATIONTYPE_CLASSIFIER

CODE_INFORMATIONTYPE_RATING

CODE_INFORMATIONTYPE_COMMENT

health.fhir.r5.international500: ArtifactAssessmentDisposition

ArtifactAssessmentDisposition enum

Members

CODE_DISPOSITION_PERSUASIVE

CODE_DISPOSITION_UNRESOLVED

CODE_DISPOSITION_PERSUASIVE_WITH_MODIFICATION

CODE_DISPOSITION_NOT_PERSUASIVE

CODE_DISPOSITION_NOT_PERSUASIVE_WITH_MODIFICATION

health.fhir.r5.international500: ArtifactAssessmentWorkflowStatus

ArtifactAssessmentWorkflowStatus enum

Members

CODE_WORKFLOWSTATUS_TRIAGED

CODE_WORKFLOWSTATUS_DEFERRED

CODE_WORKFLOWSTATUS_SUBMITTED

CODE_WORKFLOWSTATUS_APPLIED

CODE_WORKFLOWSTATUS_DUPLICATE

CODE_WORKFLOWSTATUS_PUBLISHED

CODE_WORKFLOWSTATUS_ENTERED_IN_ERROR

CODE_WORKFLOWSTATUS_WAITING_FOR_INPUT

CODE_WORKFLOWSTATUS_RESOLVED_NO_CHANGE

CODE_WORKFLOWSTATUS_RESOLVED_CHANGE_REQUIRED

health.fhir.r5.international500: AuditEventSeverity

AuditEventSeverity enum

Members

CODE_SEVERITY_DEBUG

CODE_SEVERITY_CRITICAL

CODE_SEVERITY_ALERT

CODE_SEVERITY_EMERGENCY

CODE_SEVERITY_WARNING

CODE_SEVERITY_INFORMATIONAL

CODE_SEVERITY_ERROR

CODE_SEVERITY_NOTICE

health.fhir.r5.international500: BiologicallyDerivedProductDispenseStatus

BiologicallyDerivedProductDispenseStatus enum

Members

CODE_STATUS_ISSUED

CODE_STATUS_RETURNED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_UNFULFILLED

CODE_STATUS_PREPARATION

CODE_STATUS_ALLOCATED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CanonicalResourceStatus

CanonicalResourceStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CapabilityStatementDocumentMode

CapabilityStatementDocumentMode enum

Members

CODE_MODE_PRODUCER

CODE_MODE_CONSUMER

health.fhir.r5.international500: CapabilityStatementFormat

CapabilityStatementFormat enum

Members

CODE_FORMAT_FORMATS

CODE_FORMAT_MIME

CODE_FORMAT_JSON

CODE_FORMAT_TTL

health.fhir.r5.international500: CapabilityStatementKind

CapabilityStatementKind enum

Members

CODE_KIND_CAPABILITY

CODE_KIND_REQUIREMENTS

CODE_KIND_INSTANCE

health.fhir.r5.international500: CapabilityStatementMessagingSupportedMessageMode

CapabilityStatementMessagingSupportedMessageMode enum

Members

CODE_MODE_RECEIVER

CODE_MODE_SENDER

health.fhir.r5.international500: CapabilityStatementRestInteractionCode

CapabilityStatementRestInteractionCode enum

Members

CODE_CODE_SEARCH_SYSTEM

CODE_CODE_HISTORY_SYSTEM

CODE_CODE_BATCH

CODE_CODE_TRANSACTION

health.fhir.r5.international500: CapabilityStatementRestMode

CapabilityStatementRestMode enum

Members

CODE_MODE_SERVER

CODE_MODE_CLIENT

health.fhir.r5.international500: CapabilityStatementRestResourceConditionalDelete

CapabilityStatementRestResourceConditionalDelete enum

Members

CODE_CONDITIONALDELETE_SINGLE

CODE_CONDITIONALDELETE_MULTIPLE

CODE_CONDITIONALDELETE_NOT_SUPPORTED

health.fhir.r5.international500: CapabilityStatementRestResourceConditionalRead

CapabilityStatementRestResourceConditionalRead enum

Members

CODE_CONDITIONALREAD_NOT_SUPPORTED

CODE_CONDITIONALREAD_MODIFIED_SINCE

CODE_CONDITIONALREAD_FULL_SUPPORT

CODE_CONDITIONALREAD_NOT_MATCH

health.fhir.r5.international500: CapabilityStatementRestResourceInteractionCode

CapabilityStatementRestResourceInteractionCode enum

Members

CODE_CODE_PATCH

CODE_CODE_READ

CODE_CODE_SEARCH_TYPE

CODE_CODE_VREAD

CODE_CODE_UPDATE

CODE_CODE_CREATE

CODE_CODE_HISTORY_INSTANCE

CODE_CODE_DELETE

CODE_CODE_HISTORY_TYPE

health.fhir.r5.international500: CapabilityStatementRestResourceReferencePolicy

CapabilityStatementRestResourceReferencePolicy enum

Members

CODE_REFERENCEPOLICY_RESOLVES

CODE_REFERENCEPOLICY_ENFORCED

CODE_REFERENCEPOLICY_LOGICAL

CODE_REFERENCEPOLICY_LOCAL

CODE_REFERENCEPOLICY_LITERAL

health.fhir.r5.international500: CapabilityStatementRestResourceSearchParamType

CapabilityStatementRestResourceSearchParamType enum

Members

CODE_TYPE_DATE

CODE_TYPE_REFERENCE

CODE_TYPE_SPECIAL

CODE_TYPE_NUMBER

CODE_TYPE_CAPABILTY_STATEMENT_QUANTITY

CODE_TYPE_STRING

CODE_TYPE_COMPOSITE

CODE_TYPE_URI

CODE_TYPE_TOKEN

health.fhir.r5.international500: CapabilityStatementRestResourceVersioning

CapabilityStatementRestResourceVersioning enum

Members

CODE_VERSIONING_VERSIONED_UPDATE

CODE_VERSIONING_VERSIONED

CODE_VERSIONING_NO_VERSION

health.fhir.r5.international500: CapabilityStatementStatus

CapabilityStatementStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CarePlanIntent

CarePlanIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_PLAN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

CODE_INTENT_DIRECTIVE

health.fhir.r5.international500: CarePlanStatus

CarePlanStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CareTeamStatus

CareTeamStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_PROPOSED

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_SUSPENDED

health.fhir.r5.international500: CDSHooksGuidanceResponseStatus

CDSHooksGuidanceResponseStatus enum

Members

CODE_STATUS_SUCCESS

CODE_STATUS_FAILURE

CODE_STATUS_DATA_REQUIRED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_DATA_REQUESTED

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionCardinalityBehavior

CDSHooksRequestOrchestrationActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionConditionKind

CDSHooksRequestOrchestrationActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionGroupingBehavior

CDSHooksRequestOrchestrationActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionParticipantType

CDSHooksRequestOrchestrationActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionPrecheckBehavior

CDSHooksRequestOrchestrationActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionPriority

CDSHooksRequestOrchestrationActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionRelatedActionEndRelationship

CDSHooksRequestOrchestrationActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionRelatedActionRelationship

CDSHooksRequestOrchestrationActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionRequiredBehavior

CDSHooksRequestOrchestrationActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionSelectionBehavior

CDSHooksRequestOrchestrationActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: CDSHooksRequestOrchestrationIntent

CDSHooksRequestOrchestrationIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: CDSHooksRequestOrchestrationPriority

CDSHooksRequestOrchestrationPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: CDSHooksRequestOrchestrationStatus

CDSHooksRequestOrchestrationStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionCardinalityBehavior

CDSHooksServicePlanDefinitionActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionConditionKind

CDSHooksServicePlanDefinitionActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionGroupingBehavior

CDSHooksServicePlanDefinitionActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionParticipantType

CDSHooksServicePlanDefinitionActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionPrecheckBehavior

CDSHooksServicePlanDefinitionActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionPriority

CDSHooksServicePlanDefinitionActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionRelatedActionEndRelationship

CDSHooksServicePlanDefinitionActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionRelatedActionRelationship

CDSHooksServicePlanDefinitionActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionRequiredBehavior

CDSHooksServicePlanDefinitionActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionSelectionBehavior

CDSHooksServicePlanDefinitionActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActorOptionType

CDSHooksServicePlanDefinitionActorOptionType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: CDSHooksServicePlanDefinitionStatus

CDSHooksServicePlanDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ChargeItemDefinitionStatus

ChargeItemDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ChargeItemStatus

ChargeItemStatus enum

Members

CODE_STATUS_NOT_BILLABLE

CODE_STATUS_BILLED

CODE_STATUS_ABORTED

CODE_STATUS_PLANNED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_BILLABLE

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CitationCitedArtifactRelatesToType

CitationCitedArtifactRelatesToType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_REPRINT_OF

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPRINT

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: CitationStatus

CitationStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ClaimResponseOutcome

ClaimResponseOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r5.international500: ClaimResponseStatus

ClaimResponseStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: ClaimResponseUse

ClaimResponseUse enum

Members

CODE_USE_PREDETERMINATION

CODE_USE_PREAUTHORIZATION

CODE_USE_CLAIM

health.fhir.r5.international500: ClaimStatus

ClaimStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: ClaimUse

ClaimUse enum

Members

CODE_USE_PREDETERMINATION

CODE_USE_PREAUTHORIZATION

CODE_USE_CLAIM

health.fhir.r5.international500: ClinicalDocumentStatus

ClinicalDocumentStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_APPENDED

CODE_STATUS_DEPRECATED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_CANCELLED

CODE_STATUS_PRELIMINARY

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_PARTIAL

CODE_STATUS_CORRECTED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ClinicalImpressionStatus

ClinicalImpressionStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ClinicalUseDefinitionType

ClinicalUseDefinitionType enum

Members

CODE_TYPE_INTERACTION

CODE_TYPE_WARNING

CODE_TYPE_INDICATION

CODE_TYPE_UNDESIRABLE_EFFECT

CODE_TYPE_CONTRAINDICATION

health.fhir.r5.international500: CommunicationPriority

CommunicationPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: CommunicationRequestIntent

CommunicationRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: CommunicationRequestPriority

CommunicationRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: CommunicationRequestStatus

CommunicationRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CommunicationStatus

CommunicationStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CompartmentDefinitionCode

CompartmentDefinitionCode enum

Members

CODE_CODE_PRACTITIONER

CODE_CODE_EPISODEOFCARE

CODE_CODE_DEVICE

CODE_CODE_PATIENT

CODE_CODE_ENCOUNTER

CODE_CODE_RELATEDPERSON

health.fhir.r5.international500: CompartmentDefinitionStatus

CompartmentDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: CompositionStatus

CompositionStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_APPENDED

CODE_STATUS_DEPRECATED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_CANCELLED

CODE_STATUS_PRELIMINARY

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_PARTIAL

CODE_STATUS_CORRECTED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ComputablePlanDefinitionActionCardinalityBehavior

ComputablePlanDefinitionActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: ComputablePlanDefinitionActionConditionKind

ComputablePlanDefinitionActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: ComputablePlanDefinitionActionGroupingBehavior

ComputablePlanDefinitionActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: ComputablePlanDefinitionActionParticipantType

ComputablePlanDefinitionActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: ComputablePlanDefinitionActionPrecheckBehavior

ComputablePlanDefinitionActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: ComputablePlanDefinitionActionPriority

ComputablePlanDefinitionActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: ComputablePlanDefinitionActionRelatedActionEndRelationship

ComputablePlanDefinitionActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: ComputablePlanDefinitionActionRelatedActionRelationship

ComputablePlanDefinitionActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: ComputablePlanDefinitionActionRequiredBehavior

ComputablePlanDefinitionActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: ComputablePlanDefinitionActionSelectionBehavior

ComputablePlanDefinitionActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: ComputablePlanDefinitionActorOptionType

ComputablePlanDefinitionActorOptionType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: ComputablePlanDefinitionStatus

ComputablePlanDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ConceptMapAdditionalAttributeType

ConceptMapAdditionalAttributeType enum

Members

CODE_TYPE_CODE

CODE_TYPE_BOOLEAN

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_QUANTITY

health.fhir.r5.international500: ConceptMapGroupElementTargetRelationship

ConceptMapGroupElementTargetRelationship enum

Members

CODE_RELATIONSHIP_EQUIVALENT

CODE_RELATIONSHIP_RELATED_TO

CODE_RELATIONSHIP_NOT_RELATED_TO

CODE_RELATIONSHIP_SOURCE_IS_NARROWER_THAN_TARGET

CODE_RELATIONSHIP_SOURCE_IS_BROADER_THAN_TARGET

health.fhir.r5.international500: ConceptMapGroupUnmappedMode

ConceptMapGroupUnmappedMode enum

Members

CODE_MODE_USE_SOURCE_CODE

CODE_MODE_FIXED

CODE_MODE_OTHER_MAP

health.fhir.r5.international500: ConceptMapGroupUnmappedRelationship

ConceptMapGroupUnmappedRelationship enum

Members

CODE_RELATIONSHIP_EQUIVALENT

CODE_RELATIONSHIP_RELATED_TO

CODE_RELATIONSHIP_NOT_RELATED_TO

CODE_RELATIONSHIP_SOURCE_IS_NARROWER_THAN_TARGET

CODE_RELATIONSHIP_SOURCE_IS_BROADER_THAN_TARGET

health.fhir.r5.international500: ConceptMapPropertyType

ConceptMapPropertyType enum

Members

CODE_TYPE_DATETIME

CODE_TYPE_BOOLEAN

CODE_TYPE_CODE

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_INTEGER

CODE_TYPE_DECIMAL

health.fhir.r5.international500: ConceptMapStatus

ConceptMapStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ConditionDefinitionPreconditionType

ConditionDefinitionPreconditionType enum

Members

CODE_TYPE_SENSITIVE

CODE_TYPE_SPECIFIC

health.fhir.r5.international500: ConditionDefinitionQuestionnairePurpose

ConditionDefinitionQuestionnairePurpose enum

Members

CODE_PURPOSE_DIFF_DIAGNOSIS

CODE_PURPOSE_PREADMIT

CODE_PURPOSE_OUTCOME

health.fhir.r5.international500: ConditionDefinitionStatus

ConditionDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ConsentDecision

ConsentDecision enum

Members

CODE_DECISION_DENY

CODE_DECISION_PERMIT

health.fhir.r5.international500: ConsentProvisionDataMeaning

ConsentProvisionDataMeaning enum

Members

CODE_MEANING_INSTANCE

CODE_MEANING_RELATED

CODE_MEANING_DEPENDENTS

CODE_MEANING_AUTHOREDBY

health.fhir.r5.international500: ConsentStatus

ConsentStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ContractContentDefinitionPublicationStatus

ContractContentDefinitionPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_AMENDED

CODE_PUBLICATIONSTATUS_DISPUTED

CODE_PUBLICATIONSTATUS_APPENDED

CODE_PUBLICATIONSTATUS_CANCELLED

CODE_PUBLICATIONSTATUS_ENTERED_IN_ERROR

CODE_PUBLICATIONSTATUS_EXECUTABLE

health.fhir.r5.international500: ContractStatus

ContractStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_DISPUTED

CODE_STATUS_APPENDED

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_EXECUTABLE

health.fhir.r5.international500: CoverageEligibilityRequestPurpose

CoverageEligibilityRequestPurpose enum

Members

CODE_PURPOSE_BENEFITS

CODE_PURPOSE_DISCOVERY

CODE_PURPOSE_AUTH_REQUIREMENTS

CODE_PURPOSE_VALIDATION

health.fhir.r5.international500: CoverageEligibilityRequestStatus

CoverageEligibilityRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: CoverageEligibilityResponseOutcome

CoverageEligibilityResponseOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r5.international500: CoverageEligibilityResponsePurpose

CoverageEligibilityResponsePurpose enum

Members

CODE_PURPOSE_BENEFITS

CODE_PURPOSE_DISCOVERY

CODE_PURPOSE_AUTH_REQUIREMENTS

CODE_PURPOSE_VALIDATION

health.fhir.r5.international500: CoverageEligibilityResponseStatus

CoverageEligibilityResponseStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: CoverageKind

CoverageKind enum

Members

CODE_KIND_INSURANCE

CODE_KIND_OTHER

CODE_KIND_SELF_PAY

health.fhir.r5.international500: CoverageStatus

CoverageStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: CQLLibraryRelatedArtifactPublicationStatus

CQLLibraryRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: CQLLibraryRelatedArtifactType

CQLLibraryRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: CQLLibraryStatus

CQLLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: DetectedIssueSeverity

DetectedIssueSeverity enum

Members

CODE_SEVERITY_HIGH

CODE_SEVERITY_LOW

CODE_SEVERITY_MODERATE

health.fhir.r5.international500: DetectedIssueStatus

DetectedIssueStatus enum

Members

CODE_STATUS_FINAL

CODE_STATUS_PRELIMINARY

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_MITIGATED

health.fhir.r5.international500: DeviceDefinitionCorrectiveActionScope

DeviceDefinitionCorrectiveActionScope enum

Members

CODE_SCOPE_LOT_NUMBERS

CODE_SCOPE_SERIAL_NUMBERS

CODE_SCOPE_MODEL

health.fhir.r5.international500: DeviceDefinitionDeviceNameType

DeviceDefinitionDeviceNameType enum

Members

CODE_TYPE_REGISTERED_NAME

CODE_TYPE_USER_FRIENDLY_NAME

CODE_TYPE_PATIENT_REPORTED_NAME

health.fhir.r5.international500: DeviceDefinitionProductionIdentifierInUDI

DeviceDefinitionProductionIdentifierInUDI enum

Members

CODE_PRODUCTIONIDENTIFIERINUDI_MANUFACTURED_DATE

CODE_PRODUCTIONIDENTIFIERINUDI_SOFTWARE_VERSION

CODE_PRODUCTIONIDENTIFIERINUDI_LOT_NUMBER

CODE_PRODUCTIONIDENTIFIERINUDI_SERIAL_NUMBER

CODE_PRODUCTIONIDENTIFIERINUDI_BIOLOGICAL_SOURCE

CODE_PRODUCTIONIDENTIFIERINUDI_EXPIRATION_DATE

health.fhir.r5.international500: DeviceDefinitionRegulatoryIdentifierType

DeviceDefinitionRegulatoryIdentifierType enum

Members

CODE_TYPE_LICENSE

CODE_TYPE_BASIC

CODE_TYPE_MASTER

health.fhir.r5.international500: DeviceDispenseStatus

DeviceDispenseStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_DECLINED

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: DeviceMetricCalibrationState

DeviceMetricCalibrationState enum

Members

CODE_STATE_UNSPECIFIED

CODE_STATE_NOT_CALIBRATED

CODE_STATE_CALIBRATION_REQUIRED

CODE_STATE_CALIBRATED

health.fhir.r5.international500: DeviceMetricCalibrationType

DeviceMetricCalibrationType enum

Members

CODE_TYPE_OFFSET

CODE_TYPE_UNSPECIFIED

CODE_TYPE_TWO_POINT

CODE_TYPE_GAIN

health.fhir.r5.international500: DeviceMetricCategory

DeviceMetricCategory enum

Members

CODE_CATEGORY_CALCULATION

CODE_CATEGORY_UNSPECIFIED

CODE_CATEGORY_MEASUREMENT

CODE_CATEGORY_SETTING

health.fhir.r5.international500: DeviceMetricObservationProfileStatus

DeviceMetricObservationProfileStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: DeviceMetricObservationProfileTriggeredByType

DeviceMetricObservationProfileTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: DeviceMetricOperationalStatus

DeviceMetricOperationalStatus enum

Members

CODE_OPERATIONALSTATUS_STANDBY

CODE_OPERATIONALSTATUS_ENTERED_IN_ERROR

CODE_OPERATIONALSTATUS_OFF

CODE_OPERATIONALSTATUS_ON

health.fhir.r5.international500: DeviceNameType

DeviceNameType enum

Members

CODE_TYPE_REGISTERED_NAME

CODE_TYPE_USER_FRIENDLY_NAME

CODE_TYPE_PATIENT_REPORTED_NAME

health.fhir.r5.international500: DeviceRequestIntent

DeviceRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: DeviceRequestPriority

DeviceRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: DeviceRequestStatus

DeviceRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: DeviceStatus

DeviceStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: DeviceUdiCarrierEntryType

DeviceUdiCarrierEntryType enum

Members

CODE_ENTRYTYPE_SELF_REPORTED

CODE_ENTRYTYPE_ELECTRONIC_TRANSMISSION

CODE_ENTRYTYPE_RFID

CODE_ENTRYTYPE_MANUAL

CODE_ENTRYTYPE_BARCODE

CODE_ENTRYTYPE_CARD

CODE_ENTRYTYPE_UNKNOWN

health.fhir.r5.international500: DeviceUsageStatus

DeviceUsageStatus enum

Members

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: DiagnosticReportStatus

DiagnosticReportStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_APPENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_MODIFIED

CODE_STATUS_CANCELLED

CODE_STATUS_PRELIMINARY

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_PARTIAL

CODE_STATUS_CORRECTED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: DocumentReferenceDocStatus

DocumentReferenceDocStatus enum

Members

CODE_DOCSTATUS_AMENDED

CODE_DOCSTATUS_APPENDED

CODE_DOCSTATUS_DEPRECATED

CODE_DOCSTATUS_FINAL

CODE_DOCSTATUS_REGISTERED

CODE_DOCSTATUS_CANCELLED

CODE_DOCSTATUS_PRELIMINARY

CODE_DOCSTATUS_ENTERED_IN_ERROR

CODE_DOCSTATUS_PARTIAL

CODE_DOCSTATUS_CORRECTED

CODE_DOCSTATUS_UNKNOWN

health.fhir.r5.international500: DocumentReferenceStatus

DocumentReferenceStatus enum

Members

CODE_STATUS_CURRENT

CODE_STATUS_SUPERSEDED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: EBMRecommendationContentInformationType

EBMRecommendationContentInformationType enum

Members

CODE_INFORMATIONTYPE_CONTAINER

CODE_INFORMATIONTYPE_RESPONSE

CODE_INFORMATIONTYPE_CHANGE_REQUEST

CODE_INFORMATIONTYPE_CLASSIFIER

CODE_INFORMATIONTYPE_RATING

CODE_INFORMATIONTYPE_COMMENT

health.fhir.r5.international500: EBMRecommendationDisposition

EBMRecommendationDisposition enum

Members

CODE_DISPOSITION_PERSUASIVE

CODE_DISPOSITION_UNRESOLVED

CODE_DISPOSITION_PERSUASIVE_WITH_MODIFICATION

CODE_DISPOSITION_NOT_PERSUASIVE

CODE_DISPOSITION_NOT_PERSUASIVE_WITH_MODIFICATION

health.fhir.r5.international500: EBMRecommendationWorkflowStatus

EBMRecommendationWorkflowStatus enum

Members

CODE_WORKFLOWSTATUS_TRIAGED

CODE_WORKFLOWSTATUS_DEFERRED

CODE_WORKFLOWSTATUS_SUBMITTED

CODE_WORKFLOWSTATUS_APPLIED

CODE_WORKFLOWSTATUS_DUPLICATE

CODE_WORKFLOWSTATUS_PUBLISHED

CODE_WORKFLOWSTATUS_ENTERED_IN_ERROR

CODE_WORKFLOWSTATUS_WAITING_FOR_INPUT

CODE_WORKFLOWSTATUS_RESOLVED_NO_CHANGE

CODE_WORKFLOWSTATUS_RESOLVED_CHANGE_REQUIRED

health.fhir.r5.international500: ElementdefinitionDeBindingAdditionalPurpose

Members

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_CANDIDATE

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_CURRENT

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_COMPONENT

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_UI

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_STARTER

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_MAXIMUM

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_MINIMUM

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_EXTENSIBLE

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_REQUIRED

CODE_ELEMENTDEFINITIONDEBINDINGADDITIONALPURPOSE_PREFERRED

health.fhir.r5.international500: ElementdefinitionDeBindingStrength

Members

CODE_ELEMENTDEFINITIONDEBINDINGSTRENGTH_EXTENSIBLE

CODE_ELEMENTDEFINITIONDEBINDINGSTRENGTH_REQUIRED

CODE_ELEMENTDEFINITIONDEBINDINGSTRENGTH_PREFERRED

CODE_ELEMENTDEFINITIONDEBINDINGSTRENGTH_EXAMPLE

health.fhir.r5.international500: ElementdefinitionDeConstraintSeverity

Members

CODE_ELEMENTDEFINITIONDECONSTRAINTSEVERITY_WARNING

CODE_ELEMENTDEFINITIONDECONSTRAINTSEVERITY_ERROR

health.fhir.r5.international500: ElementdefinitionDeRepresentation

Members

CODE_ELEMENTDEFINITIONDEREPRESENTATION_XMLTEXT

CODE_ELEMENTDEFINITIONDEREPRESENTATION_CDATEXT

CODE_ELEMENTDEFINITIONDEREPRESENTATION_XMLATTR

CODE_ELEMENTDEFINITIONDEREPRESENTATION_TYPEATTR

CODE_ELEMENTDEFINITIONDEREPRESENTATION_XHTML

health.fhir.r5.international500: ElementdefinitionDeSlicingDiscriminatorType

Members

CODE_ELEMENTDEFINITIONDESLICINGDISCRIMINATORTYPE_PROFILE

CODE_ELEMENTDEFINITIONDESLICINGDISCRIMINATORTYPE_EXISTS

CODE_ELEMENTDEFINITIONDESLICINGDISCRIMINATORTYPE_POSITION

CODE_ELEMENTDEFINITIONDESLICINGDISCRIMINATORTYPE_TYPE

CODE_ELEMENTDEFINITIONDESLICINGDISCRIMINATORTYPE_VALUE

health.fhir.r5.international500: ElementdefinitionDeSlicingRules

Members

CODE_ELEMENTDEFINITIONDESLICINGRULES_CLOSED

CODE_ELEMENTDEFINITIONDESLICINGRULES_OPENATEND

CODE_ELEMENTDEFINITIONDESLICINGRULES_OPEN

health.fhir.r5.international500: ElementdefinitionDeTypeAggregation

Members

CODE_ELEMENTDEFINITIONDETYPEAGGREGATION_CONTAINED

CODE_ELEMENTDEFINITIONDETYPEAGGREGATION_BUNDLED

CODE_ELEMENTDEFINITIONDETYPEAGGREGATION_REFERENCED

health.fhir.r5.international500: ElementdefinitionDeTypeVersioning

Members

CODE_ELEMENTDEFINITIONDETYPEVERSIONING_EITHER

CODE_ELEMENTDEFINITIONDETYPEVERSIONING_INDEPENDENT

CODE_ELEMENTDEFINITIONDETYPEVERSIONING_SPECIFIC

health.fhir.r5.international500: ELMLibraryRelatedArtifactPublicationStatus

ELMLibraryRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: ELMLibraryRelatedArtifactType

ELMLibraryRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: ELMLibraryStatus

ELMLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: EncounterHistoryStatus

EncounterHistoryStatus enum

Members

CODE_STATUS_DISCHARGED

CODE_STATUS_CANCELLED

CODE_STATUS_PLANNED

CODE_STATUS_COMPLETED

CODE_STATUS_DISCONTINUED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: EncounterLocationStatus

EncounterLocationStatus enum

Members

CODE_STATUS_RESERVED

CODE_STATUS_ACTIVE

CODE_STATUS_PLANNED

CODE_STATUS_COMPLETED

health.fhir.r5.international500: EncounterStatus

EncounterStatus enum

Members

CODE_STATUS_DISCHARGED

CODE_STATUS_CANCELLED

CODE_STATUS_PLANNED

CODE_STATUS_COMPLETED

CODE_STATUS_DISCONTINUED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: EndpointStatus

EndpointStatus enum

Members

CODE_STATUS_TEST

CODE_STATUS_ACTIVE

CODE_STATUS_ERROR

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_SUSPENDED

CODE_STATUS_OFF

health.fhir.r5.international500: EnrollmentRequestStatus

EnrollmentRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: EnrollmentResponseOutcome

EnrollmentResponseOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r5.international500: EnrollmentResponseStatus

EnrollmentResponseStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: EpisodeOfCareStatus

EpisodeOfCareStatus enum

Members

CODE_STATUS_ONHOLD

CODE_STATUS_WAITLIST

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: EpisodeOfCareStatusHistoryStatus

EpisodeOfCareStatusHistoryStatus enum

Members

CODE_STATUS_ONHOLD

CODE_STATUS_WAITLIST

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: EventDefinitionStatus

EventDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: EvidenceReportRelatesToCode

EvidenceReportRelatesToCode enum

Members

CODE_CODE_AMENDS

CODE_CODE_REPLACEDWITH

CODE_CODE_AMENDEDWITH

CODE_CODE_REPLACES

CODE_CODE_TRANSFORMEDWITH

CODE_CODE_TRANSFORMS

CODE_CODE_APPENDS

CODE_CODE_APPENDEDWITH

health.fhir.r5.international500: EvidenceReportSectionMode

EvidenceReportSectionMode enum

Members

CODE_MODE_CHANGES

CODE_MODE_WORKING

CODE_MODE_SNAPSHOT

health.fhir.r5.international500: EvidenceReportStatus

EvidenceReportStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: EvidenceStatisticModelCharacteristicVariableHandling

EvidenceStatisticModelCharacteristicVariableHandling enum

Members

CODE_HANDLING_CONTINUOUS

CODE_HANDLING_POLYCHOTOMOUS

CODE_HANDLING_DICHOTOMOUS

CODE_HANDLING_ORDINAL

health.fhir.r5.international500: EvidenceStatus

EvidenceStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: EvidenceVariableCharacteristicDefinitionByCombinationCode

EvidenceVariableCharacteristicDefinitionByCombinationCode enum

Members

CODE_CODE_STATISTICAL

CODE_CODE_ANY_OF

CODE_CODE_NET_EFFECT

CODE_CODE_AT_MOST

CODE_CODE_ALL_OF

CODE_CODE_DATASET

CODE_CODE_AT_LEAST

health.fhir.r5.international500: EvidenceVariableHandling

EvidenceVariableHandling enum

Members

CODE_HANDLING_CONTINUOUS

CODE_HANDLING_POLYCHOTOMOUS

CODE_HANDLING_DICHOTOMOUS

CODE_HANDLING_ORDINAL

health.fhir.r5.international500: EvidenceVariableStatus

EvidenceVariableStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ExampleLipidProfileStatusFour

ExampleLipidProfileStatusFour enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ExampleLipidProfileTriggeredByTypeThree

ExampleLipidProfileTriggeredByTypeThree enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ExampleScenarioActorType

ExampleScenarioActorType enum

Members

CODE_TYPE_SYSTEM

CODE_TYPE_PERSON

health.fhir.r5.international500: ExampleScenarioStatus

ExampleScenarioStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ExplanationOfBenefitOutcome

ExplanationOfBenefitOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r5.international500: ExplanationOfBenefitStatus

ExplanationOfBenefitStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: ExplanationOfBenefitUse

ExplanationOfBenefitUse enum

Members

CODE_USE_PREDETERMINATION

CODE_USE_PREAUTHORIZATION

CODE_USE_CLAIM

health.fhir.r5.international500: FamilyMemberHistoryForGeneticsAnalysisStatus

FamilyMemberHistoryForGeneticsAnalysisStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_HEALTH_UNKNOWN

CODE_STATUS_PARTIAL

health.fhir.r5.international500: FamilyMemberHistoryStatus

FamilyMemberHistoryStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_HEALTH_UNKNOWN

CODE_STATUS_PARTIAL

health.fhir.r5.international500: FHIRPathLibraryRelatedArtifactPublicationStatus

FHIRPathLibraryRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: FHIRPathLibraryRelatedArtifactType

FHIRPathLibraryRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: FHIRPathLibraryStatus

FHIRPathLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: FlagStatus

FlagStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: FormularyItemStatus

FormularyItemStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: GenomicStudyStatus

GenomicStudyStatus enum

Members

CODE_STATUS_AVAILABLE

CODE_STATUS_REGISTERED

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: GoalLifecycleStatus

GoalLifecycleStatus enum

Members

CODE_LIFECYCLESTATUS_PROPOSED

CODE_LIFECYCLESTATUS_REJECTED

CODE_LIFECYCLESTATUS_ACCEPTED

CODE_LIFECYCLESTATUS_ACTIVE

CODE_LIFECYCLESTATUS_CANCELLED

CODE_LIFECYCLESTATUS_PLANNED

CODE_LIFECYCLESTATUS_COMPLETED

CODE_LIFECYCLESTATUS_ENTERED_IN_ERROR

CODE_LIFECYCLESTATUS_ON_HOLD

health.fhir.r5.international500: GraphDefinitionLinkCompartmentCode

GraphDefinitionLinkCompartmentCode enum

Members

CODE_CODE_PRACTITIONER

CODE_CODE_EPISODEOFCARE

CODE_CODE_DEVICE

CODE_CODE_PATIENT

CODE_CODE_ENCOUNTER

CODE_CODE_RELATEDPERSON

health.fhir.r5.international500: GraphDefinitionLinkCompartmentRule

GraphDefinitionLinkCompartmentRule enum

Members

CODE_RULE_IDENTICAL

CODE_RULE_CUSTOM

CODE_RULE_DIFFERENT

CODE_RULE_MATCHING

health.fhir.r5.international500: GraphDefinitionLinkCompartmentUse

GraphDefinitionLinkCompartmentUse enum

Members

CODE_USE_WHERE

CODE_USE_REQUIRES

health.fhir.r5.international500: GraphDefinitionStatus

GraphDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: GroupDefinitionMembership

GroupDefinitionMembership enum

Members

CODE_MEMBERSHIP_DEFINITIONAL

CODE_MEMBERSHIP_ENUMERATED

health.fhir.r5.international500: GroupDefinitionType

GroupDefinitionType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PERSON

CODE_TYPE_ORGANIZATION

CODE_TYPE_SPECIMEN

CODE_TYPE_ANIMAL

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

health.fhir.r5.international500: GroupMembership

GroupMembership enum

Members

CODE_MEMBERSHIP_DEFINITIONAL

CODE_MEMBERSHIP_ENUMERATED

health.fhir.r5.international500: GroupType

GroupType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PERSON

CODE_TYPE_ORGANIZATION

CODE_TYPE_SPECIMEN

CODE_TYPE_ANIMAL

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

health.fhir.r5.international500: GuidanceResponseStatus

GuidanceResponseStatus enum

Members

CODE_STATUS_SUCCESS

CODE_STATUS_FAILURE

CODE_STATUS_DATA_REQUIRED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_DATA_REQUESTED

health.fhir.r5.international500: ImagingSelectionInstanceImageRegion2DRegionType

ImagingSelectionInstanceImageRegion2DRegionType enum

Members

CODE_REGIONTYPE_INTERPOLATED

CODE_REGIONTYPE_ELLIPSE

CODE_REGIONTYPE_CIRCLE

CODE_REGIONTYPE_POINT

CODE_REGIONTYPE_POLYLINE

health.fhir.r5.international500: ImagingSelectionInstanceImageRegion3DRegionType

ImagingSelectionInstanceImageRegion3DRegionType enum

Members

CODE_REGIONTYPE_POLYGON

CODE_REGIONTYPE_ELLIPSE

CODE_REGIONTYPE_POINT

CODE_REGIONTYPE_POLYLINE

CODE_REGIONTYPE_MULTIPOINT

CODE_REGIONTYPE_ELLIPSOID

health.fhir.r5.international500: ImagingSelectionStatus

ImagingSelectionStatus enum

Members

CODE_STATUS_AVAILABLE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ImagingStudyStatus

ImagingStudyStatus enum

Members

CODE_STATUS_AVAILABLE

CODE_STATUS_REGISTERED

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ImmunizationEvaluationStatus

ImmunizationEvaluationStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: ImmunizationStatus

ImmunizationStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_NOT_DONE

health.fhir.r5.international500: ImplementationGuideDefinitionPageGeneration

ImplementationGuideDefinitionPageGeneration enum

Members

CODE_GENERATION_GENERATED

CODE_GENERATION_XML

CODE_GENERATION_MARKDOWN

CODE_GENERATION_HTML

health.fhir.r5.international500: ImplementationGuideStatus

ImplementationGuideStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: IngredientManufacturerRole

IngredientManufacturerRole enum

Members

CODE_ROLE_ACTUAL

CODE_ROLE_ALLOWED

CODE_ROLE_POSSIBLE

health.fhir.r5.international500: IngredientStatus

IngredientStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: InsurancePlanStatus

InsurancePlanStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: InventoryItemStatus

InventoryItemStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: InventoryReportCountType

InventoryReportCountType enum

Members

CODE_COUNTTYPE_DIFFERENCE

CODE_COUNTTYPE_SNAPSHOT

health.fhir.r5.international500: InventoryReportStatus

InventoryReportStatus enum

Members

CODE_STATUS_REQUESTED

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: InvoiceStatus

InvoiceStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_CANCELLED

CODE_STATUS_ISSUED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_BALANCED

health.fhir.r5.international500: LibraryStatus

LibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: LinkageItemType

LinkageItemType enum

Members

CODE_TYPE_ALTERNATE

CODE_TYPE_HISTORICAL

CODE_TYPE_SOURCE

health.fhir.r5.international500: ListMode

ListMode enum

Members

CODE_MODE_CHANGES

CODE_MODE_WORKING

CODE_MODE_SNAPSHOT

health.fhir.r5.international500: ListStatus

ListStatus enum

Members

CODE_STATUS_CURRENT

CODE_STATUS_RETIRED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: LocationMode

LocationMode enum

Members

CODE_MODE_INSTANCE

CODE_MODE_KIND

health.fhir.r5.international500: LocationStatus

LocationStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_SUSPENDED

health.fhir.r5.international500: LogicLibraryRelatedArtifactPublicationStatus

LogicLibraryRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: LogicLibraryRelatedArtifactType

LogicLibraryRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: LogicLibraryStatus

LogicLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ManufacturedItemDefinitionStatus

ManufacturedItemDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MeasureReportDataUpdateType

MeasureReportDataUpdateType enum

Members

CODE_DATAUPDATETYPE_INCREMENTAL

CODE_DATAUPDATETYPE_SNAPSHOT

health.fhir.r5.international500: MeasureReportStatus

MeasureReportStatus enum

Members

CODE_STATUS_PENDING

CODE_STATUS_COMPLETE

CODE_STATUS_ERROR

health.fhir.r5.international500: MeasureReportType

MeasureReportType enum

Members

CODE_TYPE_SUMMARY

CODE_TYPE_DATA_EXCHANGE

CODE_TYPE_INDIVIDUAL

CODE_TYPE_SUBJECT_LIST

health.fhir.r5.international500: MeasureStatus

MeasureStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MedicationAdministrationStatus

MedicationAdministrationStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MedicationDispenseStatus

MedicationDispenseStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_DECLINED

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MedicationKnowledgeStatus

MedicationKnowledgeStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: MedicationRequestIntent

MedicationRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: MedicationRequestPriority

MedicationRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: MedicationRequestStatus

MedicationRequestStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_DRAFT

CODE_STATUS_ENDED

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MedicationStatementStatus

MedicationStatementStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_RECORDED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: MedicationStatus

MedicationStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: MessageDefinitionCategory

MessageDefinitionCategory enum

Members

CODE_CATEGORY_NOTIFICATION

CODE_CATEGORY_CONSEQUENCE

CODE_CATEGORY_CURRENCY

health.fhir.r5.international500: MessageDefinitionResponseRequired

MessageDefinitionResponseRequired enum

Members

CODE_RESPONSEREQUIRED_ALWAYS

CODE_RESPONSEREQUIRED_NEVER

CODE_RESPONSEREQUIRED_ON_ERROR

CODE_RESPONSEREQUIRED_ON_SUCCESS

health.fhir.r5.international500: MessageDefinitionStatus

MessageDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MessageHeaderResponseCode

MessageHeaderResponseCode enum

Members

CODE_CODE_FATAL_ERROR

CODE_CODE_OK

CODE_CODE_TRANSIENT_ERROR

health.fhir.r5.international500: MetadataResourceStatus

MetadataResourceStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ModelInfoLibraryStatus

ModelInfoLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ModuleDefinitionLibraryRelatedArtifactPublicationStatus

ModuleDefinitionLibraryRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: ModuleDefinitionLibraryRelatedArtifactType

ModuleDefinitionLibraryRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: ModuleDefinitionLibraryStatus

ModuleDefinitionLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: MolecularSequenceRelativeStartingSequenceOrientation

MolecularSequenceRelativeStartingSequenceOrientation enum

Members

CODE_ORIENTATION_SENSE

CODE_ORIENTATION_ANTISENSE

health.fhir.r5.international500: MolecularSequenceRelativeStartingSequenceStrand

MolecularSequenceRelativeStartingSequenceStrand enum

Members

CODE_STRAND_WATSON

CODE_STRAND_CRICK

health.fhir.r5.international500: MolecularSequenceType

MolecularSequenceType enum

Members

CODE_TYPE_AA

CODE_TYPE_RNA

CODE_TYPE_DNA

health.fhir.r5.international500: NamingSystemKind

NamingSystemKind enum

Members

CODE_KIND_IDENTIFIER

CODE_KIND_CODESYSTEM

CODE_KIND_ROOT

health.fhir.r5.international500: NamingSystemStatus

NamingSystemStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: NamingSystemUniqueIdType

NamingSystemUniqueIdType enum

Members

CODE_TYPE_V2CSMNEMONIC

CODE_TYPE_OTHER

CODE_TYPE_IRI_STEM

CODE_TYPE_OID

CODE_TYPE_UUID

CODE_TYPE_URI

health.fhir.r5.international500: NutritionIntakeStatus

NutritionIntakeStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: NutritionOrderIntent

NutritionOrderIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: NutritionOrderPriority

NutritionOrderPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: NutritionOrderStatus

NutritionOrderStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: NutritionProductStatus

NutritionProductStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: ObservationbmiStatus

ObservationbmiStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationbmiTriggeredByType

ObservationbmiTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationbmiValueComparator

ObservationbmiValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationbodyheightStatus

ObservationbodyheightStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationbodyheightTriggeredByType

ObservationbodyheightTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationbodyheightValueComparator

ObservationbodyheightValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationbodytempStatus

ObservationbodytempStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationbodytempTriggeredByType

ObservationbodytempTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationbodytempValueComparator

ObservationbodytempValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationbodyweightStatus

ObservationbodyweightStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationbodyweightTriggeredByType

ObservationbodyweightTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationbodyweightValueComparator

ObservationbodyweightValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationbpStatus

ObservationbpStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationbpTriggeredByType

ObservationbpTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationDefinitionComponentPermittedDataType

ObservationDefinitionComponentPermittedDataType enum

Members

CODE_PERMITTEDDATATYPE_DATETIME

CODE_PERMITTEDDATATYPE_BOOLEAN

CODE_PERMITTEDDATATYPE_STRING

CODE_PERMITTEDDATATYPE_SAMPLEDDATA

CODE_PERMITTEDDATATYPE_QUANTITY

CODE_PERMITTEDDATATYPE_PERIOD

CODE_PERMITTEDDATATYPE_RATIO

CODE_PERMITTEDDATATYPE_INTEGER

CODE_PERMITTEDDATATYPE_TIME

CODE_PERMITTEDDATATYPE_RANGE

CODE_PERMITTEDDATATYPE_CODEABLECONCEPT

health.fhir.r5.international500: ObservationDefinitionPermittedDataType

ObservationDefinitionPermittedDataType enum

Members

CODE_PERMITTEDDATATYPE_DATETIME

CODE_PERMITTEDDATATYPE_BOOLEAN

CODE_PERMITTEDDATATYPE_STRING

CODE_PERMITTEDDATATYPE_SAMPLEDDATA

CODE_PERMITTEDDATATYPE_QUANTITY

CODE_PERMITTEDDATATYPE_PERIOD

CODE_PERMITTEDDATATYPE_RATIO

CODE_PERMITTEDDATATYPE_INTEGER

CODE_PERMITTEDDATATYPE_TIME

CODE_PERMITTEDDATATYPE_RANGE

CODE_PERMITTEDDATATYPE_CODEABLECONCEPT

health.fhir.r5.international500: ObservationDefinitionQualifiedValueGender

ObservationDefinitionQualifiedValueGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r5.international500: ObservationDefinitionQualifiedValueRangeCategory

ObservationDefinitionQualifiedValueRangeCategory enum

Members

CODE_RANGECATEGORY_REFERENCE

CODE_RANGECATEGORY_CRITICAL

CODE_RANGECATEGORY_ABSOLUTE

health.fhir.r5.international500: ObservationDefinitionStatus

ObservationDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ObservationheadcircumStatus

ObservationheadcircumStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationheadcircumTriggeredByType

ObservationheadcircumTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationheadcircumValueComparator

ObservationheadcircumValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationheartrateStatus

ObservationheartrateStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationheartrateTriggeredByType

ObservationheartrateTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationheartrateValueComparator

ObservationheartrateValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationoxygensatStatus

ObservationoxygensatStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationoxygensatTriggeredByType

ObservationoxygensatTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationoxygensatValueComparator

ObservationoxygensatValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationresprateStatus

ObservationresprateStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationresprateTriggeredByType

ObservationresprateTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationresprateValueComparator

ObservationresprateValueComparator enum

Members

CODE_COMPARATOR_LESS_THAN_OR_EQUAL

CODE_COMPARATOR_AD

CODE_COMPARATOR_LESS_THAN

CODE_COMPARATOR_GREATER_THAN

CODE_COMPARATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: ObservationStatus

ObservationStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationTriggeredByType

ObservationTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationvitalsignsStatus

ObservationvitalsignsStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationvitalsignsTriggeredByType

ObservationvitalsignsTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: ObservationvitalspanelStatus

ObservationvitalspanelStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: ObservationvitalspanelTriggeredByType

ObservationvitalspanelTriggeredByType enum

Members

CODE_TYPE_REPEAT

CODE_TYPE_REFLEX

CODE_TYPE_RE_RUN

health.fhir.r5.international500: OperationDefinitionKind

OperationDefinitionKind enum

Members

CODE_KIND_QUERY

CODE_KIND_OPERATION

health.fhir.r5.international500: OperationDefinitionParameterBindingStrength

OperationDefinitionParameterBindingStrength enum

Members

CODE_STRENGTH_EXTENSIBLE

CODE_STRENGTH_REQUIRED

CODE_STRENGTH_PREFERRED

CODE_STRENGTH_EXAMPLE

health.fhir.r5.international500: OperationDefinitionParameterScope

OperationDefinitionParameterScope enum

Members

CODE_SCOPE_INSTANCE

CODE_SCOPE_SYSTEM

CODE_SCOPE_TYPE

health.fhir.r5.international500: OperationDefinitionParameterSearchType

OperationDefinitionParameterSearchType enum

Members

CODE_SEARCHTYPE_DATE

CODE_SEARCHTYPE_REFERENCE

CODE_SEARCHTYPE_SPECIAL

CODE_SEARCHTYPE_NUMBER

CODE_SEARCHTYPE_QUANTITY

CODE_SEARCHTYPE_STRING

CODE_SEARCHTYPE_COMPOSITE

CODE_SEARCHTYPE_URI

CODE_SEARCHTYPE_TOKEN

health.fhir.r5.international500: OperationDefinitionParameterUse

OperationDefinitionParameterUse enum

Members

CODE_USE_IN

CODE_USE_OUT

health.fhir.r5.international500: OperationDefinitionStatus

OperationDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PatientContactGender

PatientContactGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r5.international500: PatientGender

PatientGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r5.international500: PatientLinkType

PatientLinkType enum

Members

CODE_TYPE_REFER

CODE_TYPE_REPLACES

CODE_TYPE_SEEALSO

CODE_TYPE_REPLACED_BY

health.fhir.r5.international500: PaymentNoticeStatus

PaymentNoticeStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: PaymentReconciliationOutcome

PaymentReconciliationOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r5.international500: PaymentReconciliationProcessNoteType

PaymentReconciliationProcessNoteType enum

Members

CODE_TYPE_PRINT

CODE_TYPE_DISPLAY

CODE_TYPE_PRINTOPER

health.fhir.r5.international500: PaymentReconciliationStatus

PaymentReconciliationStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: PermissionCombining

PermissionCombining enum

Members

CODE_COMBINING_DENY_OVERRIDES

CODE_COMBINING_PERMIT_UNLESS_DENY

CODE_COMBINING_PERMIT_OVERRIDES

CODE_COMBINING_ORDERED_PERMIT_OVERRIDES

CODE_COMBINING_DENY_UNLESS_PERMIT

CODE_COMBINING_ORDERED_DENY_OVERRIDES

health.fhir.r5.international500: PermissionRuleDataResourceMeaning

PermissionRuleDataResourceMeaning enum

Members

CODE_MEANING_INSTANCE

CODE_MEANING_RELATED

CODE_MEANING_DEPENDENTS

CODE_MEANING_AUTHOREDBY

health.fhir.r5.international500: PermissionRuleType

PermissionRuleType enum

Members

CODE_TYPE_DENY

CODE_TYPE_PERMIT

health.fhir.r5.international500: PermissionStatus

PermissionStatus enum

Members

CODE_STATUS_REJECTED

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: PersonGender

PersonGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r5.international500: PersonLinkAssurance

PersonLinkAssurance enum

Members

CODE_ASSURANCE_LEVEL4

CODE_ASSURANCE_LEVEL1

CODE_ASSURANCE_LEVEL3

CODE_ASSURANCE_LEVEL2

health.fhir.r5.international500: PlanDefinitionActionCardinalityBehavior

PlanDefinitionActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: PlanDefinitionActionConditionKind

PlanDefinitionActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: PlanDefinitionActionGroupingBehavior

PlanDefinitionActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: PlanDefinitionActionParticipantType

PlanDefinitionActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: PlanDefinitionActionPrecheckBehavior

PlanDefinitionActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: PlanDefinitionActionPriority

PlanDefinitionActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: PlanDefinitionActionRelatedActionEndRelationship

PlanDefinitionActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: PlanDefinitionActionRelatedActionRelationship

PlanDefinitionActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: PlanDefinitionActionRequiredBehavior

PlanDefinitionActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: PlanDefinitionActionSelectionBehavior

PlanDefinitionActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: PlanDefinitionActorOptionType

PlanDefinitionActorOptionType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: PlanDefinitionStatus

PlanDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PractitionerGender

PractitionerGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r5.international500: ProcedureStatus

ProcedureStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ProfileForCatalogStatus

ProfileForCatalogStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_APPENDED

CODE_STATUS_DEPRECATED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_CANCELLED

CODE_STATUS_PRELIMINARY

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_PARTIAL

CODE_STATUS_CORRECTED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ProvenanceEntityRole

ProvenanceEntityRole enum

Members

CODE_ROLE_INSTANTIATES

CODE_ROLE_REMOVAL

CODE_ROLE_SOURCE

CODE_ROLE_QUOTATION

CODE_ROLE_REVISION

health.fhir.r5.international500: ProvenanceRelevantHistoryEntityRole

ProvenanceRelevantHistoryEntityRole enum

Members

CODE_ROLE_INSTANTIATES

CODE_ROLE_REMOVAL

CODE_ROLE_SOURCE

CODE_ROLE_QUOTATION

CODE_ROLE_REVISION

health.fhir.r5.international500: PublishableActivityDefinitionIntent

PublishableActivityDefinitionIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: PublishableActivityDefinitionParticipantType

PublishableActivityDefinitionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: PublishableActivityDefinitionPriority

PublishableActivityDefinitionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: PublishableActivityDefinitionRelatedArtifactPublicationStatus

PublishableActivityDefinitionRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: PublishableActivityDefinitionRelatedArtifactType

PublishableActivityDefinitionRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: PublishableActivityDefinitionStatus

PublishableActivityDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PublishableConceptMapAdditionalAttributeType

PublishableConceptMapAdditionalAttributeType enum

Members

CODE_TYPE_CODE

CODE_TYPE_BOOLEAN

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_QUANTITY

health.fhir.r5.international500: PublishableConceptMapGroupElementTargetRelationship

PublishableConceptMapGroupElementTargetRelationship enum

Members

CODE_RELATIONSHIP_EQUIVALENT

CODE_RELATIONSHIP_RELATED_TO

CODE_RELATIONSHIP_NOT_RELATED_TO

CODE_RELATIONSHIP_SOURCE_IS_NARROWER_THAN_TARGET

CODE_RELATIONSHIP_SOURCE_IS_BROADER_THAN_TARGET

health.fhir.r5.international500: PublishableConceptMapGroupUnmappedMode

PublishableConceptMapGroupUnmappedMode enum

Members

CODE_MODE_USE_SOURCE_CODE

CODE_MODE_FIXED

CODE_MODE_OTHER_MAP

health.fhir.r5.international500: PublishableConceptMapGroupUnmappedRelationship

PublishableConceptMapGroupUnmappedRelationship enum

Members

CODE_RELATIONSHIP_EQUIVALENT

CODE_RELATIONSHIP_RELATED_TO

CODE_RELATIONSHIP_NOT_RELATED_TO

CODE_RELATIONSHIP_SOURCE_IS_NARROWER_THAN_TARGET

CODE_RELATIONSHIP_SOURCE_IS_BROADER_THAN_TARGET

health.fhir.r5.international500: PublishableConceptMapPropertyType

PublishableConceptMapPropertyType enum

Members

CODE_TYPE_DATETIME

CODE_TYPE_BOOLEAN

CODE_TYPE_CODE

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_INTEGER

CODE_TYPE_DECIMAL

health.fhir.r5.international500: PublishableConceptMapStatus

PublishableConceptMapStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PublishableLibraryRelatedArtifactPublicationStatus

PublishableLibraryRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: PublishableLibraryRelatedArtifactType

PublishableLibraryRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: PublishableLibraryStatus

PublishableLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PublishableMeasureRelatedArtifactPublicationStatus

PublishableMeasureRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: PublishableMeasureRelatedArtifactType

PublishableMeasureRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: PublishableMeasureStatus

PublishableMeasureStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PublishableNamingSystemKind

PublishableNamingSystemKind enum

Members

CODE_KIND_IDENTIFIER

CODE_KIND_CODESYSTEM

CODE_KIND_ROOT

health.fhir.r5.international500: PublishableNamingSystemStatus

PublishableNamingSystemStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: PublishableNamingSystemUniqueIdType

PublishableNamingSystemUniqueIdType enum

Members

CODE_TYPE_V2CSMNEMONIC

CODE_TYPE_OTHER

CODE_TYPE_IRI_STEM

CODE_TYPE_OID

CODE_TYPE_UUID

CODE_TYPE_URI

health.fhir.r5.international500: PublishablePlanDefinitionActionCardinalityBehavior

PublishablePlanDefinitionActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: PublishablePlanDefinitionActionConditionKind

PublishablePlanDefinitionActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: PublishablePlanDefinitionActionGroupingBehavior

PublishablePlanDefinitionActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: PublishablePlanDefinitionActionParticipantType

PublishablePlanDefinitionActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: PublishablePlanDefinitionActionPrecheckBehavior

PublishablePlanDefinitionActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: PublishablePlanDefinitionActionPriority

PublishablePlanDefinitionActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: PublishablePlanDefinitionActionRelatedActionEndRelationship

PublishablePlanDefinitionActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: PublishablePlanDefinitionActionRelatedActionRelationship

PublishablePlanDefinitionActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: PublishablePlanDefinitionActionRequiredBehavior

PublishablePlanDefinitionActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: PublishablePlanDefinitionActionSelectionBehavior

PublishablePlanDefinitionActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: PublishablePlanDefinitionActorOptionType

PublishablePlanDefinitionActorOptionType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: PublishablePlanDefinitionRelatedArtifactPublicationStatus

PublishablePlanDefinitionRelatedArtifactPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DRAFT

CODE_PUBLICATIONSTATUS_ACTIVE

CODE_PUBLICATIONSTATUS_RETIRED

CODE_PUBLICATIONSTATUS_UNKNOWN

health.fhir.r5.international500: PublishablePlanDefinitionRelatedArtifactType

PublishablePlanDefinitionRelatedArtifactType enum

Members

CODE_TYPE_SUCCESSOR

CODE_TYPE_COMMENT_IN

CODE_TYPE_CITED_BY

CODE_TYPE_RETRACTED_BY

CODE_TYPE_TRANSFORMED_INTO

CODE_TYPE_DOCUMENTS

CODE_TYPE_SPECIFICATION_OF

CODE_TYPE_TRANSFORMS

CODE_TYPE_DERIVED_FROM

CODE_TYPE_PART_OF

CODE_TYPE_SUPPORTED_WITH

CODE_TYPE_PREDECESSOR

CODE_TYPE_COMPOSED_OF

CODE_TYPE_DEPENDS_ON

CODE_TYPE_AMENDS

CODE_TYPE_RETRACTS

CODE_TYPE_SIGNS

CODE_TYPE_CORRECTION_IN

CODE_TYPE_AMENDED_WITH

CODE_TYPE_CITES

CODE_TYPE_SUPPORTS

CODE_TYPE_JUSTIFICATION

CODE_TYPE_CONTAINED_IN

CODE_TYPE_REPLACED_WITH

CODE_TYPE_CITATION

CODE_TYPE_TRANSFORMED_WITH

CODE_TYPE_REPLACES

CODE_TYPE_DOCUMENTATION

CODE_TYPE_SIMILAR_TO

CODE_TYPE_APPENDS

CODE_TYPE_CREATED_WITH

CODE_TYPE_CORRECTS

CODE_TYPE_CITE_AS

CODE_TYPE_CONTAINS

CODE_TYPE_APPENDED_WITH

CODE_TYPE_COMMENTS_ON

health.fhir.r5.international500: PublishablePlanDefinitionStatus

PublishablePlanDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: QuestionnaireItemAnswerConstraint

QuestionnaireItemAnswerConstraint enum

Members

CODE_ANSWERCONSTRAINT_OPTIONSONLY

CODE_ANSWERCONSTRAINT_OPTIONSORTYPE

CODE_ANSWERCONSTRAINT_OPTIONSORSTRING

health.fhir.r5.international500: QuestionnaireItemDisabledDisplay

QuestionnaireItemDisabledDisplay enum

Members

CODE_DISABLEDDISPLAY_HIDDEN

CODE_DISABLEDDISPLAY_PROTECTED

health.fhir.r5.international500: QuestionnaireItemEnableBehavior

QuestionnaireItemEnableBehavior enum

Members

CODE_ENABLEBEHAVIOR_ALL

CODE_ENABLEBEHAVIOR_ANY

health.fhir.r5.international500: QuestionnaireItemEnableWhenOperator

QuestionnaireItemEnableWhenOperator enum

Members

CODE_OPERATOR_LESS_THAN_OR_EQUAL

CODE_OPERATOR_EXISTS

CODE_OPERATOR_NOT_EQUAL

CODE_OPERATOR_LESS_THAN

CODE_OPERATOR_EQUAL

CODE_OPERATOR_GREATER_THAN

CODE_OPERATOR_GREATER_THAN_OR_EQUAL

health.fhir.r5.international500: QuestionnaireItemType

QuestionnaireItemType enum

Members

CODE_TYPE_DATE

CODE_TYPE_DATETIME

CODE_TYPE_BOOLEAN

CODE_TYPE_DISPLAY

CODE_TYPE_INTEGER

CODE_TYPE_DECIMAL

CODE_TYPE_GROUP

health.fhir.r5.international500: QuestionnaireResponseStatus

QuestionnaireResponseStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r5.international500: QuestionnaireStatus

QuestionnaireStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: RelatedPersonGender

RelatedPersonGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r5.international500: RequestOrchestrationActionCardinalityBehavior

RequestOrchestrationActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: RequestOrchestrationActionConditionKind

RequestOrchestrationActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: RequestOrchestrationActionGroupingBehavior

RequestOrchestrationActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: RequestOrchestrationActionParticipantType

RequestOrchestrationActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: RequestOrchestrationActionPrecheckBehavior

RequestOrchestrationActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: RequestOrchestrationActionPriority

RequestOrchestrationActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: RequestOrchestrationActionRelatedActionEndRelationship

RequestOrchestrationActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: RequestOrchestrationActionRelatedActionRelationship

RequestOrchestrationActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: RequestOrchestrationActionRequiredBehavior

RequestOrchestrationActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: RequestOrchestrationActionSelectionBehavior

RequestOrchestrationActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: RequestOrchestrationIntent

RequestOrchestrationIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: RequestOrchestrationPriority

RequestOrchestrationPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: RequestOrchestrationStatus

RequestOrchestrationStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: RequirementsStatementConformance

RequirementsStatementConformance enum

Members

CODE_CONFORMANCE_MAY

CODE_CONFORMANCE_SHOULD_NOT

CODE_CONFORMANCE_SHOULD

CODE_CONFORMANCE_SHALL

health.fhir.r5.international500: RequirementsStatus

RequirementsStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ResearchStudyStatus

ResearchStudyStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ResearchSubjectStatus

ResearchSubjectStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: RiskAssessmentStatus

RiskAssessmentStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r5.international500: SearchParameterComparator

SearchParameterComparator enum

Members

CODE_COMPARATOR_NE

CODE_COMPARATOR_LT

CODE_COMPARATOR_LE

CODE_COMPARATOR_EQ

CODE_COMPARATOR_GT

CODE_COMPARATOR_EB

CODE_COMPARATOR_GE

CODE_COMPARATOR_SA

CODE_COMPARATOR_AP

health.fhir.r5.international500: SearchParameterModifier

SearchParameterModifier enum

Members

CODE_MODIFIER_IDENTIFIER

CODE_MODIFIER_OF_TYPE

CODE_MODIFIER_IN

CODE_MODIFIER_BELOW

CODE_MODIFIER_TYPE

CODE_MODIFIER_CONTAINS

CODE_MODIFIER_NOT

CODE_MODIFIER_MISSING

CODE_MODIFIER_EXACT

CODE_MODIFIER_ABOVE

CODE_MODIFIER_NOT_IN

CODE_MODIFIER_TEXT

CODE_MODIFIER_TEXT_ADVANCED

CODE_MODIFIER_CODE_TEXT

CODE_MODIFIER_ITERATE

health.fhir.r5.international500: SearchParameterProcessingMode

SearchParameterProcessingMode enum

Members

CODE_PROCESSINGMODE_NORMAL

CODE_PROCESSINGMODE_OTHER

CODE_PROCESSINGMODE_PHONETIC

health.fhir.r5.international500: SearchParameterStatus

SearchParameterStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: SearchParameterType

SearchParameterType enum

Members

CODE_TYPE_DATE

CODE_TYPE_REFERENCE

CODE_TYPE_SPECIAL

CODE_TYPE_NUMBER

CODE_TYPE_SEARCH_PARAM_QUANTITY

CODE_TYPE_STRING

CODE_TYPE_COMPOSITE

CODE_TYPE_URI

CODE_TYPE_TOKEN

health.fhir.r5.international500: ServiceRequestIntent

ServiceRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

health.fhir.r5.international500: ServiceRequestPriority

ServiceRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: ServiceRequestStatus

ServiceRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableActivityDefinitionIntent

ShareableActivityDefinitionIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: ShareableActivityDefinitionParticipantType

ShareableActivityDefinitionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: ShareableActivityDefinitionPriority

ShareableActivityDefinitionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: ShareableActivityDefinitionStatus

ShareableActivityDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableConceptMapAdditionalAttributeType

ShareableConceptMapAdditionalAttributeType enum

Members

CODE_TYPE_CODE

CODE_TYPE_BOOLEAN

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_QUANTITY

health.fhir.r5.international500: ShareableConceptMapGroupElementTargetRelationship

ShareableConceptMapGroupElementTargetRelationship enum

Members

CODE_RELATIONSHIP_EQUIVALENT

CODE_RELATIONSHIP_RELATED_TO

CODE_RELATIONSHIP_NOT_RELATED_TO

CODE_RELATIONSHIP_SOURCE_IS_NARROWER_THAN_TARGET

CODE_RELATIONSHIP_SOURCE_IS_BROADER_THAN_TARGET

health.fhir.r5.international500: ShareableConceptMapGroupUnmappedMode

ShareableConceptMapGroupUnmappedMode enum

Members

CODE_MODE_USE_SOURCE_CODE

CODE_MODE_FIXED

CODE_MODE_OTHER_MAP

health.fhir.r5.international500: ShareableConceptMapGroupUnmappedRelationship

ShareableConceptMapGroupUnmappedRelationship enum

Members

CODE_RELATIONSHIP_EQUIVALENT

CODE_RELATIONSHIP_RELATED_TO

CODE_RELATIONSHIP_NOT_RELATED_TO

CODE_RELATIONSHIP_SOURCE_IS_NARROWER_THAN_TARGET

CODE_RELATIONSHIP_SOURCE_IS_BROADER_THAN_TARGET

health.fhir.r5.international500: ShareableConceptMapPropertyType

ShareableConceptMapPropertyType enum

Members

CODE_TYPE_DATETIME

CODE_TYPE_BOOLEAN

CODE_TYPE_CODE

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_INTEGER

CODE_TYPE_DECIMAL

health.fhir.r5.international500: ShareableConceptMapStatus

ShareableConceptMapStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableLibraryStatus

ShareableLibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableMeasureStatus

ShareableMeasureStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableNamingSystemKind

ShareableNamingSystemKind enum

Members

CODE_KIND_IDENTIFIER

CODE_KIND_CODESYSTEM

CODE_KIND_ROOT

health.fhir.r5.international500: ShareableNamingSystemStatus

ShareableNamingSystemStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableNamingSystemUniqueIdType

ShareableNamingSystemUniqueIdType enum

Members

CODE_TYPE_V2CSMNEMONIC

CODE_TYPE_OTHER

CODE_TYPE_IRI_STEM

CODE_TYPE_OID

CODE_TYPE_UUID

CODE_TYPE_URI

health.fhir.r5.international500: ShareablePlanDefinitionActionCardinalityBehavior

ShareablePlanDefinitionActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r5.international500: ShareablePlanDefinitionActionConditionKind

ShareablePlanDefinitionActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r5.international500: ShareablePlanDefinitionActionGroupingBehavior

ShareablePlanDefinitionActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r5.international500: ShareablePlanDefinitionActionParticipantType

ShareablePlanDefinitionActionParticipantType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: ShareablePlanDefinitionActionPrecheckBehavior

ShareablePlanDefinitionActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r5.international500: ShareablePlanDefinitionActionPriority

ShareablePlanDefinitionActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: ShareablePlanDefinitionActionRelatedActionEndRelationship

ShareablePlanDefinitionActionRelatedActionEndRelationship enum

Members

CODE_ENDRELATIONSHIP_AFTER_END

CODE_ENDRELATIONSHIP_BEFORE

CODE_ENDRELATIONSHIP_CONCURRENT

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_START

CODE_ENDRELATIONSHIP_BEFORE_END

CODE_ENDRELATIONSHIP_AFTER

CODE_ENDRELATIONSHIP_CONCURRENT_WITH_END

CODE_ENDRELATIONSHIP_AFTER_START

CODE_ENDRELATIONSHIP_BEFORE_START

health.fhir.r5.international500: ShareablePlanDefinitionActionRelatedActionRelationship

ShareablePlanDefinitionActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r5.international500: ShareablePlanDefinitionActionRequiredBehavior

ShareablePlanDefinitionActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r5.international500: ShareablePlanDefinitionActionSelectionBehavior

ShareablePlanDefinitionActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r5.international500: ShareablePlanDefinitionActorOptionType

ShareablePlanDefinitionActorOptionType enum

Members

CODE_TYPE_CARETEAM

CODE_TYPE_PRACTITIONER

CODE_TYPE_PRACTITIONERROLE

CODE_TYPE_PATIENT

CODE_TYPE_ORGANIZATION

CODE_TYPE_LOCATION

CODE_TYPE_RELATEDPERSON

CODE_TYPE_DEVICE

CODE_TYPE_HEALTHCARESERVICE

CODE_TYPE_GROUP

health.fhir.r5.international500: ShareablePlanDefinitionStatus

ShareablePlanDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: ShareableTestScriptSetupActionAssertDefaultManualCompletion

ShareableTestScriptSetupActionAssertDefaultManualCompletion enum

Members

CODE_DEFAULTMANUALCOMPLETION_FAIL

CODE_DEFAULTMANUALCOMPLETION_STOP

CODE_DEFAULTMANUALCOMPLETION_PASS

CODE_DEFAULTMANUALCOMPLETION_SKIP

health.fhir.r5.international500: ShareableTestScriptSetupActionAssertDirection

ShareableTestScriptSetupActionAssertDirection enum

Members

CODE_DIRECTION_REQUEST

CODE_DIRECTION_RESPONSE

health.fhir.r5.international500: ShareableTestScriptSetupActionAssertOperator

ShareableTestScriptSetupActionAssertOperator enum

Members

CODE_OPERATOR_CONTAINS

CODE_OPERATOR_EVAL

CODE_OPERATOR_MANUALEVAL

CODE_OPERATOR_IN

CODE_OPERATOR_NOTCONTAINS

CODE_OPERATOR_EQUALS

CODE_OPERATOR_LESSTHAN

CODE_OPERATOR_NOTEQUALS

CODE_OPERATOR_NOTIN

CODE_OPERATOR_NOTEMPTY

CODE_OPERATOR_GREATERTHAN

CODE_OPERATOR_EMPTY

health.fhir.r5.international500: ShareableTestScriptSetupActionAssertRequestMethod

ShareableTestScriptSetupActionAssertRequestMethod enum

Members

CODE_REQUESTMETHOD_PATCH

CODE_REQUESTMETHOD_HEAD

CODE_REQUESTMETHOD_POST

CODE_REQUESTMETHOD_GET

CODE_REQUESTMETHOD_OPTIONS

CODE_REQUESTMETHOD_DELETE

CODE_REQUESTMETHOD_PUT

health.fhir.r5.international500: ShareableTestScriptSetupActionAssertResponse

ShareableTestScriptSetupActionAssertResponse enum

Members

CODE_RESPONSE_NOCONTENT

CODE_RESPONSE_BADREQUEST

CODE_RESPONSE_EXPECTATIONFAILED

CODE_RESPONSE_SERVICEUNAVAILABLE

CODE_RESPONSE_MOVEDPERMANENTLY

CODE_RESPONSE_BADGATEWAY

CODE_RESPONSE_PROXYAUTHENTICATIONREQUIRED

CODE_RESPONSE_MISDIRECTEDREQUEST

CODE_RESPONSE_UNSUPPORTEDMEDIATYPE

CODE_RESPONSE_FOUND

CODE_RESPONSE_PAYMENTREQUIRED

CODE_RESPONSE_CONTINUE

CODE_RESPONSE_NONAUTHORITATIVEINFORMATION

CODE_RESPONSE_SEEOTHER

CODE_RESPONSE_UNPROCESSABLECONTENT

CODE_RESPONSE_PARTIALCONTENT

CODE_RESPONSE_REQUESTTIMEOUT

CODE_RESPONSE_PRECONDITIONFAILED

CODE_RESPONSE_OKAY

CODE_RESPONSE_RESETCONTENT

CODE_RESPONSE_CREATED

CODE_RESPONSE_FORBIDDEN

CODE_RESPONSE_METHODNOTALLOWED

CODE_RESPONSE_ACCEPTED

CODE_RESPONSE_SWITCHINGPROTOCOLS

CODE_RESPONSE_USEPROXY

CODE_RESPONSE_GONE

CODE_RESPONSE_NOTIMPLEMENTED

CODE_RESPONSE_NOTMODIFIED

CODE_RESPONSE_PERMANENTREDIRECT

CODE_RESPONSE_UNAUTHORIZED

CODE_RESPONSE_HTTPVERSIONNOTSUPPORTED

CODE_RESPONSE_MULTIPLECHOICES

CODE_RESPONSE_CONTENTTOOLARGE

CODE_RESPONSE_RANGENOTSATISFIABLE

CODE_RESPONSE_NOTFOUND

CODE_RESPONSE_INTERNALSERVERERROR

CODE_RESPONSE_NOTACCEPTABLE

CODE_RESPONSE_TEMPORARYREDIRECT

CODE_RESPONSE_UPGRADEREQUIRED

CODE_RESPONSE_LENGTHREQUIRED

CODE_RESPONSE_CONFLICT

CODE_RESPONSE_URITOOLONG

CODE_RESPONSE_GATEWAYTIMEOUT

health.fhir.r5.international500: ShareableTestScriptSetupActionOperationMethod

ShareableTestScriptSetupActionOperationMethod enum

Members

CODE_METHOD_PATCH

CODE_METHOD_HEAD

CODE_METHOD_POST

CODE_METHOD_GET

CODE_METHOD_OPTIONS

CODE_METHOD_DELETE

CODE_METHOD_PUT

health.fhir.r5.international500: ShareableTestScriptStatus

ShareableTestScriptStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: SlotStatus

SlotStatus enum

Members

CODE_STATUS_BUSY_UNAVAILABLE

CODE_STATUS_BUSY

CODE_STATUS_BUSY_TENTATIVE

CODE_STATUS_FREE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: SpecimenCombined

SpecimenCombined enum

Members

CODE_COMBINED_GROUPED

CODE_COMBINED_POOLED

health.fhir.r5.international500: SpecimenDefinitionStatus

SpecimenDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: SpecimenDefinitionTypeTestedPreference

SpecimenDefinitionTypeTestedPreference enum

Members

CODE_PREFERENCE_ALTERNATE

CODE_PREFERENCE_PREFERRED

health.fhir.r5.international500: SpecimenStatus

SpecimenStatus enum

Members

CODE_STATUS_UNAVAILABLE

CODE_STATUS_AVAILABLE

CODE_STATUS_UNSATISFACTORY

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: StructureDefinitionContextType

StructureDefinitionContextType enum

Members

CODE_TYPE_EXTENSION

CODE_TYPE_FHIRPATH

CODE_TYPE_ELEMENT

health.fhir.r5.international500: StructureDefinitionDerivation

StructureDefinitionDerivation enum

Members

CODE_DERIVATION_SPECIALIZATION

CODE_DERIVATION_CONSTRAINT

health.fhir.r5.international500: StructureDefinitionKind

StructureDefinitionKind enum

Members

CODE_KIND_PRIMITIVE_TYPE

CODE_KIND_RESOURCE

CODE_KIND_COMPLEX_TYPE

CODE_KIND_LOGICAL

health.fhir.r5.international500: StructureDefinitionStatus

StructureDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: StructureMapGroupInputMode

StructureMapGroupInputMode enum

Members

CODE_MODE_SOURCE

CODE_MODE_TARGET

health.fhir.r5.international500: StructureMapGroupRuleSourceListMode

StructureMapGroupRuleSourceListMode enum

Members

CODE_LISTMODE_ONLY_ONE

CODE_LISTMODE_LAST

CODE_LISTMODE_NOT_LAST

CODE_LISTMODE_NOT_FIRST

CODE_LISTMODE_FIRST

health.fhir.r5.international500: StructureMapGroupRuleTargetListMode

StructureMapGroupRuleTargetListMode enum

Members

CODE_LISTMODE_SINGLE

CODE_LISTMODE_LAST

CODE_LISTMODE_SHARE

CODE_LISTMODE_FIRST

health.fhir.r5.international500: StructureMapGroupRuleTargetTransform

StructureMapGroupRuleTargetTransform enum

Members

CODE_TRANSFORM_CREATE

CODE_TRANSFORM_COPY

health.fhir.r5.international500: StructureMapGroupTypeMode

StructureMapGroupTypeMode enum

Members

CODE_TYPEMODE_TYPES

CODE_TYPEMODE_TYPE_AND_TYPES

health.fhir.r5.international500: StructureMapStatus

StructureMapStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: StructureMapStructureMode

StructureMapStructureMode enum

Members

CODE_MODE_SOURCE

CODE_MODE_QUERIED

CODE_MODE_TARGET

CODE_MODE_PRODUCED

health.fhir.r5.international500: SubscriptionContent

SubscriptionContent enum

Members

CODE_CONTENT_FULL_RESOURCE

CODE_CONTENT_EMPTY

CODE_CONTENT_ID_ONLY

health.fhir.r5.international500: SubscriptionFilterByComparator

SubscriptionFilterByComparator enum

Members

CODE_COMPARATOR_NE

CODE_COMPARATOR_LT

CODE_COMPARATOR_LE

CODE_COMPARATOR_EQ

CODE_COMPARATOR_GT

CODE_COMPARATOR_EB

CODE_COMPARATOR_GE

CODE_COMPARATOR_SA

CODE_COMPARATOR_AP

health.fhir.r5.international500: SubscriptionFilterByModifier

SubscriptionFilterByModifier enum

Members

CODE_MODIFIER_IDENTIFIER

CODE_MODIFIER_OF_TYPE

CODE_MODIFIER_IN

CODE_MODIFIER_BELOW

CODE_MODIFIER_TYPE

CODE_MODIFIER_CONTAINS

CODE_MODIFIER_NOT

CODE_MODIFIER_MISSING

CODE_MODIFIER_EXACT

CODE_MODIFIER_ABOVE

CODE_MODIFIER_NOT_IN

CODE_MODIFIER_TEXT

CODE_MODIFIER_TEXT_ADVANCED

CODE_MODIFIER_CODE_TEXT

CODE_MODIFIER_ITERATE

health.fhir.r5.international500: SubscriptionStatusOne

SubscriptionStatusOne enum

Members

CODE_STATUS_REQUESTED

CODE_STATUS_ACTIVE

CODE_STATUS_ERROR

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_OFF

health.fhir.r5.international500: SubscriptionStatusStatus

SubscriptionStatusStatus enum

Members

CODE_STATUS_REQUESTED

CODE_STATUS_ACTIVE

CODE_STATUS_ERROR

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_OFF

health.fhir.r5.international500: SubscriptionStatusType

SubscriptionStatusType enum

Members

CODE_TYPE_QUERY_STATUS

CODE_TYPE_HANDSHAKE

CODE_TYPE_HEARTBEAT

CODE_TYPE_EVENT_NOTIFICATION

CODE_TYPE_QUERY_EVENT

health.fhir.r5.international500: SubscriptionTopicCanFilterByComparator

SubscriptionTopicCanFilterByComparator enum

Members

CODE_COMPARATOR_NE

CODE_COMPARATOR_LT

CODE_COMPARATOR_LE

CODE_COMPARATOR_EQ

CODE_COMPARATOR_GT

CODE_COMPARATOR_EB

CODE_COMPARATOR_GE

CODE_COMPARATOR_SA

CODE_COMPARATOR_AP

health.fhir.r5.international500: SubscriptionTopicCanFilterByModifier

SubscriptionTopicCanFilterByModifier enum

Members

CODE_MODIFIER_IDENTIFIER

CODE_MODIFIER_OF_TYPE

CODE_MODIFIER_IN

CODE_MODIFIER_BELOW

CODE_MODIFIER_TYPE

CODE_MODIFIER_CONTAINS

CODE_MODIFIER_NOT

CODE_MODIFIER_MISSING

CODE_MODIFIER_EXACT

CODE_MODIFIER_ABOVE

CODE_MODIFIER_NOT_IN

CODE_MODIFIER_TEXT

CODE_MODIFIER_TEXT_ADVANCED

CODE_MODIFIER_CODE_TEXT

CODE_MODIFIER_ITERATE

health.fhir.r5.international500: SubscriptionTopicResourceTriggerQueryCriteriaResultForCreate

SubscriptionTopicResourceTriggerQueryCriteriaResultForCreate enum

Members

CODE_RESULTFORCREATE_TEST_FAILS

CODE_RESULTFORCREATE_TEST_PASSES

health.fhir.r5.international500: SubscriptionTopicResourceTriggerQueryCriteriaResultForDelete

SubscriptionTopicResourceTriggerQueryCriteriaResultForDelete enum

Members

CODE_RESULTFORDELETE_TEST_FAILS

CODE_RESULTFORDELETE_TEST_PASSES

health.fhir.r5.international500: SubscriptionTopicResourceTriggerSupportedInteraction

SubscriptionTopicResourceTriggerSupportedInteraction enum

Members

CODE_SUPPORTEDINTERACTION_CREATE

CODE_SUPPORTEDINTERACTION_UPDATE

CODE_SUPPORTEDINTERACTION_DELETE

health.fhir.r5.international500: SubscriptionTopicStatus

SubscriptionTopicStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: SubstanceStatus

SubstanceStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r5.international500: SupplyDeliveryStatus

SupplyDeliveryStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ABANDONED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r5.international500: SupplyRequestPriority

SupplyRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: SupplyRequestStatus

SupplyRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_SUSPENDED

health.fhir.r5.international500: TaskIntent

TaskIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_UNKNOWN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: TaskPriority

TaskPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: TaskStatus

TaskStatus enum

Members

CODE_STATUS_REQUESTED

CODE_STATUS_DRAFT

CODE_STATUS_ACCEPTED

CODE_STATUS_RECEIVED

health.fhir.r5.international500: TerminologyCapabilitiesCodeSearch

TerminologyCapabilitiesCodeSearch enum

Members

CODE_CODESEARCH_IN_COMPOSE

CODE_CODESEARCH_IN_EXPANSION

CODE_CODESEARCH_IN_COMPOSE_OR_EXPANSION

health.fhir.r5.international500: TerminologyCapabilitiesCodeSystemContent

TerminologyCapabilitiesCodeSystemContent enum

Members

CODE_CONTENT_FRAGMENT

CODE_CONTENT_SUPPLEMENT

CODE_CONTENT_NOT_PRESENT

CODE_CONTENT_COMPLETE

CODE_CONTENT_EXAMPLE

health.fhir.r5.international500: TerminologyCapabilitiesKind

TerminologyCapabilitiesKind enum

Members

CODE_KIND_CAPABILITY

CODE_KIND_REQUIREMENTS

CODE_KIND_INSTANCE

health.fhir.r5.international500: TerminologyCapabilitiesStatus

TerminologyCapabilitiesStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: TestPlanStatus

TestPlanStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: TestReportParticipantType

TestReportParticipantType enum

Members

CODE_TYPE_SERVER

CODE_TYPE_CLIENT

CODE_TYPE_TEST_ENGINE

health.fhir.r5.international500: TestReportResult

TestReportResult enum

Members

CODE_RESULT_FAIL

CODE_RESULT_PASS

CODE_RESULT_PENDING

health.fhir.r5.international500: TestReportSetupActionAssertResult

TestReportSetupActionAssertResult enum

Members

CODE_RESULT_FAIL

CODE_RESULT_PASS

CODE_RESULT_WARNING

CODE_RESULT_SKIP

CODE_RESULT_ERROR

health.fhir.r5.international500: TestReportSetupActionOperationResult

TestReportSetupActionOperationResult enum

Members

CODE_RESULT_FAIL

CODE_RESULT_PASS

CODE_RESULT_WARNING

CODE_RESULT_SKIP

CODE_RESULT_ERROR

health.fhir.r5.international500: TestReportStatus

TestReportStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_WAITING

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r5.international500: TestScriptSetupActionAssertDefaultManualCompletion

TestScriptSetupActionAssertDefaultManualCompletion enum

Members

CODE_DEFAULTMANUALCOMPLETION_FAIL

CODE_DEFAULTMANUALCOMPLETION_STOP

CODE_DEFAULTMANUALCOMPLETION_PASS

CODE_DEFAULTMANUALCOMPLETION_SKIP

health.fhir.r5.international500: TestScriptSetupActionAssertDirection

TestScriptSetupActionAssertDirection enum

Members

CODE_DIRECTION_REQUEST

CODE_DIRECTION_RESPONSE

health.fhir.r5.international500: TestScriptSetupActionAssertOperator

TestScriptSetupActionAssertOperator enum

Members

CODE_OPERATOR_CONTAINS

CODE_OPERATOR_EVAL

CODE_OPERATOR_MANUALEVAL

CODE_OPERATOR_IN

CODE_OPERATOR_NOTCONTAINS

CODE_OPERATOR_EQUALS

CODE_OPERATOR_LESSTHAN

CODE_OPERATOR_NOTEQUALS

CODE_OPERATOR_NOTIN

CODE_OPERATOR_NOTEMPTY

CODE_OPERATOR_GREATERTHAN

CODE_OPERATOR_EMPTY

health.fhir.r5.international500: TestScriptSetupActionAssertRequestMethod

TestScriptSetupActionAssertRequestMethod enum

Members

CODE_REQUESTMETHOD_PATCH

CODE_REQUESTMETHOD_HEAD

CODE_REQUESTMETHOD_POST

CODE_REQUESTMETHOD_GET

CODE_REQUESTMETHOD_OPTIONS

CODE_REQUESTMETHOD_DELETE

CODE_REQUESTMETHOD_PUT

health.fhir.r5.international500: TestScriptSetupActionAssertResponse

TestScriptSetupActionAssertResponse enum

Members

CODE_RESPONSE_NOCONTENT

CODE_RESPONSE_BADREQUEST

CODE_RESPONSE_EXPECTATIONFAILED

CODE_RESPONSE_SERVICEUNAVAILABLE

CODE_RESPONSE_MOVEDPERMANENTLY

CODE_RESPONSE_BADGATEWAY

CODE_RESPONSE_PROXYAUTHENTICATIONREQUIRED

CODE_RESPONSE_MISDIRECTEDREQUEST

CODE_RESPONSE_UNSUPPORTEDMEDIATYPE

CODE_RESPONSE_FOUND

CODE_RESPONSE_PAYMENTREQUIRED

CODE_RESPONSE_CONTINUE

CODE_RESPONSE_NONAUTHORITATIVEINFORMATION

CODE_RESPONSE_SEEOTHER

CODE_RESPONSE_UNPROCESSABLECONTENT

CODE_RESPONSE_PARTIALCONTENT

CODE_RESPONSE_REQUESTTIMEOUT

CODE_RESPONSE_PRECONDITIONFAILED

CODE_RESPONSE_OKAY

CODE_RESPONSE_RESETCONTENT

CODE_RESPONSE_CREATED

CODE_RESPONSE_FORBIDDEN

CODE_RESPONSE_METHODNOTALLOWED

CODE_RESPONSE_ACCEPTED

CODE_RESPONSE_SWITCHINGPROTOCOLS

CODE_RESPONSE_USEPROXY

CODE_RESPONSE_GONE

CODE_RESPONSE_NOTIMPLEMENTED

CODE_RESPONSE_NOTMODIFIED

CODE_RESPONSE_PERMANENTREDIRECT

CODE_RESPONSE_UNAUTHORIZED

CODE_RESPONSE_HTTPVERSIONNOTSUPPORTED

CODE_RESPONSE_MULTIPLECHOICES

CODE_RESPONSE_CONTENTTOOLARGE

CODE_RESPONSE_RANGENOTSATISFIABLE

CODE_RESPONSE_NOTFOUND

CODE_RESPONSE_INTERNALSERVERERROR

CODE_RESPONSE_NOTACCEPTABLE

CODE_RESPONSE_TEMPORARYREDIRECT

CODE_RESPONSE_UPGRADEREQUIRED

CODE_RESPONSE_LENGTHREQUIRED

CODE_RESPONSE_CONFLICT

CODE_RESPONSE_URITOOLONG

CODE_RESPONSE_GATEWAYTIMEOUT

health.fhir.r5.international500: TestScriptSetupActionOperationMethod

TestScriptSetupActionOperationMethod enum

Members

CODE_METHOD_PATCH

CODE_METHOD_HEAD

CODE_METHOD_POST

CODE_METHOD_GET

CODE_METHOD_OPTIONS

CODE_METHOD_DELETE

CODE_METHOD_PUT

health.fhir.r5.international500: TestScriptStatus

TestScriptStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r5.international500: TransportIntent

TransportIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_UNKNOWN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r5.international500: TransportPriority

TransportPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r5.international500: TransportStatus

TransportStatus enum

Members

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_PLANNED

CODE_STATUS_ABANDONED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r5.international500: VerificationResultStatus

VerificationResultStatus enum

Members

CODE_STATUS_VALIDATED

CODE_STATUS_VAL_FAIL

CODE_STATUS_ATTESTED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_REQ_REVALID

CODE_STATUS_REVAL_FAIL

CODE_STATUS_IN_PROCESS

health.fhir.r5.international500: VisionPrescriptionLensSpecificationEye

VisionPrescriptionLensSpecificationEye enum

Members

CODE_EYE_LEFT

CODE_EYE_RIGHT

health.fhir.r5.international500: VisionPrescriptionLensSpecificationPrismBase

VisionPrescriptionLensSpecificationPrismBase enum

Members

CODE_BASE_IN

CODE_BASE_UP

CODE_BASE_DOWN

CODE_BASE_OUT

health.fhir.r5.international500: VisionPrescriptionStatus

VisionPrescriptionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

Variables

health.fhir.r5.international500: terminologyProcessor

TerminologyProcessor(default r5:terminologyProcessor)

Terminology processor instance

health.fhir.r5.international500: fhirRegistry

FHIRRegistry(default r5:fhirRegistry)

FHIR registry instance

health.fhir.r5.international500: FHIR_VALUE_SETS

json[](default [])

health.fhir.r5.international500: FHIR_CODE_SYSTEMS

json[](default [])

Records

health.fhir.r5.international500: Account

FHIR Account resource record.

Fields

resourceType RESOURCE_NAME_ACCOUNT(default RESOURCE_NAME_ACCOUNT) - The type of the resource describes

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, 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 - 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.

balance? AccountBalance[] - The calculated account balances - these are calculated and processed by the finance system. The balances with a term that is not current are usually generated/updated by an invoicing or similar process.

relatedAccount? AccountRelatedAccount[] - Other associated accounts related to this account.

currency? CodeableConcept - The default currency for the account.

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.

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).

diagnosis? AccountDiagnosis[] - When using an account for billing a specific Encounter the set of diagnoses that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).

procedure? AccountProcedure[] - When using an account for billing a specific Encounter the set of procedures that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).

billingStatus? CodeableConcept - The BillingStatus tracks the lifecycle of the account through the billing process. It indicates how transactions are treated when they are allocated to the account.

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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

calculatedAt? instant - Time the balance amount was calculated.

status AccountStatus - Indicates whether the account is presently used/usable or not.

Element... - Rest field

health.fhir.r5.international500: AccountBalance

Closed record

FHIR AccountBalance datatype record.

Fields

amount Money - The actual balance value calculated for the age defined in the term property.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

estimate? boolean - The amount is only an estimated value - this is likely common for current term balances, but not with known terms (that were generated by a backend process).

term? CodeableConcept - The term of the account balances - The balance value is the amount that was outstanding for this age.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

aggregate? CodeableConcept - Who is expected to pay this part of the balance.

health.fhir.r5.international500: AccountCoverage

Closed record

FHIR AccountCoverage datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AccountDiagnosis

Closed record

FHIR AccountDiagnosis datatype record.

Fields

sequence? positiveInt - Ranking of the diagnosis (for each type).

condition CodeableReference - The diagnosis relevant to the account.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

onAdmission? boolean - Was the Diagnosis present on Admission in the related Encounter.

packageCode? CodeableConcept[] - The package code can be used to group diagnoses that may be priced or delivered as a single product. Such as DRGs.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

dateOfDiagnosis? dateTime - Ranking of the diagnosis (for each type).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept[] - Type that this diagnosis has relevant to the account (e.g. admission, billing, discharge …).

health.fhir.r5.international500: AccountGuarantor

Closed record

FHIR AccountGuarantor datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AccountProcedure

Closed record

FHIR AccountProcedure datatype record.

Fields

sequence? positiveInt - Ranking of the procedure (for each type).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference - The procedure relevant to the account.

packageCode? CodeableConcept[] - The package code can be used to group procedures that may be priced or delivered as a single product. Such as DRGs.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

dateOfService? dateTime - Date of the procedure when using a coded procedure. If using a reference to a procedure, then the date on the procedure should be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept[] - How this procedure value should be used in charging the account.

device? Reference[] - Any devices that were associated with the procedure relevant to the account.

health.fhir.r5.international500: AccountRelatedAccount

Closed record

FHIR AccountRelatedAccount datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

relationship? CodeableConcept - Relationship of the associated Account.

account Reference - Reference to an associated Account.

health.fhir.r5.international500: ActivityDefinition

FHIR ActivityDefinition resource record.

Fields

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 last significantly changed. 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 managable, 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? markdown - 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? canonical[] - Defines the observations that are expected to be produced by the action.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

asNeededBoolean? boolean - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

timingAge? Age - The 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 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.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

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.

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 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 responsible for the release and ongoing maintenance of 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.

subjectCanonical? canonical - A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

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? canonical[] - 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.

asNeededCodeableConcept? CodeableConcept - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

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 timing or frequency upon which the described activity is to occur.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be 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, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

observationRequirement? canonical[] - 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 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

location? CodeableReference - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Element... - Rest field

health.fhir.r5.international500: ActivityDefinitionDynamicValue

Closed record

FHIR ActivityDefinitionDynamicValue datatype record.

Fields

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 resolvable 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ActivityDefinitionParticipant

Closed record

FHIR ActivityDefinitionParticipant datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

typeCanonical? canonical - The type of participant in the action.

'function? CodeableConcept - Indicates how the actor will be involved in the action - author, reviewer, witness, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

typeReference? Reference - The type of participant in the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? ActivityDefinitionParticipantType - The type of participant in the action.

health.fhir.r5.international500: ActorDefinition

FHIR ActorDefinition resource record.

Fields

resourceType RESOURCE_NAME_ACTORDEFINITION(default RESOURCE_NAME_ACTORDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the actor definition was last significantly changed. 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 actor definition changes.

copyright? markdown - A copyright statement relating to the actor definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the actor definition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose? markdown - Explanation of why this actor definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the actor definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 actor.

experimental? boolean - A Boolean value to indicate that this actor definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the actor definition.

'type ActorDefinitionType - Whether the actor represents a human or an appliction.

reference? urlType[] - A reference to additional documentation about the actor, but description and documentation.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

derivedFrom? canonical[] - A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IG.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this actor definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

capabilities? canonical - The capability statement for the actor (if the concept is applicable).

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

documentation? markdown - Documentation about the functionality of the actor.

'version? string - The identifier that is used to identify this version of the actor definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the actor definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url? uri - An absolute URI that is used to identify this actor 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 an authoritative instance of this actor definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the actor definition is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

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 actor 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 responsible for the release and ongoing maintenance of the actor definition.

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 actor definition instances.

status ActorDefinitionStatus - The status of this actor definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ActualGroup

FHIR ActualGroup resource record.

Fields

resourceType RESOURCE_NAME_ACTUALGROUP(default RESOURCE_NAME_ACTUALGROUP) - The type of the resource describes

identifier? Identifier[] - Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc.

quantity? unsignedInt - A count of the number of resource instances that are part of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active? boolean - Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

description? markdown - Explanation of what the group represents and how it is intended to be used.

language? code - The base language in which the resource is written.

membership ActualGroupMembership - Basis for membership in the Group: * 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. * 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.

'type ActualGroupType - Identifies the broad classification of the kind of resources the group includes.

characteristic? ActualGroupCharacteristic[] - Identifies traits whose presence r absence is shared by members of the group.

managingEntity? Reference - Entity responsible for defining and maintaining Group characteristics and/or registered members.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

member? ActualGroupMember[] - Identifies the resource instances that are members of the group.

name? string - A label assigned to the group for human identification and communication.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r5.international500: ActualGroupCharacteristic

Closed record

FHIR ActualGroupCharacteristic datatype record.

Fields

valueCodeableConcept CodeableConcept - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueBoolean boolean - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

code CodeableConcept - A code that identifies the kind of trait being asserted.

valueReference Reference - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueRange Range - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

exclude boolean - If true, indicates the characteristic is one that is NOT held by members of the group.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity Quantity - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

health.fhir.r5.international500: ActualGroupMember

Closed record

FHIR ActualGroupMember datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period that the member was in the group, if known.

inactive? boolean - A flag to indicate that the member is no longer in the group, but previously may have been a member.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

entity Reference - A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

health.fhir.r5.international500: AdministrableProductDefinition

FHIR AdministrableProductDefinition resource record.

Fields

resourceType RESOURCE_NAME_ADMINISTRABLEPRODUCTDEFINITION(default RESOURCE_NAME_ADMINISTRABLEPRODUCTDEFINITION) - The type of the resource describes

identifier? Identifier[] - An identifier for the administrable 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

administrableDoseForm? CodeableConcept - The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection').

ingredient? CodeableConcept[] - The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used.

formOf? Reference[] - References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product. If this administrable product describes the administration of a crushed tablet, the 'formOf' would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the 'producedFrom' which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

routeOfAdministration AdministrableProductDefinitionRouteOfAdministration[] - The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).

description? markdown - A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.

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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

unitOfPresentation? CodeableConcept - The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').

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.

property? AdministrableProductDefinitionProperty[] - Characteristics e.g. a product's onset of action.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

device? Reference - A device that is integral to the medicinal product, in effect being considered as an 'ingredient' of the medicinal product. This is not intended for devices that are just co-packaged.

producedFrom? Reference[] - Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form. In some cases, an administrable form might use all of the items from the overall product (or there might only be one item), while in other cases, an administrable form might use only a subset of the items available in the overall product. For example, an administrable form might involve combining a liquid and a powder available as part of an overall product, but not involve applying the also supplied cream.

status AdministrableProductDefinitionStatus - The status of this administrable product. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: AdministrableProductDefinitionProperty

Closed record

FHIR AdministrableProductDefinitionProperty datatype record.

Fields

valueCodeableConcept? CodeableConcept - A value for the characteristic.

valueBoolean? boolean - A value for the characteristic.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMarkdown? markdown - A value for the characteristic.

valueAttachment? Attachment - A value for the characteristic.

valueReference? Reference - A value for the characteristic.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

valueDate? date - A value for the characteristic.

'type CodeableConcept - A code expressing the type of characteristic.

status? CodeableConcept - The status of characteristic e.g. assigned or pending.

valueQuantity? Quantity - A value for the characteristic.

health.fhir.r5.international500: AdministrableProductDefinitionRouteOfAdministration

Closed record

FHIR AdministrableProductDefinitionRouteOfAdministration datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - Coded expression for the route.

maxSingleDose? Quantity - The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.

maxTreatmentPeriod? Duration - The maximum treatment period during which the product can be administered.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

targetSpecies? AdministrableProductDefinitionRouteOfAdministrationTargetSpecies[] - A species for which this route applies.

firstDose? Quantity - The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

maxDosePerDay? Quantity - The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.

maxDosePerTreatmentPeriod? Ratio - The maximum dose per treatment period that can be administered.

health.fhir.r5.international500: AdministrableProductDefinitionRouteOfAdministrationTargetSpecies

Closed record

FHIR AdministrableProductDefinitionRouteOfAdministrationTargetSpecies datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - Coded expression for the species.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

withdrawalPeriod? AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriod[] - A species specific time during which consumption of animal product is not appropriate.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriod

Closed record

FHIR AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriod datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

supportingInformation? string - Extra information about the withdrawal period.

tissue CodeableConcept - Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value Quantity - A value for the time.

health.fhir.r5.international500: AdverseEvent

FHIR AdverseEvent resource record.

Fields

resourceType RESOURCE_NAME_ADVERSEEVENT(default RESOURCE_NAME_ADVERSEEVENT) - The type of the resource describes

note? Annotation[] - Comments made about the adverse event by the performer, subject or other participants.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

preventiveAction? AdverseEventPreventiveAction[] - Preventive actions that contributed to avoiding the adverse event.

study? Reference[] - The research study that the subject is enrolled in.

code? CodeableConcept - Specific event that occurred or that was averted, such as patient fall, wrong organ removed, or wrong blood transfused.

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 managable, 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.

participant? AdverseEventParticipant[] - Indicates who or what participated in the adverse event and how they were involved.

expectedInResearchStudy? boolean - Considered likely or probable or anticipated in the research study. Whether the reported event matches any of the outcomes for the patient that are considered by the study as known or likely.

resultingEffect? Reference[] - Information about the condition that occurred as a result of the adverse event, such as hives due to the exposure to a substance (for example, a drug or a chemical) or a broken leg as a result of the fall.

supportingInfo? AdverseEventSupportingInfo[] - Supporting information relevant to the event.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome? CodeableConcept[] - Describes the type of outcome from the adverse event, such as resolved, recovering, ongoing, resolved-with-sequelae, or fatal.

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 was a near miss. Note that this is independent of whether anyone was affected or harmed or how severely.

mitigatingAction? AdverseEventMitigatingAction[] - The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.

recordedDate? dateTime - The date on which the existence of the AdverseEvent was first recorded.

encounter? Reference - The Encounter associated with the start of the AdverseEvent.

occurrenceTiming? Timing - The date (and perhaps time) when the adverse event occurred.

suspectEntity? AdverseEventSuspectEntity[] - Describes the entity that is suspected to have caused the adverse event.

contributingFactor? AdverseEventContributingFactor[] - The contributing factors suspected to have increased the probability or severity of 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

occurrencePeriod? Period - The date (and perhaps time) when the adverse event occurred.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

seriousness? CodeableConcept - Assessment whether this event, or averted event, was of clinical 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.

occurrenceDateTime? dateTime - The date (and perhaps time) when the adverse event occurred.

category? CodeableConcept[] - The overall type of event, intended for search and filtering purposes.

status AdverseEventStatus - The current state of the adverse event or potential adverse event.

Element... - Rest field

health.fhir.r5.international500: AdverseEventContributingFactor

Closed record

FHIR AdverseEventContributingFactor datatype record.

Fields

itemReference Reference - The item that is suspected to have increased the probability or severity of the adverse 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

itemCodeableConcept CodeableConcept - The item that is suspected to have increased the probability or severity of the adverse 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AdverseEventMitigatingAction

Closed record

FHIR AdverseEventMitigatingAction datatype record.

Fields

itemReference Reference - The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

itemCodeableConcept CodeableConcept - The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AdverseEventParticipant

Closed record

FHIR AdverseEventParticipant datatype record.

Fields

actor Reference - Indicates who or what participated in 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the actor in the adverse event, such as contributor or informant.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AdverseEventPreventiveAction

Closed record

FHIR AdverseEventPreventiveAction datatype record.

Fields

itemReference Reference - The action that contributed to avoiding the adverse 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

itemCodeableConcept CodeableConcept - The action that contributed to avoiding the adverse 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AdverseEventSupportingInfo

Closed record

FHIR AdverseEventSupportingInfo datatype record.

Fields

itemReference Reference - Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

itemCodeableConcept CodeableConcept - Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AdverseEventSuspectEntity

Closed record

FHIR AdverseEventSuspectEntity datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

instanceReference Reference - Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

causality? AdverseEventSuspectEntityCausality - Information on the possible cause of the event.

instanceCodeableConcept CodeableConcept - Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.

health.fhir.r5.international500: AdverseEventSuspectEntityCausality

Closed record

FHIR AdverseEventSuspectEntityCausality datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

assessmentMethod? CodeableConcept - The method of evaluating the relatedness of the suspected entity to the event.

author? Reference - The author of the information on the possible cause of the event.

entityRelatedness? CodeableConcept - The result of the assessment regarding the relatedness of the suspected entity to the 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AllergyIntolerance

FHIR AllergyIntolerance resource record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, 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? CodeableConcept - 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.

participant? AllergyIntoleranceParticipant[] - Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.

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.

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). The verification status pertains to the allergy or intolerance, itself, not to any specific AllergyIntolerance attribute.

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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.r5.international500: AllergyIntoleranceParticipant

Closed record

FHIR AllergyIntoleranceParticipant datatype record.

Fields

actor Reference - Indicates who or what participated in the activities related to the allergy or intolerance.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the actor in the activities related to the allergy or intolerance.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AllergyIntoleranceReaction

Closed record

FHIR AllergyIntoleranceReaction datatype record.

Fields

severity? AllergyIntoleranceReactionSeverity - Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

note? Annotation[] - Additional text about the adverse reaction event not captured in other fields.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference[] - 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Appointment

FHIR Appointment resource record.

Fields

resourceType RESOURCE_NAME_APPOINTMENT(default RESOURCE_NAME_APPOINTMENT) - The type of the resource describes

serviceType? CodeableReference[] - The specific service that is to be performed during this appointment.

note? Annotation[] - Additional notes/comments about the appointment.

reason? CodeableReference[] - The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or 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.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

virtualService? VirtualServiceDetail[] - Connection details of a virtual service (e.g. conference call).

subject? Reference - The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.

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 managable, 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 note field.

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.

recurrenceId? positiveInt - The sequence number that identifies a specific appointment in a recurring pattern.

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.

recurrenceTemplate? AppointmentRecurrenceTemplate[] - The details of the recurrence pattern or template that is used to generate recurring appointments.

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.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

'class? CodeableConcept[] - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

basedOn? Reference[] - The request this appointment is allocated to assess (e.g. incoming referral or procedure request).

cancellationDate? dateTime - The date/time describing when the appointment was cancelled.

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).

cancellationReason? 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.

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.

replaces? Reference[] - Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).

'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? CodeableConcept - 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).

previousAppointment? Reference - The previous appointment in a series of related appointments.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

occurrenceChanged? boolean - This appointment varies from the recurring pattern.

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.

account? Reference[] - The set of accounts that is expected to be used for billing the activities that result from this Appointment.

originatingAppointment? Reference - The originating appointment in a recurring set of related appointments.

patientInstruction? CodeableReference[] - While Appointment.note 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.r5.international500: AppointmentParticipant

Closed record

FHIR AppointmentParticipant datatype record.

Fields

actor? Reference - The individual, device, location, or service 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? boolean - Whether this participant is required to be present at the meeting. If false, the participant is optional.

status AppointmentParticipantStatus - Participation status of the actor.

health.fhir.r5.international500: AppointmentRecurrenceTemplate

Closed record

FHIR AppointmentRecurrenceTemplate datatype record.

Fields

occurrenceDate? date[] - The list of specific dates that will have appointments generated.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

timezone? CodeableConcept - The timezone of the recurring appointment occurrences.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

occurrenceCount? positiveInt - How many appointments are planned in the recurrence.

excludingDate? date[] - Any dates, such as holidays, that should be excluded from the recurrence.

recurrenceType CodeableConcept - How often the appointment series should recur.

yearlyTemplate? AppointmentRecurrenceTemplateYearlyTemplate - Information about yearly recurring appointments.

monthlyTemplate? AppointmentRecurrenceTemplateMonthlyTemplate - Information about monthly recurring appointments.

excludingRecurrenceId? positiveInt[] - Any dates, such as holidays, that should be excluded from the recurrence.

lastOccurrenceDate? date - Recurring appointments will not occur after this date.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

weeklyTemplate? AppointmentRecurrenceTemplateWeeklyTemplate - Information about weekly recurring appointments.

health.fhir.r5.international500: AppointmentRecurrenceTemplateMonthlyTemplate

Closed record

FHIR AppointmentRecurrenceTemplateMonthlyTemplate datatype record.

Fields

nthWeekOfMonth? Coding - Indicates which week within a month the appointments in the series of recurring appointments should occur on.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

dayOfWeek? Coding - Indicates which day of the week the recurring appointments should occur each nth week.

dayOfMonth? positiveInt - Indicates that appointments in the series of recurring appointments should occur on a specific day of the month.

monthInterval positiveInt - Indicates that recurring appointments should occur every nth month.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: AppointmentRecurrenceTemplateWeeklyTemplate

Closed record

FHIR AppointmentRecurrenceTemplateWeeklyTemplate datatype record.

Fields

sunday? boolean - Indicates that recurring appointments should occur on Sundays.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

saturday? boolean - Indicates that recurring appointments should occur on Saturdays.

tuesday? boolean - Indicates that recurring appointments should occur on Tuesdays.

weekInterval? positiveInt - The interval defines if the recurrence is every nth week. The default is every week, so it is expected that this value will be 2 or more. e.g. For recurring every second week this interval would be 2, or every third week the interval would be 3.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

friday? boolean - Indicates that recurring appointments should occur on Fridays.

thursday? boolean - Indicates that recurring appointments should occur on Thursdays.

wednesday? boolean - Indicates that recurring appointments should occur on Wednesdays.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

monday? boolean - Indicates that recurring appointments should occur on Mondays.

health.fhir.r5.international500: AppointmentRecurrenceTemplateYearlyTemplate

Closed record

FHIR AppointmentRecurrenceTemplateYearlyTemplate datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

yearInterval positiveInt - Appointment recurs every nth year.

health.fhir.r5.international500: AppointmentResponse

FHIR AppointmentResponse resource record.

Fields

resourceType RESOURCE_NAME_APPOINTMENTRESPONSE(default RESOURCE_NAME_APPOINTMENTRESPONSE) - The type of the resource describes

occurrenceDate? date - The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in Appointment.occurrenceDate).

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

recurring? boolean - Indicates that this AppointmentResponse applies to all occurrences in a recurring request.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

recurrenceId? positiveInt - The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.

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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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? markdown - 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.

proposedNewTime? boolean - Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.

Element... - Rest field

health.fhir.r5.international500: ArtifactAssessment

FHIR ArtifactAssessment resource record.

Fields

resourceType RESOURCE_NAME_ARTIFACTASSESSMENT(default RESOURCE_NAME_ARTIFACTASSESSMENT) - The type of the resource describes

date? dateTime - The date (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes.

citeAsReference? Reference - Display of or reference to the bibliographic citation of the comment, classifier, or rating.

identifier? Identifier[] - A formal identifier that is used to identify this artifact assessment when it is represented in other formats, or referenced in a specification, model, design or an instance.

copyright? markdown - A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

artifactReference Reference - A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.

artifactCanonical canonical - A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.

workflowStatus? ArtifactAssessmentWorkflowStatus - Indicates the workflow status of the comment or change request.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).

citeAsMarkdown? markdown - Display of or reference to the bibliographic citation of the comment, classifier, or rating.

language? code - The base language in which the resource is written.

title? string - A short title for the assessment for use in displaying and selecting.

content? ArtifactAssessmentContent[] - A component comment, classifier, or rating of the artifact.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

disposition? ArtifactAssessmentDisposition - Indicates the disposition of the responsible party to the comment or change request.

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

artifactUri uri - A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.

Element... - Rest field

health.fhir.r5.international500: ArtifactAssessmentContent

Closed record

FHIR ArtifactAssessmentContent datatype record.

Fields

summary? markdown - A brief summary of the content of this component.

path? uri[] - A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - A quantitative rating of the artifact.

relatedArtifact? RelatedArtifact[] - Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.

author? Reference - Indicates who or what authored the content.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

classifier? CodeableConcept[] - Represents a rating, classifier, or assessment of the artifact.

freeToShare? boolean - Acceptable to publicly share the comment, classifier or rating.

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 - Indicates what type of content this component represents.

informationType? ArtifactAssessmentContentInformationType - The type of information this component of the content represents.

health.fhir.r5.international500: AuditEvent

FHIR AuditEvent resource record.

Fields

resourceType RESOURCE_NAME_AUDITEVENT(default RESOURCE_NAME_AUDITEVENT) - The type of the resource describes

severity? AuditEventSeverity - Indicates and enables segmentation of various severity including debugging from critical.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - Describes what happened. The most specific code for 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

encounter? Reference - This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).

'source AuditEventSource - The actor that is reporting the event.

occurredPeriod? Period - The time or period during which the activity occurred.

recorded instant - The time when the event was recorded.

authorization? CodeableConcept[] - The authorization (e.g., PurposeOfUse) that was used during the event being recorded.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient? Reference - The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.

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.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - Classification of the type of event.

basedOn? Reference[] - Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.

entity? AuditEventEntity[] - Specific instances of data or objects that have been accessed.

occurredDateTime? dateTime - The time or period during which the activity occurred.

outcome? AuditEventOutcome - Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.

Element... - Rest field

health.fhir.r5.international500: AuditEventAgent

Closed record

FHIR AuditEventAgent datatype record.

Fields

networkUri? uri - When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'type? CodeableConcept - The Functional Role of the user when performing the event.

requestor? boolean - Indicator that the user is or is not the requestor, or initiator, for the event being audited.

authorization? CodeableConcept[] - The authorization (e.g., PurposeOfUse) that was used during the event being recorded.

networkString? string - When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.

location? Reference - Where the agent location is known, the agent location when 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.

networkReference? Reference - When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.

policy? uri[] - Where the policy(ies) are known that authorized the agent participation in the event. 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.r5.international500: AuditEventEntity

Closed record

FHIR AuditEventEntity datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - 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. This is allowed to be a Parameters resource.

securityLabel? CodeableConcept[] - 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

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.

health.fhir.r5.international500: AuditEventEntityDetail

Closed record

FHIR AuditEventEntityDetail datatype record.

Fields

valueAuditEventPeriod Period - The value of the extra detail.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

valueAuditEventInteger integer - 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'type CodeableConcept - The type of extra detail provided in the value.

valueAuditEventTime time - The value of the extra detail.

valueAuditEventCodeableConcept CodeableConcept - The value of the extra detail.

valueAuditEventRange Range - The value of the extra detail.

valueAuditEventDateTime dateTime - The value of the extra detail.

valueAuditEventBoolean boolean - The value of the extra detail.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueAuditEventRatio Ratio - The value of the extra detail.

valueAuditEventQuantity Quantity - The value of the extra detail.

health.fhir.r5.international500: AuditEventOutcome

Closed record

FHIR AuditEventOutcome datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code Coding - Indicates whether the event succeeded or failed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail? CodeableConcept[] - Additional details about the error. This may be a text description of the error or a system code that identifies the error.

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.r5.international500: AuditEventSource

Closed record

FHIR AuditEventSource datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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? Reference - 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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[] - Code specifying the type of source where event originated.

health.fhir.r5.international500: BackboneElement

Closed record

Fields

id? string -

extension? Extension[] -

modifierExtension? Extension[] -

health.fhir.r5.international500: Basic

FHIR Basic resource record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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? dateTime - 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 managable, 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.r5.international500: Binary

FHIR Binary resource record.

Fields

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. 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.r5.international500: BiologicallyDerivedProduct

FHIR BiologicallyDerivedProduct resource record.

Fields

resourceType RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT(default RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT) - The type of the resource describes

identifier? Identifier[] - Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier.

parent? Reference[] - Parent product (if any) for this biologically-derived product.

request? Reference[] - Request to obtain and/or infuse 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

biologicalSourceEvent? Identifier - An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

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 managable, 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).

storageTempRequirements? Range - The temperature requirements for storage of the biologically-derived product.

productStatus? Coding - Whether the product is currently available.

language? code - The base language in which the resource is written.

collection? BiologicallyDerivedProductCollection - How this product was collected.

processingFacility? Reference[] - Processing facilities responsible for the labeling and distribution of this biologically derived product.

productCategory? Coding - Broad category of this product.

division? string - A unique identifier for an aliquot of a product. Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

productCode? CodeableConcept - A codified value that systematically supports characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions.

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.

property? BiologicallyDerivedProductProperty[] - A property that is specific to this BiologicallyDerviedProduct instance.

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.

expirationDate? dateTime - Date, and where relevant time, of expiration.

Element... - Rest field

health.fhir.r5.international500: BiologicallyDerivedProductCollection

Closed record

FHIR BiologicallyDerivedProductCollection datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: BiologicallyDerivedProductDispense

FHIR BiologicallyDerivedProductDispense resource record.

Fields

resourceType RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCTDISPENSE(default RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCTDISPENSE) - The type of the resource describes

identifier? Identifier[] - Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier.

note? Annotation[] - Additional notes.

partOf? Reference[] - A larger event of which this particular event is a component.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

product Reference - A link to a resource identifying the biologically derived product that is being dispensed.

performer? BiologicallyDerivedProductDispensePerformer[] - Indicates who or what performed an action.

quantity? SimpleQuantity - The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration.

preparedDate? dateTime - When the product was selected/ matched.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

destination? Reference - Link to a resource identifying the physical location that the product was dispatched to.

whenHandedOver? dateTime - When the product was dispatched for clinical use.

language? code - The base language in which the resource is written.

originRelationshipType? CodeableConcept - Indicates the relationship between the donor of the biologically derived product and the intended recipient.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

matchStatus? CodeableConcept - Indicates the type of matching associated with the dispense.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient Reference - A link to a resource representing the patient that the product is dispensed for.

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.

usageInstruction? string - Specific instructions for use.

location? Reference - The physical location where the dispense was performed.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource.

status BiologicallyDerivedProductDispenseStatus - A code specifying the state of the dispense event.

Element... - Rest field

health.fhir.r5.international500: BiologicallyDerivedProductDispensePerformer

Closed record

FHIR BiologicallyDerivedProductDispensePerformer datatype record.

Fields

actor Reference - Identifies the person responsible for the action.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Identifies the function of the performer during the dispense.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: BiologicallyDerivedProductProperty

Closed record

FHIR BiologicallyDerivedProductProperty datatype record.

Fields

valueBoolean boolean - Property values.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueRange Range - Property values.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'type CodeableConcept - Code that specifies the property. It should reference an established coding system.

valueCodeableConcept CodeableConcept - Property values.

valueRatio Ratio - Property values.

valueAttachment Attachment - Property values.

valueString string - Property values.

valuePeriod Period - Property values.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer - Property values.

valueQuantity Quantity - Property values.

health.fhir.r5.international500: BodyStructure

FHIR BodyStructure resource record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

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 managable, 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? markdown - 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

includedStructure BodyStructureIncludedStructure[] - The anatomical location(s) or region(s) of the specimen, lesion, or body structure.

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.

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.r5.international500: BodyStructureIncludedStructure

Closed record

FHIR BodyStructureIncludedStructure datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

bodyLandmarkOrientation? BodyStructureIncludedStructureBodyLandmarkOrientation[] - Body locations in relation to a specific body landmark (tatoo, scar, other body structure).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

qualifier? CodeableConcept[] - Code that represents the included structure qualifier.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

spatialReference? Reference[] - XY or XYZ-coordinate orientation for structure.

laterality? CodeableConcept - Code that represents the included structure laterality.

structure CodeableConcept - Code that represents the included structure.

health.fhir.r5.international500: BodyStructureIncludedStructureBodyLandmarkOrientation

Closed record

FHIR BodyStructureIncludedStructureBodyLandmarkOrientation datatype record.

Fields

clockFacePosition? CodeableConcept[] - An description of the direction away from a landmark something is located based on a radial clock dial.

surfaceOrientation? CodeableConcept[] - The surface area a body location is in relation to a landmark.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

distanceFromLandmark? BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark[] - The distance in centimeters a certain observation is made from a body landmark.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

landmarkDescription? CodeableConcept[] - A description of a landmark on the body used as a reference to locate something else.

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.r5.international500: BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark

Closed record

FHIR BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

device? CodeableReference[] - An instrument, tool, analyzer, etc. used in the measurement.

value? Quantity[] - The measured distance (e.g., in cm) from a body landmark.

health.fhir.r5.international500: CanonicalResource

FHIR CanonicalResource resource record.

Fields

resourceType RESOURCE_NAME_CANONICALRESOURCE(default RESOURCE_NAME_CANONICALRESOURCE) - The type of the resource describes

date? dateTime - The date (and optionally time) when the {{title}} was last significantly changed. 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 {{title}} changes.

copyright? markdown - A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose? markdown - Explanation of why this {{title}} is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the {{title}} 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 managable, 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 {{title}} from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the {{title}}.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

'version? string - The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 without additional knowledge. (See the versionAlgorithm element.)

url? uri - An absolute URI that is used to identify this {{title}} 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 an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

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 {{title}}. This name should be usable as an identifier for the resource 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 responsible for the release and ongoing maintenance of the {{title}}.

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 {{title}}s.

status CanonicalResourceStatus - The current state of this {{title}}.

Element... - Rest field

health.fhir.r5.international500: CapabilityStatement

FHIR CapabilityStatement resource record.

Fields

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 last significantly changed. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, 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.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

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.

identifier? Identifier[] - A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instance.

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.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

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 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

acceptLanguage? code[] - A list of the languages supported by this implementation that are usefully supported in the Accept-Language header.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

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 responsible for the release and ongoing maintenance of 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.r5.international500: CapabilityStatementDocument

Closed record

FHIR CapabilityStatementDocument datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementImplementation

Closed record

FHIR CapabilityStatementImplementation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - 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.r5.international500: CapabilityStatementMessaging

Closed record

FHIR CapabilityStatementMessaging datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementMessagingEndpoint

Closed record

FHIR CapabilityStatementMessagingEndpoint datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementMessagingSupportedMessage

Closed record

FHIR CapabilityStatementMessagingSupportedMessage datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementRest

Closed record

FHIR CapabilityStatementRest datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementRestInteraction

Closed record

FHIR CapabilityStatementRestInteraction datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementRestResource

Closed record

FHIR CapabilityStatementRestResource datatype record.

Fields

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 system-wide profile that is applied across all instances of the resource supported by the system. For example, if declared on Observation, this profile is the 'superset' of capabilities for laboratory and vitals and other domains. See further discussion in Using Profiles.

referencePolicy? CapabilityStatementRestResourceReferencePolicy[] - A set of flags that defines how references are supported.

conditionalPatch? boolean - A flag that indicates that the server supports conditional patch.

'type code - A type of resource exposed via the restful interface.

supportedProfile? canonical[] - A list of profiles representing different use cases the system hosts/produces. A supported profile is a statement about the functionality of the data and services provided by the server (or the client) for supported use cases. For example, a system can define and declare multiple Observation profiles for laboratory observations, vital sign observations, etc. By declaring supported profiles, systems provide a way to determine whether individual resources are conformant. 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.r5.international500: CapabilityStatementRestResourceInteraction

Closed record

FHIR CapabilityStatementRestResourceInteraction datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementRestResourceOperation

Closed record

FHIR CapabilityStatementRestResourceOperation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 name is prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. This SHOULD be the same as the OperationDefinition.code of the defining OperationDefinition. However, it can sometimes differ if necessary to disambiguate when a server supports multiple OperationDefinition that happen to share the same code.

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.r5.international500: CapabilityStatementRestResourceSearchParam

Closed record

FHIR CapabilityStatementRestResourceSearchParam datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same code.

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.r5.international500: CapabilityStatementRestSecurity

Closed record

FHIR CapabilityStatementRestSecurity datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CapabilityStatementSoftware

Closed record

FHIR CapabilityStatementSoftware datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CarePlan

FHIR CarePlan resource record.

Fields

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? CodeableReference[] - 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, 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 managable, 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), organization or device 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 higher-level request resource (i.e. a plan, proposal or order) 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.

custodian? Reference - When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.

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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.r5.international500: CarePlanActivity

Closed record

FHIR CarePlanActivity datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

performedActivity? CodeableReference[] - Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an 'event' resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource).

progress? Annotation[] - Notes about the adherence/status/progress of the activity.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

plannedActivityReference? Reference - The details of the proposed activity represented in a specific resource.

health.fhir.r5.international500: CareTeam

FHIR CareTeam resource record.

Fields

resourceType RESOURCE_NAME_CARETEAM(default RESOURCE_NAME_CARETEAM) - The type of the resource describes

identifier? Identifier[] - Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

note? Annotation[] - Comments made about the CareTeam.

reason? CodeableReference[] - Describes why the care team exists.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - Indicates when the team did (or is intended to) come into effect and end.

subject? Reference - Identifies the patient or group whose intended care is handled by the team.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

participant? CareTeamParticipant[] - Identifies all people and organizations who are expected to be involved in the care team.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

managingOrganization? Reference[] - The organization responsible for the care team.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A label for human use intended to distinguish like teams. E.g. the 'red' vs. 'green' trauma teams.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom? ContactPoint[] - A central contact detail for the care team (that applies to all members).

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.

status? CareTeamStatus - Indicates the current state of the care team.

Element... - Rest field

health.fhir.r5.international500: CareTeamParticipant

Closed record

FHIR CareTeamParticipant datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

coveragePeriod? Period - When the member is generally available within this care team.

role? CodeableConcept - Indicates specific responsibility of an individual within the care team, such as 'Primary care physician', 'Trained social worker counselor', 'Caregiver', etc.

coverageTiming? Timing - When the member is generally available within this care team.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

member? Reference - The specific person or organization who is participating/expected to participate in the care team.

onBehalfOf? Reference - The organization of the practitioner.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: CDSHooksGuidanceResponse

FHIR CDSHooksGuidanceResponse resource record.

Fields

resourceType RESOURCE_NAME_CDSHOOKSGUIDANCERESPONSE(default RESOURCE_NAME_CDSHOOKSGUIDANCERESPONSE) - The type of the resource describes

identifier Identifier[] - Allows a service to provide unique, business identifiers for the response.

note? Annotation[] - Provides a mechanism to communicate additional information about the response.

reason? CodeableReference[] - Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

extension? Extension[] - An Extension

performer? Reference - Provides a reference to the device that performed the guidance.

subject? Reference - The patient for which the request was processed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

encounter? Reference - The encounter during which this response was created or to which the creation of this record is tightly associated.

result? Reference[] - The actions, if any, produced by the evaluation of the artifact.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

evaluationMessage? Reference - Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

dataRequirement? DataRequirement[] - If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime? dateTime - Indicates when the guidance response was processed.

requestIdentifier Identifier - The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

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.

moduleUri uri - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

outputParameters? Reference - The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

status CDSHooksGuidanceResponseStatus - The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

Element... - Rest field

health.fhir.r5.international500: CDSHooksRequestOrchestration

FHIR CDSHooksRequestOrchestration resource record.

Fields

resourceType RESOURCE_NAME_CDSHOOKSREQUESTORCHESTRATION(default RESOURCE_NAME_CDSHOOKSREQUESTORCHESTRATION) - The type of the resource describes

note? Annotation[] - Provides a mechanism to communicate additional information about the response.

reason? CodeableReference[] - Describes the reason for the request orchestration in coded or textual form.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code that identifies what the overall request orchestration is.

subject? Reference - The subject for which the request orchestration was created.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

instantiatesUri uri[] - A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

action? CDSHooksRequestOrchestrationAction[] - The actions, if any, produced by the evaluation of the artifact.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this request.

identifier Identifier[] - Allows a service to provide a unique, business identifier for the request.

authoredOn? dateTime - Indicates when the request orchestration was created.

goal? Reference[] - Goals that are intended to be achieved by following the requests in this RequestOrchestration.

author? Reference - Provides a reference to the author of the request orchestration.

replaces? Reference[] - Completed or terminated request(s) whose function is taken by this new request.

encounter? Reference - Describes the context of the request orchestration, if any.

instantiatesCanonical? canonical[] - A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

priority? CDSHooksRequestOrchestrationPriority - Indicates how quickly the request should be addressed with respect to other requests.

intent CDSHooksRequestOrchestrationIntent - Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

groupIdentifier? Identifier - A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

status CDSHooksRequestOrchestrationStatus - The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.

Element... - Rest field

health.fhir.r5.international500: CDSHooksRequestOrchestrationAction

Closed record

FHIR CDSHooksRequestOrchestrationAction datatype record.

Fields

cardinalityBehavior? CDSHooksRequestOrchestrationActionCardinalityBehavior - Defines whether the action can be selected multiple times.

definitionCanonical? canonical - A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept[] - A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.

prefix? string - A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 short description of the action used to provide a summary to display to the user.

definitionUri? uri - A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

title? string - The title of the action displayed to a user.

'type? CodeableConcept - The type of action to perform (create, update, remove).

groupingBehavior? CDSHooksRequestOrchestrationActionGroupingBehavior - Defines the grouping behavior for the action and its children.

participant? CDSHooksRequestOrchestrationActionParticipant[] - The participant that should perform or be responsible for this action.

output? CDSHooksRequestOrchestrationActionOutput[] - Defines the outputs of the action, if any.

transform? canonical - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

dynamicValue? CDSHooksRequestOrchestrationActionDynamicValue[] - Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

timingAge? Age - An optional value describing when the action should be performed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relatedAction? CDSHooksRequestOrchestrationActionRelatedAction[] - A relationship to another action such as 'before' or '30-60 minutes after start of'.

timingDuration? Duration - An optional value describing when the action should be performed.

textEquivalent? markdown - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

goal? Reference[] - Goals that are intended to be achieved by following the requests in this action.

timingTiming? Timing - An optional value describing when the action should be performed.

'resource? Reference - The resource that is the target of the action (e.g. CommunicationRequest).

timingPeriod? Period - An optional value describing when the action should be performed.

documentation? RelatedArtifact[] - Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

priority? CDSHooksRequestOrchestrationActionPriority - Indicates how quickly the action should be addressed with respect to other actions.

input? CDSHooksRequestOrchestrationActionInput[] - Defines input data requirements for the action.

requiredBehavior? CDSHooksRequestOrchestrationActionRequiredBehavior - Defines expectations around whether an action is required.

condition? CDSHooksRequestOrchestrationActionCondition[] - An expression that describes applicability criteria, or start/stop conditions for the action.

linkId? string - The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource.

selectionBehavior? CDSHooksRequestOrchestrationActionSelectionBehavior - Defines the selection behavior for the action and its children.

timingRange? Range - An optional value describing when the action should be performed.

precheckBehavior? CDSHooksRequestOrchestrationActionPrecheckBehavior - Defines whether the action should usually be preselected.

location? CodeableReference - Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

timingDateTime? dateTime - An optional value describing when the action should be performed.

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionCondition

Closed record

FHIR CDSHooksRequestOrchestrationActionCondition datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

expression? Expression - An expression that returns true or false, indicating whether or not the condition is satisfied.

kind CDSHooksRequestOrchestrationActionConditionKind - The kind of condition.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CDSHooksRequestOrchestrationActionDynamicValue

Closed record

FHIR CDSHooksRequestOrchestrationActionDynamicValue datatype record.

Fields

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 resolvable 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CDSHooksRequestOrchestrationActionInput

Closed record

FHIR CDSHooksRequestOrchestrationActionInput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedData? id - Points to an existing input or output element that provides data to this input.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? DataRequirement - Defines the data that is to be provided as input to the action.

title? string - A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionOutput

Closed record

FHIR CDSHooksRequestOrchestrationActionOutput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedData? string - Points to an existing input or output element that is results as output from the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? DataRequirement - Defines the data that results as output from the action.

title? string - A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionParticipant

Closed record

FHIR CDSHooksRequestOrchestrationActionParticipant datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

actorRequestOrchestrationReference? Reference - A reference to the actual participant.

typeCanonical? canonical - The type of participant in the action.

'function? CodeableConcept - Indicates how the actor will be involved in the action - author, reviewer, witness, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

typeReference? Reference - The type of participant in the action.

actorRequestOrchestrationCanonical? canonical - A reference to the actual participant.

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? CDSHooksRequestOrchestrationActionParticipantType - The type of participant in the action.

health.fhir.r5.international500: CDSHooksRequestOrchestrationActionRelatedAction

Closed record

FHIR CDSHooksRequestOrchestrationActionRelatedAction datatype record.

Fields

offsetRequestOrchestrationRange? Range - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

targetId id - The element id of the target related 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

endRelationship? CDSHooksRequestOrchestrationActionRelatedActionEndRelationship - The relationship of the end of this action to the related action.

offsetRequestOrchestrationDuration? Duration - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship CDSHooksRequestOrchestrationActionRelatedActionRelationship - The relationship of this action to the related action.

health.fhir.r5.international500: CDSHooksServicePlanDefinition

FHIR CDSHooksServicePlanDefinition resource record.

Fields

resourceType RESOURCE_NAME_CDSHOOKSSERVICEPLANDEFINITION(default RESOURCE_NAME_CDSHOOKSSERVICEPLANDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

copyright? markdown - A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

purpose? markdown - Explanation of why this plan definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the plan definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description of how the plan definition is used from a clinical perspective.

description? markdown - A free text natural language description of the plan definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the plan definition.

'type? CodeableConcept - A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

library? canonical[] - A reference to a Library resource containing any formal logic used by the plan definition.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

action? CDSHooksServicePlanDefinitionAction[] - An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

asNeededBoolean? boolean - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

asNeededCodeableConcept? CodeableConcept - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

goal? CDSHooksServicePlanDefinitionGoal[] - A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the plan definition content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

subjectReference? Reference - A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

'version? string - The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url? uri - An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

actor? CDSHooksServicePlanDefinitionActor[] - Actors represent the individuals or groups involved in the execution of the defined set of activities.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the plan definition giving additional information about its content.

name? string - A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.

topic? CodeableConcept[] - Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

subjectCanonical? canonical - A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

status CDSHooksServicePlanDefinitionStatus - The status of this plan definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: CDSHooksServicePlanDefinitionAction

Closed record

FHIR CDSHooksServicePlanDefinitionAction datatype record.

Fields

reason? CodeableConcept[] - A description of why this action is necessary or appropriate.

cardinalityBehavior? CDSHooksServicePlanDefinitionActionCardinalityBehavior - Defines whether the action can be selected multiple times.

definitionCanonical? canonical - A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

goalId? id[] - Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

subjectCodeableConcept? CodeableConcept - A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

prefix? string - A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 brief description of the action used to provide a summary to display to the user.

definitionUri? uri - A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

title? string - The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

'type? CodeableConcept - The type of action to perform (create, update, remove).

groupingBehavior? CDSHooksServicePlanDefinitionActionGroupingBehavior - Defines the grouping behavior for the action and its children.

participant? CDSHooksServicePlanDefinitionActionParticipant[] - Indicates who should participate in performing the action described.

output? CDSHooksServicePlanDefinitionActionOutput[] - Defines the outputs of the action, if any.

transform? canonical - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

dynamicValue? CDSHooksServicePlanDefinitionActionDynamicValue[] - Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

timingAge? Age - An optional value describing when the action should be performed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relatedAction? CDSHooksServicePlanDefinitionActionRelatedAction[] - A relationship to another action such as 'before' or '30-60 minutes after start of'.

timingDuration? Duration - An optional value describing when the action should be performed.

textEquivalent? markdown - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

timingTiming? Timing - An optional value describing when the action should be performed.

documentation? RelatedArtifact[] - Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

trigger? TriggerDefinition[] - A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

priority? CDSHooksServicePlanDefinitionActionPriority - Indicates how quickly the action should be addressed with respect to other actions.

subjectReference? Reference - A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

input? CDSHooksServicePlanDefinitionActionInput[] - Defines input data requirements for the action.

requiredBehavior? CDSHooksServicePlanDefinitionActionRequiredBehavior - Defines the required behavior for the action.

condition? CDSHooksServicePlanDefinitionActionCondition[] - An expression that describes applicability criteria or start/stop conditions for the action.

linkId? string - An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

selectionBehavior? CDSHooksServicePlanDefinitionActionSelectionBehavior - Defines the selection behavior for the action and its children.

timingRange? Range - An optional value describing when the action should be performed.

precheckBehavior? CDSHooksServicePlanDefinitionActionPrecheckBehavior - Defines whether the action should usually be preselected.

location? CodeableReference - Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

subjectCanonical? canonical - A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionCondition

Closed record

FHIR CDSHooksServicePlanDefinitionActionCondition datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

expression? Expression - An expression that returns true or false, indicating whether the condition is satisfied.

kind CDSHooksServicePlanDefinitionActionConditionKind - The kind of condition.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CDSHooksServicePlanDefinitionActionDynamicValue

Closed record

FHIR CDSHooksServicePlanDefinitionActionDynamicValue datatype record.

Fields

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 resolvable 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CDSHooksServicePlanDefinitionActionInput

Closed record

FHIR CDSHooksServicePlanDefinitionActionInput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedData? id - Points to an existing input or output element that provides data to this input.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? DataRequirement - Defines the data that is to be provided as input to the action.

title? string - A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionOutput

Closed record

FHIR CDSHooksServicePlanDefinitionActionOutput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedData? string - Points to an existing input or output element that is results as output from the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? DataRequirement - Defines the data that results as output from the action.

title? string - A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionParticipant

Closed record

FHIR CDSHooksServicePlanDefinitionActionParticipant datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

actorId? string - A reference to the id element of the actor who will participate in this action.

role? CodeableConcept - The role the participant should play in performing the described action.

typeCanonical? canonical - The type of participant in the action.

'function? CodeableConcept - Indicates how the actor will be involved in the action - author, reviewer, witness, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

typeReference? Reference - The type of participant in the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CDSHooksServicePlanDefinitionActionParticipantType - The type of participant in the action.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActionRelatedAction

Closed record

FHIR CDSHooksServicePlanDefinitionActionRelatedAction datatype record.

Fields

offsetPlanDefinitionRange? Range - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

offsetPlanDefinitionDuration? Duration - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

targetId id - The element id of the target related 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

endRelationship? CDSHooksServicePlanDefinitionActionRelatedActionEndRelationship - The relationship of the end of this action to the related action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship CDSHooksServicePlanDefinitionActionRelatedActionRelationship - The relationship of the start of this action to the related action.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActor

Closed record

FHIR CDSHooksServicePlanDefinitionActor datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 description of how the actor fits into the overall actions of the plan definition.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title? string - A descriptive label for the actor.

option CDSHooksServicePlanDefinitionActorOption[] - The characteristics of the candidates that could serve as the actor.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionActorOption

Closed record

FHIR CDSHooksServicePlanDefinitionActorOption datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

typeCanonical? canonical - The type of participant in the action.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

typeReference? Reference - The type of participant in the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CDSHooksServicePlanDefinitionActorOptionType - The type of participant in the action.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionGoal

Closed record

FHIR CDSHooksServicePlanDefinitionGoal datatype record.

Fields

addresses? CodeableConcept[] - Identifies problems, conditions, issues, or concerns the goal is intended to address.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

documentation? RelatedArtifact[] - Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'start? CodeableConcept - The event after which the goal should begin being pursued.

description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Indicates a category the goal falls within.

priority? CodeableConcept - Identifies the expected level of importance associated with reaching/sustaining the defined goal.

target? CDSHooksServicePlanDefinitionGoalTarget[] - Indicates what should be done and within what timeframe.

health.fhir.r5.international500: CDSHooksServicePlanDefinitionGoalTarget

Closed record

FHIR CDSHooksServicePlanDefinitionGoalTarget datatype record.

Fields

detailPlanDefinitionCodeableConcept? CodeableConcept - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

detailPlanDefinitionRatio? Ratio - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

detailPlanDefinitionString? string - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

measure? CodeableConcept - The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

due? Duration - Indicates the timeframe after the start of the goal in which the goal should be met.

detailPlanDefinitionQuantity? Quantity - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detailPlanDefinitionBoolean? boolean - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

detailPlanDefinitionInteger? integer - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

detailPlanDefinitionRange? Range - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

health.fhir.r5.international500: ChargeItem

FHIR ChargeItem resource record.

Fields

resourceType RESOURCE_NAME_CHARGEITEM(default RESOURCE_NAME_CHARGEITEM) - The type of the resource describes

note? Annotation[] - Comments made about the event by the performer, subject or other participants.

partOf? Reference[] - ChargeItems can be grouped to larger ChargeItems covering the whole set.

reason? CodeableConcept[] - Describes why the event occurred in coded or textual form.

definitionCanonical? canonical[] - References the source of pricing information, rules of application for the code this ChargeItem uses.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unitPriceComponent? MonetaryComponent - The unit price of the chargable item.

code CodeableConcept - A code that identifies the charge, like a billing code.

subject Reference - The individual or set of individuals the action is being or was performed on.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

overrideReason? CodeableConcept - If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.

language? code - The base language in which the resource is written.

definitionUri? uri[] - References the (external) source of pricing information, rules of application for the code this ChargeItem uses.

performingOrganization? Reference - The organization performing the service.

enterer? Reference - The device, practitioner, etc. who entered the charge item.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - Identifiers assigned to this event performer or other systems.

product? CodeableReference[] - Identifies the device, food, drug or other product being charged either by type code or reference to an instance.

bodysite? CodeableConcept[] - The anatomical location where the related service has been applied.

performer? ChargeItemPerformer[] - Indicates who or what performed or participated in the charged service.

quantity? Quantity - Quantity of which the charge item has been serviced.

costCenter? Reference - The financial cost center permits the tracking of charge attribution.

enteredDate? dateTime - Date the charge item was entered.

supportingInformation? Reference[] - Further information supporting this charge.

encounter? Reference - This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.

occurrenceTiming? Timing - Date/time(s) or duration when the charged service was applied.

totalPriceComponent? MonetaryComponent - The total price for the chargable item, accounting for the quantity.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

occurrencePeriod? Period - Date/time(s) or duration when the charged service was applied.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

'service? CodeableReference[] - Indicated the rendered service that caused this charge.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime? dateTime - Date/time(s) or duration when the charged service was applied.

requestingOrganization? Reference - The organization requesting the service.

account? Reference[] - Account into which this ChargeItems belongs.

status ChargeItemStatus - The current state of the ChargeItem.

Element... - Rest field

health.fhir.r5.international500: ChargeItemDefinition

FHIR ChargeItemDefinition resource record.

Fields

resourceType RESOURCE_NAME_CHARGEITEMDEFINITION(default RESOURCE_NAME_CHARGEITEMDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the charge item definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.

propertyGroup? ChargeItemDefinitionPropertyGroup[] - Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

partOf? canonical[] - A larger definition of which this particular definition is a component or step.

copyright? markdown - A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

code? CodeableConcept - The defined billing details in this resource pertain to the given billing code.

instance? Reference[] - The defined billing details in this resource pertain to the given product instance(s).

purpose? markdown - Explanation of why this charge item definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the charge item definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A free text natural language description of the charge item definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the charge item definition.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

derivedFromUri? uri[] - The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.

identifier? Identifier[] - A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

replaces? canonical[] - As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

'version? string - The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

url? uri - An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A natural language name identifying the ChargeItemDefinition. 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 responsible for the release and ongoing maintenance of the charge item definition.

applicability? ChargeItemDefinitionApplicability[] - Expressions that describe applicability criteria for the billing code.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.

status ChargeItemDefinitionStatus - The current state of the ChargeItemDefinition.

Element... - Rest field

health.fhir.r5.international500: ChargeItemDefinitionApplicability

Closed record

FHIR ChargeItemDefinitionApplicability datatype record.

Fields

condition? Expression - An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relatedArtifact? RelatedArtifact - Reference to / quotation of the external source of the group of properties.

effectivePeriod? Period - The period during which the charge item definition content was or is planned to be in active use.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ChargeItemDefinitionPropertyGroup

Closed record

FHIR ChargeItemDefinitionPropertyGroup datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

priceComponent? MonetaryComponent[] - The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.

health.fhir.r5.international500: ChargeItemPerformer

Closed record

FHIR ChargeItemPerformer datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed or participated in the service.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Citation

FHIR Citation resource record.

Fields

resourceType RESOURCE_NAME_CITATION(default RESOURCE_NAME_CITATION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the citation record was last significantly changed. 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 citation record changes.

statusDate? CitationStatusDate[] - The state or status of the citation record paired with an effective date or period for that state.

note? Annotation[] - Used for general notes and annotations not coded elsewhere.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

purpose? markdown - Explanation of why this citation is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the citation record 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 managable, 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 citation from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this citation record 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 citation record.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - Who endorsed the citation record.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

summary? CitationSummary[] - A human-readable display of key concepts to represent the citation.

editor? ContactDetail[] - Who edited or revised the citation record.

identifier? Identifier[] - A formal identifier that is used to identify this citation record when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact? RelatedArtifact[] - Artifact related to the citation record.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the citation record content was or is planned to be in active use.

citedArtifact? CitationCitedArtifact - The article or artifact being described.

author? ContactDetail[] - Who authored or created the citation record.

reviewer? ContactDetail[] - Who reviewed the citation record.

classification? CitationClassification[] - The assignment to an organizing scheme.

'version? string - The identifier that is used to identify this version of the citation record when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation record 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 citation record 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 an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A natural language name identifying the citation record. 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 citation record.

currentState? CodeableConcept[] - The status of the citation record.

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 citation record instances.

status CitationStatus - The status of this summary. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: CitationCitedArtifact

Closed record

FHIR CitationCitedArtifact datatype record.

Fields

statusDate? CitationCitedArtifactStatusDate[] - An effective date or period, historical or future, actual or expected, for a status of the cited artifact.

identifier? Identifier[] - A formal identifier that is used to identify the cited artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.

note? Annotation[] - Any additional information or content for the article or artifact.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relatedIdentifier? Identifier[] - A formal identifier that is used to identify things closely related to the cited artifact.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

part? CitationCitedArtifactPart - The component of the article or artifact.

'abstract? CitationCitedArtifactAbstract[] - The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.

contributorship? CitationCitedArtifactContributorship - This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.

classification? CitationCitedArtifactClassification[] - The assignment to an organizing scheme.

dateAccessed? dateTime - When the cited artifact was accessed.

title? CitationCitedArtifactTitle[] - The title details of the article or artifact.

webLocation? CitationCitedArtifactWebLocation[] - Used for any URL for the article or artifact cited.

'version? CitationCitedArtifactVersion - The defined version of the cited artifact.

publicationForm? CitationCitedArtifactPublicationForm[] - If multiple, used to represent alternative forms of the article that are not separate citations.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

currentState? CodeableConcept[] - The status of the cited artifact.

relatesTo? CitationCitedArtifactRelatesTo[] - The artifact related to the cited artifact.

health.fhir.r5.international500: CitationCitedArtifactAbstract

Closed record

FHIR CitationCitedArtifactAbstract datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? CodeableConcept - Used to express the specific language of the abstract.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text markdown - Abstract content.

'type? CodeableConcept - Used to express the reason for or classification of the abstract.

health.fhir.r5.international500: CitationCitedArtifactClassification

Closed record

FHIR CitationCitedArtifactClassification datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

classifier? CodeableConcept[] - The specific classification value.

artifactAssessment? Reference[] - Complex or externally created classification.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The kind of classifier (e.g. publication type, keyword).

health.fhir.r5.international500: CitationCitedArtifactContributorship

Closed record

FHIR CitationCitedArtifactContributorship datatype record.

Fields

summary? CitationCitedArtifactContributorshipSummary[] - Used to record a display of the author/contributor list without separate data element for each list member.

entry? CitationCitedArtifactContributorshipEntry[] - An individual entity named as a contributor, for example in the author list or contributor list.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

complete? boolean - Indicates if the list includes all authors and/or contributors.

health.fhir.r5.international500: CitationCitedArtifactContributorshipEntry

Closed record

FHIR CitationCitedArtifactContributorshipEntry datatype record.

Fields

contributionType? CodeableConcept[] - This element identifies the specific nature of an individual’s contribution with respect to the cited work.

contributionInstance? CitationCitedArtifactContributorshipEntryContributionInstance[] - Contributions with accounting for time or number.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contributor Reference - The identity of the individual contributor.

role? CodeableConcept - The role of the contributor (e.g. author, editor, reviewer, funder).

affiliation? Reference[] - Organization affiliated with the contributor.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

forenameInitials? string - For citation styles that use initials.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

correspondingContact? boolean - Whether the contributor is the corresponding contributor for the role.

rankingOrder? positiveInt - Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second author.

health.fhir.r5.international500: CitationCitedArtifactContributorshipEntryContributionInstance

Closed record

FHIR CitationCitedArtifactContributorshipEntryContributionInstance datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

time? dateTime - The time that the contribution was made.

'type CodeableConcept - The specific contribution.

health.fhir.r5.international500: CitationCitedArtifactContributorshipSummary

Closed record

FHIR CitationCitedArtifactContributorshipSummary datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

style? CodeableConcept - The format for the display string, such as author last name with first letter capitalized followed by forename initials.

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? CodeableConcept - Used to code the producer or rule for creating the display string.

'type? CodeableConcept - Used most commonly to express an author list or a contributorship statement.

value markdown - The display string for the author list, contributor list, or contributorship statement.

health.fhir.r5.international500: CitationCitedArtifactPart

Closed record

FHIR CitationCitedArtifactPart datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

baseCitation? Reference - The citation for the full article or artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The kind of component.

value? string - The specification of the component.

health.fhir.r5.international500: CitationCitedArtifactPublicationForm

Closed record

FHIR CitationCitedArtifactPublicationForm datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

pageCount? string - Actual or approximate number of pages or screens. Distinct from reporting the page numbers.

issue? string - Issue, part or supplement of journal or other collection in which the article is published.

lastPage? string - Used for isolated representation of last page.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

publicationDateSeason? string - Spring, Summer, Fall/Autumn, Winter.

language? CodeableConcept[] - The language or languages in which this form of the article is published.

accessionNumber? string - Entry number or identifier for inclusion in a database.

volume? string - Volume number of journal or other collection in which the article is published.

firstPage? string - Used for isolated representation of first page.

publicationDateText? string - Text representation of the date on which the issue of the cited artifact was published.

lastRevisionDate? dateTime - The date the article was last revised or updated in the database.

publishedIn? CitationCitedArtifactPublicationFormPublishedIn - The collection the cited article or artifact is published in.

pageString? string - Used for full display of pagination.

articleDate? dateTime - The date the article was added to the database, or the date the article was released.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

citedMedium? CodeableConcept - Describes the form of the medium cited. Common codes are 'Internet' or 'Print'. The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with '-without-issue' are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue.

health.fhir.r5.international500: CitationCitedArtifactPublicationFormPublishedIn

Closed record

FHIR CitationCitedArtifactPublicationFormPublishedIn datatype record.

Fields

identifier? Identifier[] - Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

publisher? Reference - Name of or resource describing the publisher.

publisherLocation? string - Geographic location of the publisher.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title? string - Name of the database or title of the book or journal.

'type? CodeableConcept - Kind of container (e.g. Periodical, database, or book).

health.fhir.r5.international500: CitationCitedArtifactRelatesTo

Closed record

FHIR CitationCitedArtifactRelatesTo datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

citation? markdown - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

'resource? canonical - The related artifact, such as a library, value set, profile, or other knowledge resource.

display? string - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document? Attachment - The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

classifier? CodeableConcept[] - Provides additional classifiers of the related artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

label? string - A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.

'type CitationCitedArtifactRelatesToType - The type of relationship to the related artifact.

resourceReference? Reference - The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

health.fhir.r5.international500: CitationCitedArtifactStatusDate

Closed record

FHIR CitationCitedArtifactStatusDate datatype record.

Fields

actual? boolean - Either occurred or expected.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - When the status started and/or ended.

activity CodeableConcept - A definition of the status associated with a date or period.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CitationCitedArtifactTitle

Closed record

FHIR CitationCitedArtifactTitle datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? CodeableConcept - Used to express the specific language of the title.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text markdown - The title of the article or artifact.

'type? CodeableConcept[] - Used to express the reason for or classification of the title.

health.fhir.r5.international500: CitationCitedArtifactVersion

Closed record

FHIR CitationCitedArtifactVersion datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

baseCitation? Reference - Citation for the main version of the cited artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - The version number or other version identifier.

health.fhir.r5.international500: CitationCitedArtifactWebLocation

Closed record

FHIR CitationCitedArtifactWebLocation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

classifier? CodeableConcept[] - A characterization of the object expected at the web location.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

url? uri - The specific URL.

health.fhir.r5.international500: CitationClassification

Closed record

FHIR CitationClassification datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

classifier? CodeableConcept[] - The specific classification value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The kind of classifier (e.g. publication type, keyword).

health.fhir.r5.international500: CitationStatusDate

Closed record

FHIR CitationStatusDate datatype record.

Fields

actual? boolean - Whether the status date is actual (has occurred) or expected (estimated or anticipated).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - When the status started and/or ended.

activity CodeableConcept - The state or status of the citation record (that will be paired with the period).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CitationSummary

Closed record

FHIR CitationSummary datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

style? CodeableConcept - Format for display of the citation summary.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text markdown - The human-readable display of the citation summary.

health.fhir.r5.international500: Claim

FHIR Claim resource record.

Fields

resourceType RESOURCE_NAME_CLAIM(default RESOURCE_NAME_CLAIM) - The type of the resource describes

insurance? ClaimInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

use ClaimUse - A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

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 managable, 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.

diagnosisRelatedGroup? CodeableConcept - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

'type CodeableConcept - The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

accident? ClaimAccident - Details of an accident which resulted in injuries which required the products and services listed in the claim.

payee? ClaimPayee - The party to be reimbursed for cost of the products and services according to the terms of the policy.

total? Money - The total value of the all the items in the claim.

supportingInfo? ClaimSupportingInfo[] - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

fundsReserve? CodeableConcept - A code to indicate whether and for whom funds are to be reserved for future claims.

provider? Reference - The provider which is responsible for the claim, predetermination or preauthorization.

insurer? Reference - The Insurer who is target of the request.

patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.

enterer? Reference - Individual who created the claim, predetermination or preauthorization.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

event? ClaimEvent[] - Information code for an event with a corresponding date or period.

careTeam? ClaimCareTeam[] - The members of the team who provided the products and services.

identifier? Identifier[] - A unique identifier assigned to this claim.

item? ClaimItem[] - A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

created dateTime - The date this resource was created.

diagnosis? ClaimDiagnosis[] - Information about diagnoses relevant to the claim items.

encounter? Reference[] - Healthcare encounters related to this claim.

originalPrescription? Reference - Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

procedure? ClaimProcedure[] - Procedures performed on the patient relevant to the billing items with the claim.

priority? CodeableConcept - The provider-required urgency of processing the request. Typical values include: stat, normal, deferred.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

referral? Reference - The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.

prescription? Reference - Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

billablePeriod? Period - The period for which charges are being submitted.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType? CodeableConcept - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

facility? Reference - Facility where the services were provided.

status ClaimStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: ClaimAccident

Closed record

FHIR ClaimAccident datatype record.

Fields

date date - Date of an accident event related to the products and services contained in the claim.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationAddress? Address - The physical location of the accident event.

locationReference? Reference - The physical location of the accident event.

'type? CodeableConcept - The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

health.fhir.r5.international500: ClaimCareTeam

Closed record

FHIR ClaimCareTeam datatype record.

Fields

sequence positiveInt - A number to uniquely identify care team entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 specialization of the practitioner or provider which is applicable for this service.

role? CodeableConcept - The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

provider Reference - Member of the team who provided the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

responsible? boolean - The party who is billing and/or responsible for the claimed products or services.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ClaimDiagnosis

Closed record

FHIR ClaimDiagnosis datatype record.

Fields

sequence positiveInt - A number to uniquely identify diagnosis entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

onAdmission? CodeableConcept - Indication of whether the diagnosis was present on admission to a facility.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept[] - When the condition was observed or the relative ranking.

diagnosisReference Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

diagnosisCodeableConcept CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

health.fhir.r5.international500: ClaimEvent

Closed record

FHIR ClaimEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

whenDateTime dateTime - A date or period in the past or future indicating when the event occurred or is expectd to occur.

whenPeriod Period - A date or period in the past or future indicating when the event occurred or is expectd to occur.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - A coded event such as when a service is expected or a card printed.

health.fhir.r5.international500: ClaimInsurance

Closed record

FHIR ClaimInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

identifier? Identifier - The business identifier to be used when the claim is sent for adjudication against this insurance policy.

sequence positiveInt - A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

businessArrangement? string - A business agreement number established between the provider and the insurer for special business processing purposes.

claimResponse? Reference - The result of the adjudication of the line items for the Coverage specified in this insurance.

focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

preAuthRef? string[] - Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ClaimItem

Closed record

FHIR ClaimItem datatype record.

Fields

request? Reference[] - Request or Referral for Goods or Service to be rendered.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

locationAddress? Address - Where the product or service was provided.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

servicedPeriod? Period - The date or dates when the service or product was supplied, performed or completed.

informationSequence? positiveInt[] - Exceptions, special conditions and supporting information applicable for this service or product.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

locationCodeableConcept? CodeableConcept - Where the product or service was provided.

diagnosisSequence? positiveInt[] - Diagnosis applicable for this service or product.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference? Reference - Where the product or service was provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

careTeamSequence? positiveInt[] - CareTeam members related to this service or product.

tax? Money - The total of taxes applicable for this product or service.

encounter? Reference[] - Healthcare encounters related to this claim.

sequence positiveInt - A number to uniquely identify item entries.

bodySite? ClaimItemBodySite[] - Physical location where the service is performed or applies.

detail? ClaimItemDetail[] - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

servicedDate? date - The date or dates when the service or product was supplied, performed or completed.

udi? Reference[] - Unique Device Identifiers associated with this line item.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

procedureSequence? positiveInt[] - Procedures applicable for this service or product.

health.fhir.r5.international500: ClaimItemBodySite

Closed record

FHIR ClaimItemBodySite datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference[] - Physical service site on the patient (limb, tooth, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subSite? CodeableConcept[] - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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.r5.international500: ClaimItemDetail

Closed record

FHIR ClaimItemDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subDetail? ClaimItemDetailSubDetail[] - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

sequence positiveInt - A number to uniquely identify item entries.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi? Reference[] - Unique Device Identifiers associated with this line item.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ClaimItemDetailSubDetail

Closed record

FHIR ClaimItemDetailSubDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

sequence positiveInt - A number to uniquely identify item entries.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi? Reference[] - Unique Device Identifiers associated with this line item.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for line item.detail.subDetail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ClaimPayee

Closed record

FHIR ClaimPayee datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of Party to be reimbursed: subscriber, provider, other.

party? Reference - Reference to the individual or organization to whom any payment will be made.

health.fhir.r5.international500: ClaimProcedure

Closed record

FHIR ClaimProcedure datatype record.

Fields

date? dateTime - Date and optionally time the procedure was performed.

sequence positiveInt - A number to uniquely identify procedure entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

procedureCodeableConcept CodeableConcept - The code or reference to a Procedure resource which identifies the clinical intervention performed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

procedureReference Reference - The code or reference to a Procedure resource which identifies the clinical intervention performed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi? Reference[] - Unique Device Identifiers associated with this line item.

'type? CodeableConcept[] - When the condition was observed or the relative ranking.

health.fhir.r5.international500: ClaimRelated

Closed record

FHIR ClaimRelated datatype record.

Fields

reference? Identifier - An alternate organizational reference to the case or file to which this particular claim pertains.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

claim? Reference - Reference to a related claim.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship? CodeableConcept - A code to convey how the claims are related.

health.fhir.r5.international500: ClaimResponse

FHIR ClaimResponse resource record.

Fields

resourceType RESOURCE_NAME_CLAIMRESPONSE(default RESOURCE_NAME_CLAIMRESPONSE) - The type of the resource describes

insurance? ClaimResponseInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.

request? Reference - Original request resource reference.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

use ClaimResponseUse - A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

payeeType? CodeableConcept - Type of Party to be reimbursed: subscriber, provider, other.

preAuthRef? string - Reference from the Insurer which is used in later communications which refers to this adjudication.

language? code - The base language in which the resource is written.

diagnosisRelatedGroup? CodeableConcept - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

'error? ClaimResponseError[] - Errors encountered during the processing of the adjudication.

'type CodeableConcept - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

processNote? ClaimResponseProcessNote[] - A note that describes or explains adjudication results in a human readable form.

addItem? ClaimResponseAddItem[] - The first-tier service adjudications for payor added product or service lines.

total? ClaimResponseTotal[] - Categorized monetary totals for the adjudication.

fundsReserve? CodeableConcept - A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

insurer? Reference - The party responsible for authorization, adjudication and reimbursement.

patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

communicationRequest? Reference[] - Request for additional supporting or authorizing information.

payment? ClaimResponsePayment - Payment details for the adjudication of the claim.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

event? ClaimResponseEvent[] - Information code for an event with a corresponding date or period.

outcome ClaimResponseOutcome - The outcome of the claim, predetermination, or preauthorization processing.

identifier? Identifier[] - A unique identifier assigned to this claim response.

item? ClaimResponseItem[] - A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

preAuthPeriod? Period - The time frame during which this authorization is effective.

decision? CodeableConcept - The result of the claim, predetermination, or preauthorization adjudication.

formCode? CodeableConcept - A code for the form to be used for printing the content.

created dateTime - The date this resource was created.

encounter? Reference[] - Healthcare encounters related to this claim.

requestor? Reference - The provider which is responsible for the claim, predetermination or preauthorization.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

disposition? string - A human readable description of the status of the adjudication.

form? Attachment - The actual form, by reference or inclusion, for printing the content or an EOB.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType? CodeableConcept - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

status ClaimResponseStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: ClaimResponseAddItem

Closed record

FHIR ClaimResponseAddItem datatype record.

Fields

request? Reference[] - Request or Referral for Goods or Service to be rendered.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subdetailSequence? positiveInt[] - The sequence number of the sub-details within the details within the claim item which this line is intended to replace.

locationAddress? Address - Where the product or service was provided.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

servicedPeriod? Period - The date or dates when the service or product was supplied, performed or completed.

itemSequence? positiveInt[] - Claim items which this service line is intended to replace.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

locationCodeableConcept? CodeableConcept - Where the product or service was provided.

provider? Reference[] - The providers who are authorized for the services rendered to the patient.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference? Reference - Where the product or service was provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

quantity? Quantity - The number of repetitions of a service or product.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

tax? Money - The total of taxes applicable for this product or service.

bodySite? ClaimResponseAddItemBodySite[] - Physical location where the service is performed or applies.

detailSequence? positiveInt[] - The sequence number of the details within the claim item which this line is intended to replace.

detail? ClaimResponseAddItemDetail[] - The second-tier service adjudications for payor added services.

servicedDate? date - The date or dates when the service or product was supplied, performed or completed.

health.fhir.r5.international500: ClaimResponseAddItemBodySite

Closed record

FHIR ClaimResponseAddItemBodySite datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference[] - Physical service site on the patient (limb, tooth, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subSite? CodeableConcept[] - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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.r5.international500: ClaimResponseAddItemDetail

Closed record

FHIR ClaimResponseAddItemDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subDetail? ClaimResponseAddItemDetailSubDetail[] - The third-tier service adjudications for payor added services.

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ClaimResponseAddItemDetailSubDetail

Closed record

FHIR ClaimResponseAddItemDetailSubDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ClaimResponseError

Closed record

FHIR ClaimResponseError datatype record.

Fields

subDetailSequence? positiveInt - The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

itemSequence? positiveInt - The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - An error code, from a specified code system, which details why the claim could not be adjudicated.

expression? string[] - A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

detailSequence? positiveInt - The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ClaimResponseEvent

Closed record

FHIR ClaimResponseEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

whenDateTime dateTime - A date or period in the past or future indicating when the event occurred or is expectd to occur.

whenPeriod Period - A date or period in the past or future indicating when the event occurred or is expectd to occur.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - A coded event such as when a service is expected or a card printed.

health.fhir.r5.international500: ClaimResponseInsurance

Closed record

FHIR ClaimResponseInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

sequence positiveInt - A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

businessArrangement? string - A business agreement number established between the provider and the insurer for special business processing purposes.

claimResponse? Reference - The result of the adjudication of the line items for the Coverage specified in this insurance.

focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ClaimResponseItem

Closed record

FHIR ClaimResponseItem datatype record.

Fields

adjudication? ClaimResponseItemAdjudication[] - If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

itemSequence positiveInt - A number to uniquely reference the claim item entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

reviewOutcome? ClaimResponseItemReviewOutcome - The high-level results of the adjudication if adjudication has been performed.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail? ClaimResponseItemDetail[] - A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r5.international500: ClaimResponseItemAdjudication

Closed record

FHIR ClaimResponseItemAdjudication datatype record.

Fields

reason? CodeableConcept - A code supporting the understanding of the adjudication result and explaining variance from expected amount.

amount? Money - Monetary amount associated with the category.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - A non-monetary value associated with the category. Mutually exclusive to the amount element above.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

health.fhir.r5.international500: ClaimResponseItemDetail

Closed record

FHIR ClaimResponseItemDetail datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

detailSequence positiveInt - A number to uniquely reference the claim detail entry.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subDetail? ClaimResponseItemDetailSubDetail[] - A sub-detail adjudication of a simple product or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r5.international500: ClaimResponseItemDetailSubDetail

Closed record

FHIR ClaimResponseItemDetailSubDetail datatype record.

Fields

subDetailSequence positiveInt - A number to uniquely reference the claim sub-detail entry.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r5.international500: ClaimResponseItemReviewOutcome

Closed record

FHIR ClaimResponseItemReviewOutcome datatype record.

Fields

reason? CodeableConcept[] - The reasons for the result of the claim, predetermination, or preauthorization adjudication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

preAuthPeriod? Period - The time frame during which this authorization is effective.

decision? CodeableConcept - The result of the claim, predetermination, or preauthorization adjudication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

preAuthRef? string - Reference from the Insurer which is used in later communications which refers to this adjudication.

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.r5.international500: ClaimResponsePayment

Closed record

FHIR ClaimResponsePayment datatype record.

Fields

date? date - Estimated date the payment will be issued or the actual issue date of payment.

identifier? Identifier - Issuer's unique identifier for the payment instrument.

adjustmentReason? CodeableConcept - Reason for the payment adjustment.

amount Money - Benefits payable less any payment adjustment.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

adjustment? Money - Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Whether this represents partial or complete payment of the benefits payable.

health.fhir.r5.international500: ClaimResponseProcessNote

Closed record

FHIR ClaimResponseProcessNote datatype record.

Fields

number? positiveInt - A number to uniquely identify a note entry.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? CodeableConcept - A code to define the language used in the text of the note.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string - The explanation or description associated with the processing.

'type? CodeableConcept - The business purpose of the note text.

health.fhir.r5.international500: ClaimResponseTotal

Closed record

FHIR ClaimResponseTotal datatype record.

Fields

amount Money - Monetary total amount associated with the category.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

health.fhir.r5.international500: ClaimSupportingInfo

Closed record

FHIR ClaimSupportingInfo datatype record.

Fields

valueBoolean? boolean - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

reason? CodeableConcept - Provides the reason in the situation where a reason code is required in addition to the content.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueIdentifier? Identifier - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

code? CodeableConcept - System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

valueReference? Reference - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

timingPeriod? Period - The date when or period to which this information refers.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

timingDate? date - The date when or period to which this information refers.

sequence positiveInt - A number to uniquely identify supporting information entries.

valueAttachment? Attachment - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

valueString? string - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - The general class of the information supplied: information; exception; accident, employment; onset, etc.

valueQuantity? Quantity - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

health.fhir.r5.international500: ClinicalDocument

FHIR ClinicalDocument resource record.

Fields

resourceType RESOURCE_NAME_CLINICALDOCUMENT(default RESOURCE_NAME_CLINICALDOCUMENT) - The type of the resource describes

date dateTime - The composition editing time, when the composition was last logically changed by the author.

note? Annotation[] - For any additional notes.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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[] - Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

section? ClinicalDocumentSection[] - The root of the sections that make up the composition.

title string - Official human-readable label for the composition.

'type CodeableConcept - Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

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? ClinicalDocumentEvent[] - The clinical service, such as a colonoscopy or an appendectomy, being documented.

relatesTo? RelatedArtifact[] - Relationships that this composition has with other compositions or documents that already exist.

identifier? Identifier[] - A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

custodian? Reference - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

author Reference[] - Identifies who is responsible for the information in the composition, not necessarily who typed it in.

encounter? Reference - Describes the clinical encounter or type of care this documentation is associated with.

'version? string - An explicitly assigned identifer of a variation of the content in the Composition.

attester? ClinicalDocumentAttester[] - A participant who has attested to the accuracy of the composition/document.

url? uri - An absolute URI that is used to identify this Composition 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 an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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 {{title}}. 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.

category? CodeableConcept[] - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

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 Composition instances.

status ClinicalDocumentStatus - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

Element... - Rest field

health.fhir.r5.international500: ClinicalDocumentAttester

Closed record

FHIR ClinicalDocumentAttester datatype record.

Fields

mode CodeableConcept - The type of attestation the authenticator offers.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

time? dateTime - When the composition was attested by the party.

party? Reference - Who attested the composition in the specified way.

health.fhir.r5.international500: ClinicalDocumentEvent

Closed record

FHIR ClinicalDocumentEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail? CodeableReference[] - Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a 'History and Physical Report' in which case the procedure being documented is necessarily a 'History and Physical' act. The events may be included as a code or as a reference to an other resource.

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.r5.international500: ClinicalDocumentSection

Closed record

FHIR ClinicalDocumentSection datatype record.

Fields

entry? Reference[] - A reference to the actual resource from which the narrative in the section is derived.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code identifying the kind of content contained within the section. This must be consistent with the section title.

emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.

author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? Narrative - A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative.

title? string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

health.fhir.r5.international500: ClinicalImpression

FHIR ClinicalImpression resource record.

Fields

resourceType RESOURCE_NAME_CLINICALIMPRESSION(default RESOURCE_NAME_CLINICALIMPRESSION) - The type of the resource describes

date? dateTime - Indicates when the documentation of the assessment was complete.

note? Annotation[] - Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject Reference - The patient or group of individuals assessed as part of this record.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? string - A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.

prognosisReference? Reference[] - RiskAssessment expressing likely outcome.

language? code - The base language in which the resource is written.

protocol? uri[] - Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.

problem? Reference[] - A list of the relevant problems/conditions for a patient.

statusReason? CodeableConcept - Captures the reason for the current state of the ClinicalImpression.

supportingInfo? Reference[] - Information supporting the clinical impression, which can contain investigation results.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

summary? string - A text summary of the investigations and the diagnosis.

identifier? Identifier[] - Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

performer? Reference - The clinician performing the assessment.

effectivePeriod? Period - The point in time or period over which the subject was assessed.

previous? Reference - A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.

encounter? Reference - The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.

finding? ClinicalImpressionFinding[] - Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

prognosisCodeableConcept? CodeableConcept[] - Estimate of likely outcome.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

effectiveDateTime? dateTime - The point in time or period over which the subject was assessed.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

changePattern? CodeableConcept - Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change. It is a subjective assessment of the direction of the change.

status ClinicalImpressionStatus - Identifies the workflow status of the assessment.

Element... - Rest field

health.fhir.r5.international500: ClinicalImpressionFinding

Closed record

FHIR ClinicalImpressionFinding datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item? CodeableReference - Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

basis? string - Which investigations support finding or diagnosis.

health.fhir.r5.international500: ClinicalUseDefinition

FHIR ClinicalUseDefinition resource record.

Fields

resourceType RESOURCE_NAME_CLINICALUSEDEFINITION(default RESOURCE_NAME_CLINICALUSEDEFINITION) - The type of the resource describes

identifier? Identifier[] - Business identifier for this issue.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject? Reference[] - The medication, product, substance, device, procedure etc. for which this is an indication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

'type ClinicalUseDefinitionType - indication | contraindication | interaction | undesirable-effect | warning.

population? Reference[] - The population group to which this applies.

undesirableEffect? ClinicalUseDefinitionUndesirableEffect - Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

library? canonical[] - Logic used by the clinical use definition.

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.

interaction? ClinicalUseDefinitionInteraction - Specifics for when this is an interaction.

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.

warning? ClinicalUseDefinitionWarning - A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

indication? ClinicalUseDefinitionIndication - Specifics for when this is an indication.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - A categorisation of the issue, primarily for dividing warnings into subject heading areas such as 'Pregnancy and Lactation', 'Overdose', 'Effects on Ability to Drive and Use Machines'.

contraindication? ClinicalUseDefinitionContraindication - Specifics for when this is a contraindication.

status? CodeableConcept - Whether this is a current issue or one that has been retired etc.

Element... - Rest field

health.fhir.r5.international500: ClinicalUseDefinitionContraindication

Closed record

FHIR ClinicalUseDefinitionContraindication datatype record.

Fields

diseaseStatus? CodeableReference - The status of the disease or symptom for the contraindication, for example 'chronic' or 'metastatic'.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

otherTherapy? ClinicalUseDefinitionContraindicationOtherTherapy[] - Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.

comorbidity? CodeableReference[] - A comorbidity (concurrent condition) or coinfection.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

diseaseSymptomProcedure? CodeableReference - The situation that is being documented as contraindicating against this item.

applicability? Expression - An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

indication? Reference[] - The indication which this is a contraidication for.

health.fhir.r5.international500: ClinicalUseDefinitionContraindicationOtherTherapy

Closed record

FHIR ClinicalUseDefinitionContraindicationOtherTherapy datatype record.

Fields

treatment CodeableReference - Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relationshipType CodeableConcept - The type of relationship between the medicinal product indication or contraindication and another therapy.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ClinicalUseDefinitionIndication

Closed record

FHIR ClinicalUseDefinitionIndication datatype record.

Fields

diseaseStatus? CodeableReference - The status of the disease or symptom for the indication, for example 'chronic' or 'metastatic'.

undesirableEffect? Reference[] - An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

comorbidity? CodeableReference[] - A comorbidity (concurrent condition) or coinfection as part of the indication.

intendedEffect? CodeableReference - The intended effect, aim or strategy to be achieved.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

diseaseSymptomProcedure? CodeableReference - The situation that is being documented as an indicaton for this item.

applicability? Expression - An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.

durationRange? Range - Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

durationString? string - Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).

health.fhir.r5.international500: ClinicalUseDefinitionInteraction

Closed record

FHIR ClinicalUseDefinitionInteraction datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

management? CodeableConcept[] - Actions for managing the interaction.

effect? CodeableReference - The effect of the interaction, for example 'reduced gastric absorption of primary medication'.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

interactant? ClinicalUseDefinitionInteractionInteractant[] - The specific medication, product, food, substance etc. or laboratory test that interacts.

'type? CodeableConcept - The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.

incidence? CodeableConcept - The incidence of the interaction, e.g. theoretical, observed.

health.fhir.r5.international500: ClinicalUseDefinitionInteractionInteractant

Closed record

FHIR ClinicalUseDefinitionInteractionInteractant datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

itemClinicalUseDefinitionReference Reference - The specific medication, product, food, substance etc. or laboratory test that interacts.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

itemClinicalUseDefinitionCodeableConcept CodeableConcept - The specific medication, product, food, substance etc. or laboratory test that interacts.

health.fhir.r5.international500: ClinicalUseDefinitionUndesirableEffect

Closed record

FHIR ClinicalUseDefinitionUndesirableEffect datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

symptomConditionEffect? CodeableReference - The situation in which the undesirable effect may manifest.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

classification? CodeableConcept - High level classification of the effect.

frequencyOfOccurrence? CodeableConcept - How often the effect is seen.

health.fhir.r5.international500: ClinicalUseDefinitionWarning

Closed record

FHIR ClinicalUseDefinitionWarning datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A coded or unformatted textual definition of this warning.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 textual definition of this warning, with formatting.

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.r5.international500: Communication

FHIR Communication resource record.

Fields

resourceType RESOURCE_NAME_COMMUNICATION(default RESOURCE_NAME_COMMUNICATION) - The type of the resource describes

note? Annotation[] - Additional notes or commentary about the communication by the sender, receiver or other interested parties.

partOf? Reference[] - A larger event (e.g. Communication, Procedure) of which this particular communication is a component or step.

reason? CodeableReference[] - The reason or justification for the communication.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject? Reference - The patient or group that was the focus of this communication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

about? Reference[] - Other resources that pertain to this communication and to which this communication should be associated.

language? code - The base language in which the resource is written.

medium? CodeableConcept[] - A channel that was used for this communication (e.g. email, fax).

instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

statusReason? CodeableConcept - Captures the reason for the current state of the Communication.

payload? CommunicationPayload[] - Text, attachment(s), or resource(s) that was communicated to the recipient.

inResponseTo? Reference[] - Prior communication that this communication is in response to.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - An order, proposal or plan fulfilled in whole or in part by this Communication.

identifier? Identifier[] - Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

received? dateTime - The time when this communication arrived at the destination.

encounter? Reference - The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

priority? CommunicationPriority - Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.

sent? dateTime - The time when this communication was sent.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

sender? Reference - The entity (e.g. person, organization, clinical information system, or device) which is the source of the communication.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

recipient? Reference[] - The entity (e.g. person, organization, clinical information system, care team or device) which is the target of the communication.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

topic? CodeableConcept - Description of the purpose/content, similar to a subject line in an email.

category? CodeableConcept[] - The type of message conveyed such as alert, notification, reminder, instruction, etc.

status CommunicationStatus - The status of the transmission.

Element... - Rest field

health.fhir.r5.international500: CommunicationPayload

Closed record

FHIR CommunicationPayload datatype record.

Fields

contentCodeableConcept CodeableConcept - A communicated content (or for multi-part communications, one portion of the communication).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contentReference Reference - A communicated content (or for multi-part communications, one portion of the communication).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

contentAttachment Attachment - A communicated content (or for multi-part communications, one portion of the communication).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: CommunicationRequest

FHIR CommunicationRequest resource record.

Fields

resourceType RESOURCE_NAME_COMMUNICATIONREQUEST(default RESOURCE_NAME_COMMUNICATIONREQUEST) - The type of the resource describes

note? Annotation[] - Comments made about the request by the requester, sender, recipient, subject or other participants.

reason? CodeableReference[] - Describes why the request is being made in coded or textual form.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject? Reference - The patient or group that is the focus of this communication request.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

about? Reference[] - Other resources that pertain to this communication request and to which this communication request should be associated.

language? code - The base language in which the resource is written.

medium? CodeableConcept[] - A channel that was used for this communication (e.g. email, fax).

statusReason? CodeableConcept - Captures the reason for the current state of the CommunicationRequest.

payload? CommunicationRequestPayload[] - Text, attachment(s), or resource(s) to be communicated to the recipient.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform? boolean - If true indicates that the CommunicationRequest is asking for the specified action to not occur.

basedOn? Reference[] - A plan or proposal that is fulfilled in whole or in part by this request.

requester? Reference - The device, individual, or organization who asks for the information to be shared.

identifier? Identifier[] - Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

authoredOn? dateTime - For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

replaces? Reference[] - Completed or terminated request(s) whose function is taken by this new request.

encounter? Reference - The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

priority? CommunicationRequestPriority - Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

intent CommunicationRequestIntent - Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

informationProvider? Reference[] - The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

occurrencePeriod? Period - The time when this communication is to occur.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

recipient? Reference[] - The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime? dateTime - The time when this communication is to occur.

category? CodeableConcept[] - The type of message to be sent such as alert, notification, reminder, instruction, etc.

groupIdentifier? Identifier - A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

status CommunicationRequestStatus - The status of the proposal or order.

Element... - Rest field

health.fhir.r5.international500: CommunicationRequestPayload

Closed record

FHIR CommunicationRequestPayload datatype record.

Fields

contentCodeableConcept CodeableConcept - The communicated content (or for multi-part communications, one portion of the communication).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contentReference Reference - The communicated content (or for multi-part communications, one portion of the communication).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

contentAttachment Attachment - The communicated content (or for multi-part communications, one portion of the communication).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: CompartmentDefinition

FHIR CompartmentDefinition resource record.

Fields

resourceType RESOURCE_NAME_COMPARTMENTDEFINITION(default RESOURCE_NAME_COMPARTMENTDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the compartment definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CompartmentDefinitionCode - Which compartment this definition describes.

purpose? markdown - Explanation of why this compartment definition is needed and why it has been designed as it has.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A free text natural language description of the compartment definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the capability statement.

search boolean - Whether the search syntax is supported,.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

'resource? CompartmentDefinitionResource[] - Information about how a resource is related to the compartment.

'version? string - The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri - An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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 compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the compartment definition.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.

status CompartmentDefinitionStatus - The status of this compartment definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: CompartmentDefinitionResource

Closed record

FHIR CompartmentDefinitionResource datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code - The name of a resource supported by the server.

startParam? uri - Search Parameter for mapping requests made with $everything.start (e.g. on Patient.$everything).

param? string[] - The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.

documentation? string - Additional documentation about the resource and compartment.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

endParam? uri - Search Parameter for mapping requests made with $everything.end (e.g. on Patient.$everything).

health.fhir.r5.international500: Composition

FHIR Composition resource record.

Fields

resourceType RESOURCE_NAME_COMPOSITION(default RESOURCE_NAME_COMPOSITION) - The type of the resource describes

date dateTime - The composition editing time, when the composition was last logically changed by the author.

note? Annotation[] - For any additional notes.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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[] - Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

section? CompositionSection[] - The root of the sections that make up the composition.

title string - Official human-readable label for the composition.

'type CodeableConcept - Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

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? CompositionEvent[] - The clinical service, such as a colonoscopy or an appendectomy, being documented.

relatesTo? RelatedArtifact[] - Relationships that this composition has with other compositions or documents that already exist.

identifier? Identifier[] - A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

custodian? Reference - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

author Reference[] - Identifies who is responsible for the information in the composition, not necessarily who typed it in.

encounter? Reference - Describes the clinical encounter or type of care this documentation is associated with.

'version? string - An explicitly assigned identifer of a variation of the content in the Composition.

attester? CompositionAttester[] - A participant who has attested to the accuracy of the composition/document.

url? uri - An absolute URI that is used to identify this Composition 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 an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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 {{title}}. 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.

category? CodeableConcept[] - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

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 Composition instances.

status CompositionStatus - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

Element... - Rest field

health.fhir.r5.international500: CompositionAttester

Closed record

FHIR CompositionAttester datatype record.

Fields

mode CodeableConcept - The type of attestation the authenticator offers.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

time? dateTime - When the composition was attested by the party.

party? Reference - Who attested the composition in the specified way.

health.fhir.r5.international500: CompositionEvent

Closed record

FHIR CompositionEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail? CodeableReference[] - Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a 'History and Physical Report' in which case the procedure being documented is necessarily a 'History and Physical' act. The events may be included as a code or as a reference to an other resource.

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.r5.international500: CompositionSection

Closed record

FHIR CompositionSection datatype record.

Fields

entry? Reference[] - A reference to the actual resource from which the narrative in the section is derived.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code identifying the kind of content contained within the section. This must be consistent with the section title.

emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.

author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? Narrative - A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative.

title? string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

health.fhir.r5.international500: ComputablePlanDefinition

FHIR ComputablePlanDefinition resource record.

Fields

resourceType RESOURCE_NAME_COMPUTABLEPLANDEFINITION(default RESOURCE_NAME_COMPUTABLEPLANDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

copyright? markdown - A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

purpose? markdown - Explanation of why this plan definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the plan definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description of how the plan definition is used from a clinical perspective.

description? markdown - A free text natural language description of the plan definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the plan definition.

'type? CodeableConcept - A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

library canonical[] - A reference to a Library resource containing any formal logic used by the plan definition.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

action? ComputablePlanDefinitionAction[] - An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

asNeededBoolean? boolean - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

asNeededCodeableConcept? CodeableConcept - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

goal? ComputablePlanDefinitionGoal[] - A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the plan definition content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

subjectReference? Reference - A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

'version? string - The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url? uri - An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

actor? ComputablePlanDefinitionActor[] - Actors represent the individuals or groups involved in the execution of the defined set of activities.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the plan definition giving additional information about its content.

name? string - A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.

topic? CodeableConcept[] - Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

subjectCanonical? canonical - A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

status ComputablePlanDefinitionStatus - The status of this plan definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ComputablePlanDefinitionAction

Closed record

FHIR ComputablePlanDefinitionAction datatype record.

Fields

reason? CodeableConcept[] - A description of why this action is necessary or appropriate.

cardinalityBehavior? ComputablePlanDefinitionActionCardinalityBehavior - Defines whether the action can be selected multiple times.

definitionCanonical? canonical - A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

goalId? id[] - Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

subjectCodeableConcept? CodeableConcept - A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

prefix? string - A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 brief description of the action used to provide a summary to display to the user.

definitionUri? uri - A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

title? string - The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

'type? CodeableConcept - The type of action to perform (create, update, remove).

groupingBehavior? ComputablePlanDefinitionActionGroupingBehavior - Defines the grouping behavior for the action and its children.

participant? ComputablePlanDefinitionActionParticipant[] - Indicates who should participate in performing the action described.

output? ComputablePlanDefinitionActionOutput[] - Defines the outputs of the action, if any.

transform? canonical - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

dynamicValue? ComputablePlanDefinitionActionDynamicValue[] - Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

timingAge? Age - An optional value describing when the action should be performed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relatedAction? ComputablePlanDefinitionActionRelatedAction[] - A relationship to another action such as 'before' or '30-60 minutes after start of'.

timingDuration? Duration - An optional value describing when the action should be performed.

textEquivalent? markdown - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

timingTiming? Timing - An optional value describing when the action should be performed.

documentation? RelatedArtifact[] - Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

trigger? TriggerDefinition[] - A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

priority? ComputablePlanDefinitionActionPriority - Indicates how quickly the action should be addressed with respect to other actions.

subjectReference? Reference - A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

input? ComputablePlanDefinitionActionInput[] - Defines input data requirements for the action.

requiredBehavior? ComputablePlanDefinitionActionRequiredBehavior - Defines the required behavior for the action.

condition? ComputablePlanDefinitionActionCondition[] - An expression that describes applicability criteria or start/stop conditions for the action.

linkId? string - An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

selectionBehavior? ComputablePlanDefinitionActionSelectionBehavior - Defines the selection behavior for the action and its children.

timingRange? Range - An optional value describing when the action should be performed.

precheckBehavior? ComputablePlanDefinitionActionPrecheckBehavior - Defines whether the action should usually be preselected.

location? CodeableReference - Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

subjectCanonical? canonical - A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

health.fhir.r5.international500: ComputablePlanDefinitionActionCondition

Closed record

FHIR ComputablePlanDefinitionActionCondition datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

expression? Expression - An expression that returns true or false, indicating whether the condition is satisfied.

kind ComputablePlanDefinitionActionConditionKind - The kind of condition.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ComputablePlanDefinitionActionDynamicValue

Closed record

FHIR ComputablePlanDefinitionActionDynamicValue datatype record.

Fields

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 resolvable 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ComputablePlanDefinitionActionInput

Closed record

FHIR ComputablePlanDefinitionActionInput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedData? id - Points to an existing input or output element that provides data to this input.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? DataRequirement - Defines the data that is to be provided as input to the action.

title? string - A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

health.fhir.r5.international500: ComputablePlanDefinitionActionOutput

Closed record

FHIR ComputablePlanDefinitionActionOutput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedData? string - Points to an existing input or output element that is results as output from the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? DataRequirement - Defines the data that results as output from the action.

title? string - A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

health.fhir.r5.international500: ComputablePlanDefinitionActionParticipant

Closed record

FHIR ComputablePlanDefinitionActionParticipant datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

actorId? string - A reference to the id element of the actor who will participate in this action.

role? CodeableConcept - The role the participant should play in performing the described action.

typeCanonical? canonical - The type of participant in the action.

'function? CodeableConcept - Indicates how the actor will be involved in the action - author, reviewer, witness, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

typeReference? Reference - The type of participant in the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? ComputablePlanDefinitionActionParticipantType - The type of participant in the action.

health.fhir.r5.international500: ComputablePlanDefinitionActionRelatedAction

Closed record

FHIR ComputablePlanDefinitionActionRelatedAction datatype record.

Fields

offsetPlanDefinitionRange? Range - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

offsetPlanDefinitionDuration? Duration - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

targetId id - The element id of the target related 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

endRelationship? ComputablePlanDefinitionActionRelatedActionEndRelationship - The relationship of the end of this action to the related action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship ComputablePlanDefinitionActionRelatedActionRelationship - The relationship of the start of this action to the related action.

health.fhir.r5.international500: ComputablePlanDefinitionActor

Closed record

FHIR ComputablePlanDefinitionActor datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 description of how the actor fits into the overall actions of the plan definition.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title? string - A descriptive label for the actor.

option ComputablePlanDefinitionActorOption[] - The characteristics of the candidates that could serve as the actor.

health.fhir.r5.international500: ComputablePlanDefinitionActorOption

Closed record

FHIR ComputablePlanDefinitionActorOption datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

typeCanonical? canonical - The type of participant in the action.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

typeReference? Reference - The type of participant in the action.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? ComputablePlanDefinitionActorOptionType - The type of participant in the action.

health.fhir.r5.international500: ComputablePlanDefinitionGoal

Closed record

FHIR ComputablePlanDefinitionGoal datatype record.

Fields

addresses? CodeableConcept[] - Identifies problems, conditions, issues, or concerns the goal is intended to address.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

documentation? RelatedArtifact[] - Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'start? CodeableConcept - The event after which the goal should begin being pursued.

description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Indicates a category the goal falls within.

priority? CodeableConcept - Identifies the expected level of importance associated with reaching/sustaining the defined goal.

target? ComputablePlanDefinitionGoalTarget[] - Indicates what should be done and within what timeframe.

health.fhir.r5.international500: ComputablePlanDefinitionGoalTarget

Closed record

FHIR ComputablePlanDefinitionGoalTarget datatype record.

Fields

detailPlanDefinitionCodeableConcept? CodeableConcept - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

detailPlanDefinitionRatio? Ratio - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

detailPlanDefinitionString? string - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

measure? CodeableConcept - The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

due? Duration - Indicates the timeframe after the start of the goal in which the goal should be met.

detailPlanDefinitionQuantity? Quantity - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detailPlanDefinitionBoolean? boolean - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

detailPlanDefinitionInteger? integer - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

detailPlanDefinitionRange? Range - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

health.fhir.r5.international500: ConceptMap

FHIR ConceptMap resource record.

Fields

resourceType RESOURCE_NAME_CONCEPTMAP(default RESOURCE_NAME_CONCEPTMAP) - The type of the resource describes

date? dateTime - The date (and optionally time) when the concept map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.

copyright? markdown - A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

purpose? markdown - Explanation of why this concept map is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the concept map is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A free text natural language description of the concept map from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the concept map.

targetScopeCanonical? canonical - Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.

additionalAttribute? ConceptMapAdditionalAttribute[] - An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which ConceptMap is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting.

property? ConceptMapProperty[] - A property defines a slot through which additional information can be provided about a map from source -> target.

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.

sourceScopeUri? uri - Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.

group? ConceptMapGroup[] - A group of mappings that all have the same source and target system.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the ConceptMap.

identifier? Identifier[] - A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which ConceptMap is more current.

effectivePeriod? Period - The period during which the ConceptMap 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 ConceptMap.

targetScopeUri? uri - Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.

sourceScopeCanonical? canonical - Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap.

'version? string - The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url? uri - An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the concept map.

topic? CodeableConcept[] - Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap 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 concept map instances.

status ConceptMapStatus - The status of this concept map. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ConceptMapAdditionalAttribute

Closed record

FHIR ConceptMapAdditionalAttribute datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code - A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.

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 ConceptMapAdditionalAttributeType - The type of the source data contained in this concept map for this data element.

uri? uri - Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.

health.fhir.r5.international500: ConceptMapGroup

Closed record

FHIR ConceptMapGroup datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? canonical - An absolute URI that identifies the source system where the concepts to be mapped are defined.

unmapped? ConceptMapGroupUnmapped - What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the 'default' to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.

element ConceptMapGroupElement[] - Mappings for an individual concept in the source to one or more concepts in the target.

target? canonical - An absolute URI that identifies the target system that the concepts will be mapped to.

health.fhir.r5.international500: ConceptMapGroupElement

Closed record

FHIR ConceptMapGroupElement datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? code - Identity (code or path) or the element/item being mapped.

valueSet? canonical - The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule.

display? string - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

noMap? boolean - If noMap = true this indicates that no mapping to a target concept exists for this source concept.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target? ConceptMapGroupElementTarget[] - A concept from the target value set that this concept maps to.

health.fhir.r5.international500: ConceptMapGroupElementTarget

Closed record

FHIR ConceptMapGroupElementTarget datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? code - Identity (code or path) or the element/item that the map refers to.

valueSet? canonical - The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set.

dependsOn? ConceptMapGroupElementTargetDependsOn[] - A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.

display? string - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

property? ConceptMapGroupElementTargetProperty[] - A property value for this source -> target mapping.

comment? string - A description of status/issues in mapping that conveys additional information not represented in the structured data.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship ConceptMapGroupElementTargetRelationship - The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).

health.fhir.r5.international500: ConceptMapGroupElementTargetDependsOn

Closed record

FHIR ConceptMapGroupElementTargetDependsOn datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueConceptMapString? string - Data element value that the map depends on / produces.

valueSet? canonical - This mapping applies if the data element value is a code from this value set.

valueConceptMapCoding? Coding - Data element value that the map depends on / produces.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueConceptMapBoolean? boolean - Data element value that the map depends on / produces.

attribute code - A reference to the additional attribute that holds a value the map depends on.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueConceptMapCode? code - Data element value that the map depends on / produces.

valueConceptMapQuantity? Quantity - Data element value that the map depends on / produces.

health.fhir.r5.international500: ConceptMapGroupElementTargetProperty

Closed record

FHIR ConceptMapGroupElementTargetProperty datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueConceptMapDateTime dateTime - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

code code - A reference to a mapping property defined in ConceptMap.property.

valueConceptMapString string - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

valueConceptMapCoding Coding - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

valueConceptMapInteger integer - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueConceptMapBoolean boolean - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

valueConceptMapDecimal decimal - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueConceptMapCode code - The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

health.fhir.r5.international500: ConceptMapGroupUnmapped

Closed record

FHIR ConceptMapGroupUnmapped datatype record.

Fields

mode ConceptMapGroupUnmappedMode - Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? code - The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.

valueSet? canonical - The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.

display? string - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

relationship? ConceptMapGroupUnmappedRelationship - The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'.

otherMap? canonical - The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.

health.fhir.r5.international500: ConceptMapProperty

Closed record

FHIR ConceptMapProperty datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code - A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.

system? canonical - The CodeSystem that defines the codes from which values of type code in property values.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 property - why it is defined, and how its value might be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type ConceptMapPropertyType - The type of the property value.

uri? uri - Reference to the formal meaning of the property.

health.fhir.r5.international500: Condition

FHIR Condition resource record.

Fields

resourceType RESOURCE_NAME_CONDITION(default RESOURCE_NAME_CONDITION) - The type of the resource describes

note? Annotation[] - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Identification of the condition, problem or diagnosis.

evidence? CodeableReference[] - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

onsetRange? Range - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementDateTime? dateTime - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Some conditions, such as chronic conditions, are never really resolved, but they can abate.

subject Reference - Indicates the patient or group who the condition record is associated with.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

clinicalStatus CodeableConcept - The clinical status of the condition.

onsetDateTime? dateTime - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetString? string - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetAge? Age - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

participant? ConditionParticipant[] - Indicates who or what participated in the activities related to the condition and how they were involved.

abatementPeriod? Period - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Some conditions, such as chronic conditions, are never really resolved, but they can abate.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

abatementString? string - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Some conditions, such as chronic conditions, are never really resolved, but they can abate.

severity? CodeableConcept - A subjective assessment of the severity of the condition as evaluated by the clinician.

identifier? Identifier[] - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

onsetPeriod? Period - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

verificationStatus? CodeableConcept - The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.

recordedDate? dateTime - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

abatementRange? Range - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Some conditions, such as chronic conditions, are never really resolved, but they can abate.

encounter? Reference - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

bodySite? CodeableConcept[] - The anatomical location where this condition manifests itself.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

stage? ConditionStage[] - A simple summary of the stage such as 'Stage 3' or 'Early Onset'. The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - A category assigned to the condition.

abatementAge? Age - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Some conditions, such as chronic conditions, are never really resolved, but they can abate.

Element... - Rest field

health.fhir.r5.international500: ConditionDefinition

FHIR ConditionDefinition resource record.

Fields

resourceType RESOURCE_NAME_CONDITIONDEFINITION(default RESOURCE_NAME_CONDITIONDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the condition definition was last significantly changed. 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 condition definition changes.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

questionnaire? ConditionDefinitionQuestionnaire[] - Questionnaire for this condition.

code CodeableConcept - Identification of the condition, problem or diagnosis.

hasSeverity? boolean - Whether Severity is appropriate to collect for this condition.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the condition definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 condition definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the condition definition.

hasBodySite? boolean - Whether bodySite is appropriate to collect for this condition.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

definition? uri[] - Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers.

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.

plan? ConditionDefinitionPlan[] - Plan that is appropriate.

severity? CodeableConcept - A subjective assessment of the severity of the condition as evaluated by the clinician.

identifier? Identifier[] - A formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

observation? ConditionDefinitionObservation[] - Observations particularly relevant to this condition.

medication? ConditionDefinitionMedication[] - Medications particularly relevant for this condition.

precondition? ConditionDefinitionPrecondition[] - An observation that suggests that this condition applies.

team? Reference[] - Appropriate team for this condition.

'version? string - The identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url? uri - An absolute URI that is used to identify this condition 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 an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different servers.

bodySite? CodeableConcept - The anatomical location where this condition manifests itself.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

stage? CodeableConcept - Clinical stage or grade of a condition. May include formal severity assessments.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the event definition giving additional information about its content.

name? string - A natural language name identifying the condition 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 responsible for the release and ongoing maintenance of the condition definition.

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 condition definition instances.

hasStage? boolean - Whether stage is appropriate to collect for this condition.

status ConditionDefinitionStatus - The status of this condition definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ConditionDefinitionMedication

Closed record

FHIR ConditionDefinitionMedication datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 relevant Medication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Category that is relevant.

health.fhir.r5.international500: ConditionDefinitionObservation

Closed record

FHIR ConditionDefinitionObservation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 relevant Observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Category that is relevant.

health.fhir.r5.international500: ConditionDefinitionPlan

Closed record

FHIR ConditionDefinitionPlan datatype record.

Fields

reference Reference - The actual plan.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Use for the plan.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ConditionDefinitionPrecondition

Closed record

FHIR ConditionDefinitionPrecondition datatype record.

Fields

valueCodeableConcept? CodeableConcept - Value of Observation.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 relevant Observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ConditionDefinitionPreconditionType - Kind of pre-condition.

valueQuantity? Quantity - Value of Observation.

health.fhir.r5.international500: ConditionDefinitionQuestionnaire

Closed record

FHIR ConditionDefinitionQuestionnaire datatype record.

Fields

reference Reference - Specific Questionnaire.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose ConditionDefinitionQuestionnairePurpose - Use of the questionnaire.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ConditionParticipant

Closed record

FHIR ConditionParticipant datatype record.

Fields

actor Reference - Indicates who or what participated in the activities related to the condition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the actor in the activities related to the condition.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ConditionStage

Closed record

FHIR ConditionStage datatype record.

Fields

summary? CodeableConcept - A simple summary of the stage such as 'Stage 3' or 'Early Onset'. The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.

assessment? Reference[] - Reference to a formal record of the evidence on which the staging assessment is based.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The kind of staging, such as pathological or clinical staging.

FHIR Consent resource record.

Fields

resourceType RESOURCE_NAME_CONSENT(default RESOURCE_NAME_CONSENT) - The type of the resource describes

date? date - Date the consent instance was agreed to.

sourceReference? Reference[] - A reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

policyText? Reference[] - A Reference to the human readable policy explaining the basis for the Consent.

subject? Reference - The patient/healthcare practitioner or group of persons to whom this consent applies.

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 managable, 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).

grantee? Reference[] - The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

sourceAttachment? Attachment[] - The source on which this consent statement is based. The source might be a scanned original paper form.

language? code - The base language in which the resource is written.

grantor? Reference[] - The entity responsible for granting the rights listed in a Consent Directive.

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.

verification? ConsentVerification[] - Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.

policyBasis? ConsentPolicyBasis - A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.

identifier? Identifier[] - Unique identifier for this copy of the Consent Statement.

controller? Reference[] - The actor that controls/enforces the access according to the consent.

period? Period - Effective period for this Consent Resource and all provisions unless specified in that provision.

decision? ConsentDecision - Action to take - permit or deny - as default.

manager? Reference[] - The actor that manages the consent through its lifecycle.

regulatoryBasis? CodeableConcept[] - A set of codes that indicate the regulatory basis (if any) that this consent supports.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

provision? ConsentProvision[] - An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

status ConsentStatus - Indicates the current state of this Consent resource.

Element... - Rest field

health.fhir.r5.international500: ConsentPolicyBasis

Closed record

FHIR ConsentPolicyBasis datatype record.

Fields

reference? Reference - A Reference that identifies the policy the organization will enforce for this Consent.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

url? urlType - A URL that links to a computable version of the policy the organization will enforce for this Consent.

health.fhir.r5.international500: ConsentProvision

Closed record

FHIR ConsentProvision datatype record.

Fields

dataPeriod? Period - Clinical or Operational Relevant period of time that bounds the data controlled by this provision.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Timeframe for this provision.

code? CodeableConcept[] - If this code is found in an instance, then the provision applies.

expression? Expression - A computable (FHIRPath or other) definition of what is controlled by this consent.

data? ConsentProvisionData[] - The resources controlled by this provision if specific resources are referenced.

documentType? Coding[] - The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.

purpose? Coding[] - The context of the activities a user is taking - why the user is accessing the data - that are controlled by this provision.

securityLabel? Coding[] - A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

actor? ConsentProvisionActor[] - Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

action? CodeableConcept[] - Actions controlled by this provision.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

resourceType? Coding[] - The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.

health.fhir.r5.international500: ConsentProvisionActor

Closed record

FHIR ConsentProvisionActor datatype record.

Fields

reference? Reference - The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

role? CodeableConcept - How the individual is involved in the resources content that is described in the exception.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ConsentProvisionData

Closed record

FHIR ConsentProvisionData datatype record.

Fields

reference Reference - A reference to a specific resource that defines which resources are covered by this consent.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

meaning ConsentProvisionDataMeaning - How the resource reference is interpreted when testing consent restrictions.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ConsentVerification

Closed record

FHIR ConsentVerification datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

verifiedWith? Reference - Who verified the instruction (Patient, Relative or other Authorized Person).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

verified boolean - Has the instruction been verified.

verificationType? CodeableConcept - Extensible list of verification type starting with verification and re-validation.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

verifiedBy? Reference - The person who conducted the verification/validation of the Grantor decision.

verificationDate? dateTime[] - Date(s) verification was collected.

health.fhir.r5.international500: Contract

FHIR Contract resource record.

Fields

resourceType RESOURCE_NAME_CONTRACT(default RESOURCE_NAME_CONTRACT) - The type of the resource describes

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

friendly? ContractFriendly[] - The 'patient friendly language' versionof the Contract in whole or in parts. 'Patient friendly language' means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

subject? Reference[] - The target entity impacted by or of interest to parties to the agreement.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

rule? ContractRule[] - List of Computable Policy Rule Language Representations of this Contract.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.

'type? CodeableConcept - A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.

instantiatesUri? uri - The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

relevantHistory? Reference[] - Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provenance.entity indicates the target that was changed in the update (see Provenance.entity).

supportingInfo? Reference[] - Information that may be needed by/relevant to the performer in their execution of this term action.

topicReference? Reference - Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

contentDefinition? ContractContentDefinition - Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.

scope? CodeableConcept - A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.

legal? ContractLegal[] - List of Legal expressions or representations of this Contract.

alias? string[] - Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.

term? ContractTerm[] - One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? dateTime - When this Contract was issued.

contentDerivative? CodeableConcept - The minimal content derived from the basal information source at a specific stage in its lifecycle.

signer? ContractSigner[] - Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.

identifier? Identifier[] - Unique identifier for this Contract or a derivative that references a Source Contract.

expirationType? CodeableConcept - Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.

legallyBindingAttachment? Attachment - Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the 'source of truth' and which would be the basis for legal action related to enforcement of this Contract.

author? Reference - The individual or organization that authored the Contract definition, derivative, or instance in any legal state.

topicCodeableConcept? CodeableConcept - Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

instantiatesCanonical? Reference - The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.

'version? string - An edition identifier used for business purposes to label business significant variants.

url? uri - Canonical identifier for this contract, represented as a URI (globally unique).

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

site? Reference[] - Sites in which the contract is complied with, exercised, or in force.

applies? Period - Relevant time or time-period when this Contract is applicable.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

authority? Reference[] - A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

domain? Reference[] - Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

subtitle? string - A more detailed or qualifying explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.

name? string - A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType? CodeableConcept[] - Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.

legalState? CodeableConcept - Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.

legallyBindingReference? Reference - Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the 'source of truth' and which would be the basis for legal action related to enforcement of this Contract.

status? ContractStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: ContractContentDefinition

Closed record

FHIR ContractContentDefinition datatype record.

Fields

publicationStatus ContractContentDefinitionPublicationStatus - amended | appended | cancelled | disputed | entered-in-error | executable +.

copyright? markdown - A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

publisher? Reference - The individual or organization that published the Contract precursor content.

subType? CodeableConcept - Detailed Precusory content type.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.

publicationDate? dateTime - The date (and optionally time) when the contract was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.

health.fhir.r5.international500: ContractFriendly

Closed record

FHIR ContractFriendly datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contentReference Reference - Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

contentAttachment Attachment - Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ContractLegal

Closed record

FHIR ContractLegal datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contentReference Reference - Contract legal text in human renderable form.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

contentAttachment Attachment - Contract legal text in human renderable form.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ContractRule

Closed record

FHIR ContractRule datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contentReference Reference - Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

contentAttachment Attachment - Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ContractSigner

Closed record

FHIR ContractSigner datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

signature Signature[] - Legally binding Contract DSIG signature contents in Base64.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type Coding - Role of this Contract signer, e.g. notary, grantee.

party Reference - Party which is a signator to this Contract.

health.fhir.r5.international500: ContractTerm

Closed record

FHIR ContractTerm datatype record.

Fields

identifier? Identifier - Unique identifier for this particular Contract Provision.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

securityLabel? ContractTermSecurityLabel[] - Security labels that protect the handling of information about the term and its elements, which may be specifically identified.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

topicCodeableConcept? CodeableConcept - The entity that the term applies to.

'type? CodeableConcept - A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.

offer ContractTermOffer - The matter of concern in the context of this provision of the agrement.

applies? Period - Relevant time or time-period when this Contract Provision is applicable.

topicReference? Reference - The entity that the term applies to.

action? ContractTermAction[] - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

subType? CodeableConcept - A specialized legal clause or condition based on overarching contract type.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - Statement of a provision in a policy or a contract.

asset? ContractTermAsset[] - Contract Term Asset List.

issued? dateTime - When this Contract Provision was issued.

health.fhir.r5.international500: ContractTermAction

Closed record

FHIR ContractTermAction datatype record.

Fields

requester? Reference[] - Who or what initiated the action and has responsibility for its activation.

note? Annotation[] - Comments made about the term action made by the requester, performer, subject or other participants.

reason? CodeableReference[] - Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. Either a coded concept, or another resource whose existence justifies permitting or not permitting this action.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

performer? Reference - Indicates who or what is being asked to perform (or not perform) the ction.

subject? ContractTermActionSubject[] - Entity of the action.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

performerRole? CodeableConcept - The type of role or competency of an individual desired or required to perform or not perform the action.

occurrenceContractDateTime? dateTime - When action happens.

performerLinkId? string[] - Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

securityLabelNumber? unsignedInt[] - Security labels that protects the action.

'type CodeableConcept - Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.

contextLinkId? string[] - Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

intent CodeableConcept - Reason or purpose for the action stipulated by this Contract Provision.

performerType? CodeableConcept[] - The type of individual that is desired or required to perform or not perform the action.

requesterLinkId? string[] - Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

occurrenceContractPeriod? Period - When action happens.

linkId? string[] - Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.

occurrenceContractTiming? Timing - When action happens.

context? Reference - Encounter or Episode with primary association to the specified term activity.

reasonLinkId? string[] - Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

doNotPerform? boolean - True if the term prohibits the action.

status CodeableConcept - Current state of the term action.

health.fhir.r5.international500: ContractTermActionSubject

Closed record

FHIR ContractTermActionSubject datatype record.

Fields

reference Reference[] - The entity the action is performed or not performed on or for.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

role? CodeableConcept - Role type of agent assigned roles in this Contract.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ContractTermAsset

Closed record

FHIR ContractTermAsset datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period[] - Asset relevant contractual time period.

usePeriod? Period[] - Time period of asset use.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

securityLabelNumber? unsignedInt[] - Security labels that protects the asset.

'type? CodeableConcept[] - Target entity type about which the term may be concerned.

condition? string - Description of the quality and completeness of the asset that may be a factor in its valuation.

linkId? string[] - Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.

periodType? CodeableConcept[] - Type of Asset availability for use or ownership.

subtype? CodeableConcept[] - May be a subtype or part of an offered asset.

scope? CodeableConcept - Differentiates the kind of the asset .

context? ContractTermAssetContext[] - Circumstance of the asset.

typeReference? Reference[] - Associated entities.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.

valuedItem? ContractTermAssetValuedItem[] - Contract Valued Item List.

relationship? Coding - Specifies the applicability of the term to an asset resource instance, and instances it refers to or instances that refer to it, and/or are owned by the offeree.

health.fhir.r5.international500: ContractTermAssetContext

Closed record

FHIR ContractTermAssetContext datatype record.

Fields

reference? Reference - Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept[] - Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - Context description.

health.fhir.r5.international500: ContractTermAssetValuedItem

Closed record

FHIR ContractTermAssetValuedItem datatype record.

Fields

unitPrice? Money - A Contract Valued Item unit valuation measure.

identifier? Identifier - Identifies a Contract Valued Item instance.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.

entityContractCodeableConcept? CodeableConcept - Specific type of Contract Valued Item that may be priced.

effectiveTime? dateTime - Indicates the time during which this Contract ValuedItem information is effective.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

securityLabelNumber? unsignedInt[] - A set of security labels that define which terms are controlled by this condition.

points? decimal - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.

linkId? string[] - Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.

responsible? Reference - Who will make payment.

recipient? Reference - Who will receive payment.

payment? string - Terms of valuation.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor? decimal - A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

paymentDate? dateTime - When payment is due.

entityContractReference? Reference - Specific type of Contract Valued Item that may be priced.

health.fhir.r5.international500: ContractTermOffer

Closed record

FHIR ContractTermOffer datatype record.

Fields

identifier? Identifier[] - Unique identifier for this particular Contract Provision.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

decision? CodeableConcept - Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

securityLabelNumber? unsignedInt[] - Security labels that protects the offer.

'type? CodeableConcept - Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.

linkId? string[] - The id of the clause or question text of the offer in the referenced questionnaire/response.

answer? ContractTermOfferAnswer[] - Response to offer text.

decisionMode? CodeableConcept[] - How the decision about a Contract was conveyed.

topic? Reference - The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - Human readable form of this Contract Offer.

party? ContractTermOfferParty[] - Offer Recipient.

health.fhir.r5.international500: ContractTermOfferAnswer

Closed record

FHIR ContractTermOfferAnswer datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueContractCoding Coding - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractInteger integer - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractBoolean boolean - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueContractUri uri - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractDate date - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractAttachment Attachment - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractTime time - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueContractDecimal decimal - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractDateTime dateTime - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractString string - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractQuantity Quantity - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

valueContractReference Reference - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research.

health.fhir.r5.international500: ContractTermOfferParty

Closed record

FHIR ContractTermOfferParty datatype record.

Fields

reference Reference[] - Participant in the offer.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

role CodeableConcept - How the party participates in the offer.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ContractTermSecurityLabel

Closed record

FHIR ContractTermSecurityLabel datatype record.

Fields

number? unsignedInt[] - Number used to link this term or term element to the applicable Security Label.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

control? Coding[] - Security label privacy tag that specifies the manner in which term and/or term elements are to be protected.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? Coding[] - Security label privacy tag that specifies the applicable privacy and security policies governing this term and/or term elements.

classification Coding - Security label privacy tag that specifies the level of confidentiality protection required for this term and/or term elements.

health.fhir.r5.international500: Coverage

FHIR Coverage resource record.

Fields

resourceType RESOURCE_NAME_COVERAGE(default RESOURCE_NAME_COVERAGE) - The type of the resource describes

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subrogation? boolean - When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

'type? CodeableConcept - The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

network? string - The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

insurer? Reference - The program or plan underwriter, payor, insurance company.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relationship? CodeableConcept - The relationship of beneficiary (patient) to the subscriber.

'class? CoverageClass[] - A suite of underwriter specific classifiers.

dependent? string - A designator for a dependent under the coverage.

insurancePlan? Reference - The insurance plan details, benefits and costs, which constitute this insurance coverage.

'order? positiveInt - The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. For example; a patient might have (0) auto insurance (1) their own health insurance and (2) spouse's health insurance. When claiming for treatments which were not the result of an auto accident then only coverages (1) and (2) above would be applicatble and would apply in the order specified in parenthesis.

identifier? Identifier[] - The identifier of the coverage as issued by the insurer.

costToBeneficiary? CoverageCostToBeneficiary[] - A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

period? Period - Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

subscriber? Reference - The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

kind CoverageKind - The nature of the coverage be it insurance, or cash payment such as self-pay.

contract? Reference[] - The policy(s) which constitute this insurance coverage.

subscriberId? Identifier[] - The insurer assigned ID for the Subscriber.

paymentBy? CoveragePaymentBy[] - Link to the paying party and optionally what specifically they will be responsible to pay.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

beneficiary Reference - The party who benefits from the insurance coverage; the patient when products and/or services are provided.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

policyHolder? Reference - The party who 'owns' the insurance policy.

status CoverageStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: CoverageClass

Closed record

FHIR CoverageClass datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name? string - A short description for the class.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The type of classification for which an insurer-specific class label or number and optional name is provided. For example, type may be used to identify a class of coverage or employer group, policy, or plan.

value Identifier - The alphanumeric identifier associated with the insurer issued label.

health.fhir.r5.international500: CoverageCostToBeneficiary

Closed record

FHIR CoverageCostToBeneficiary datatype record.

Fields

exception? CoverageCostToBeneficiaryException[] - A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unit? CodeableConcept - Indicates if the benefits apply to an individual or to the family.

valueMoney? Money - The amount due from the patient for the cost category.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

term? CodeableConcept - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

'type? CodeableConcept - The category of patient centric costs associated with treatment.

network? CodeableConcept - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

valueQuantity? Quantity - The amount due from the patient for the cost category.

health.fhir.r5.international500: CoverageCostToBeneficiaryException

Closed record

FHIR CoverageCostToBeneficiaryException datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 the exception is in force.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The code for the specific exception.

health.fhir.r5.international500: CoverageEligibilityRequest

FHIR CoverageEligibilityRequest resource record.

Fields

resourceType RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST(default RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST) - The type of the resource describes

insurance? CoverageEligibilityRequestInsurance[] - Financial instruments for reimbursement for the health care products and services.

identifier? Identifier[] - A unique identifier assigned to this coverage eligiblity request.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item? CoverageEligibilityRequestItem[] - Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.

purpose CoverageEligibilityRequestPurpose[] - Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

created dateTime - The date when this resource was created.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

priority? CodeableConcept - When the requestor expects the processor to complete processing.

servicedPeriod? Period - The date or dates when the enclosed suite of services were performed or completed.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

supportingInfo? CoverageEligibilityRequestSupportingInfo[] - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

provider? Reference - The provider which is responsible for the request.

insurer Reference - The Insurer who issued the coverage in question and is the recipient of the request.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient Reference - The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

enterer? Reference - Person who created the request.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

servicedDate? date - The date or dates when the enclosed suite of services were performed or completed.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

event? CoverageEligibilityRequestEvent[] - Information code for an event with a corresponding date or period.

facility? Reference - Facility where the services are intended to be provided.

status CoverageEligibilityRequestStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: CoverageEligibilityRequestEvent

Closed record

FHIR CoverageEligibilityRequestEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

whenDateTime dateTime - A date or period in the past or future indicating when the event occurred or is expectd to occur.

whenPeriod Period - A date or period in the past or future indicating when the event occurred or is expectd to occur.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - A coded event such as when a service is expected or a card printed.

health.fhir.r5.international500: CoverageEligibilityRequestInsurance

Closed record

FHIR CoverageEligibilityRequestInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

businessArrangement? string - A business agreement number established between the provider and the insurer for special business processing purposes.

focal? boolean - A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CoverageEligibilityRequestItem

Closed record

FHIR CoverageEligibilityRequestItem datatype record.

Fields

unitPrice? Money - The amount charged to the patient by the provider for a single unit.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The number of repetitions of a service or product.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

diagnosis? CoverageEligibilityRequestItemDiagnosis[] - Patient diagnosis for which care is sought.

productOrService? CodeableConcept - This contains the product, service, drug or other billing code for the item.

provider? Reference - The practitioner who is responsible for the product or service to be rendered to the patient.

supportingInfoSequence? positiveInt[] - Exceptions, special conditions and supporting information applicable for this service or product line.

detail? Reference[] - The plan/proposal/order describing the proposed service in detail.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

facility? Reference - Facility where the services will be provided.

health.fhir.r5.international500: CoverageEligibilityRequestItemDiagnosis

Closed record

FHIR CoverageEligibilityRequestItemDiagnosis datatype record.

Fields

diagnosisCoverageEligibilityRequestCodeableConcept? CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

diagnosisCoverageEligibilityRequestReference? Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

health.fhir.r5.international500: CoverageEligibilityRequestSupportingInfo

Closed record

FHIR CoverageEligibilityRequestSupportingInfo datatype record.

Fields

sequence positiveInt - A number to uniquely identify supporting information entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

appliesToAll? boolean - The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

information Reference - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: CoverageEligibilityResponse

FHIR CoverageEligibilityResponse resource record.

Fields

resourceType RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE(default RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE) - The type of the resource describes

insurance? CoverageEligibilityResponseInsurance[] - Financial instruments for reimbursement for the health care products and services.

request Reference - Reference to the original request resource.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose CoverageEligibilityResponsePurpose[] - Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

preAuthRef? string - A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.

language? code - The base language in which the resource is written.

'error? CoverageEligibilityResponseError[] - Errors encountered during the processing of the request.

servicedPeriod? Period - The date or dates when the enclosed suite of services were performed or completed.

insurer Reference - The Insurer who issued the coverage in question and is the author of the response.

patient Reference - The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

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? CoverageEligibilityResponseEvent[] - Information code for an event with a corresponding date or period.

outcome CoverageEligibilityResponseOutcome - The outcome of the request processing.

identifier? Identifier[] - A unique identifier assigned to this coverage eligiblity request.

created dateTime - The date this resource was created.

requestor? Reference - The provider which is responsible for the request.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

disposition? string - A human readable description of the status of the adjudication.

form? CodeableConcept - A code for the form to be used for printing the content.

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.

servicedDate? date - The date or dates when the enclosed suite of services were performed or completed.

status CoverageEligibilityResponseStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: CoverageEligibilityResponseError

Closed record

FHIR CoverageEligibilityResponseError datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - An error code,from a specified code system, which details why the eligibility check could not be performed.

expression? string[] - A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CoverageEligibilityResponseEvent

Closed record

FHIR CoverageEligibilityResponseEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

whenDateTime dateTime - A date or period in the past or future indicating when the event occurred or is expectd to occur.

whenPeriod Period - A date or period in the past or future indicating when the event occurred or is expectd to occur.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - A coded event such as when a service is expected or a card printed.

health.fhir.r5.international500: CoverageEligibilityResponseInsurance

Closed record

FHIR CoverageEligibilityResponseInsurance datatype record.

Fields

benefitPeriod? Period - The term of the benefits documented in this response.

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

inforce? boolean - Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.

item? CoverageEligibilityResponseInsuranceItem[] - Benefits and optionally current balances, and authorization details by category or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: CoverageEligibilityResponseInsuranceItem

Closed record

FHIR CoverageEligibilityResponseInsuranceItem datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

authorizationSupporting? CodeableConcept[] - Codes or comments regarding information or actions associated with the preauthorization.

description? string - A richer description of the benefit or services covered.

productOrService? CodeableConcept - This contains the product, service, drug or other billing code for the item.

benefit? CoverageEligibilityResponseInsuranceItemBenefit[] - Benefits used to date.

network? CodeableConcept - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

excluded? boolean - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

unit? CodeableConcept - Indicates if the benefits apply to an individual or to the family.

authorizationUrl? uri - A web location for obtaining requirements or descriptive information regarding the preauthorization.

authorizationRequired? boolean - A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

provider? Reference - The practitioner who is eligible for the provision of the product or service.

name? string - A short name or tag for the benefit.

term? CodeableConcept - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

health.fhir.r5.international500: CoverageEligibilityResponseInsuranceItemBenefit

Closed record

FHIR CoverageEligibilityResponseInsuranceItemBenefit datatype record.

Fields

allowedCoverageEligibilityResponseMoney? Money - The quantity of the benefit which is permitted under the coverage.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

usedCoverageEligibilityResponseMoney? Money - The quantity of the benefit which have been consumed to date.

usedCoverageEligibilityResponseUnsignedInt? unsignedInt - The quantity of the benefit which have been consumed to date.

allowedCoverageEligibilityResponseString? string - The quantity of the benefit which is permitted under the coverage.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

allowedCoverageEligibilityResponseUnsignedInt? unsignedInt - The quantity of the benefit which is permitted under the coverage.

usedCoverageEligibilityResponseString? string - The quantity of the benefit which have been consumed to date.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Classification of benefit being provided.

health.fhir.r5.international500: CoveragePaymentBy

Closed record

FHIR CoveragePaymentBy datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

responsibility? string - Description of the financial responsibility.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 list of parties providing non-insurance payment for the treatment costs.

health.fhir.r5.international500: CQLLibrary

FHIR CQLLibrary resource record.

Fields

resourceType RESOURCE_NAME_CQLLIBRARY(default RESOURCE_NAME_CQLLIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

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 managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

description markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

'type CQLLibraryType - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

title string - A short, descriptive, user-friendly title for the library.

content? CQLLibraryContent[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
- content Slicings
1. CQLLibraryContentCqlContent: CQL Content
- min = 1
- max = 1

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.
- relatedArtifact Slicings
1. CQLLibraryRelatedArtifactDependency: Additional documentation, citations, etc
- min = 0
- max = *

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

'version string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

url uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status CQLLibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: CQLLibraryContent

Closed record

FHIR CQLLibraryContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data? base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType? code - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: CQLLibraryContentCqlContent

Closed record

FHIR CQLLibraryContentCqlContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType code(default "text/cql") - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: CQLLibraryRelatedArtifactDependency

Closed record

FHIR CQLLibraryRelatedArtifactDependency datatype record.

Fields

publicationStatus? CQLLibraryRelatedArtifactPublicationStatus - The publication status of the artifact being referred to.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

citation? markdown - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

'resource canonical - The related artifact, such as a library, value set, profile, or other knowledge resource.

display? string - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document? Attachment - The document being referenced, represented as an attachment. This is exclusive with the resource element.

classifier? CodeableConcept[] - Provides additional classifiers of the related artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

label? string - A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

'type CQLLibraryRelatedArtifactType(default "depends-on") - The type of relationship to the related artifact.

publicationDate? date - The date of publication of the artifact being referred to.

resourceReference? Reference - The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

health.fhir.r5.international500: CQLLibraryType

Closed record

FHIR CQLLibraryType datatype record.

Fields

coding CQLLibraryTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: CQLLibraryTypeCoding

Closed record

FHIR CQLLibraryTypeCoding datatype record.

Fields

system uri(default "http://terminology.hl7.org/CodeSystem/library-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "module-definition") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r5.international500: DetectedIssue

FHIR DetectedIssue resource record.

Fields

resourceType RESOURCE_NAME_DETECTEDISSUE(default RESOURCE_NAME_DETECTEDISSUE) - The type of the resource describes

severity? DetectedIssueSeverity - Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.

identifier? Identifier[] - Business identifier associated with the detected issue record.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

mitigation? DetectedIssueMitigation[] - Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

code? CodeableConcept - Identifies the specific type of issue identified.

evidence? DetectedIssueEvidence[] - Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.

author? Reference - Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.

subject? Reference - Indicates the subject whose record the detected issue is associated with.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

encounter? Reference - The encounter during which this issue was detected.

reference? uri - The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

identifiedDateTime? dateTime - The date or period when the detected issue was initially identified.

identifiedPeriod? Period - The date or period when the detected issue was initially identified.

implicated? Reference[] - Indicates the resource representing the current activity or proposed activity that is potentially problematic.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

detail? markdown - A textual explanation of the detected issue.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - A code that classifies the general type of detected issue.

status DetectedIssueStatus - Indicates the status of the detected issue.

Element... - Rest field

health.fhir.r5.international500: DetectedIssueEvidence

Closed record

FHIR DetectedIssueEvidence datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept[] - A manifestation that led to the recording of this detected issue.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detail? Reference[] - Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: DetectedIssueMitigation

Closed record

FHIR DetectedIssueMitigation datatype record.

Fields

date? dateTime - Indicates when the mitigating action was documented.

note? Annotation[] - Clinicians may add additional notes or justifications about the mitigation action. For example, patient can have this drug because they have had it before without any issues. Multiple justifications may be provided.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

author? Reference - Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

action CodeableConcept - Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: Device

FHIR Device resource record.

Fields

resourceType RESOURCE_NAME_DEVICE(default RESOURCE_NAME_DEVICE) - The type of the resource describes

note? Annotation[] - Descriptive information, usage information or implantation information that is not captured in an existing element.

parent? Reference - The higher level or encompassing device that this device is a logical part of.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

biologicalSourceEvent? Identifier - An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

displayName? string - The name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.name, or may be another simple name.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

'type? CodeableConcept[] - The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

cycle? Count - The series of occurrences that repeats during the operation of the device.

manufacturer? string - A name of the manufacturer or entity legally responsible for the device.

duration? Duration - A measurement of time during the device's operation (e.g., days, hours, mins, etc.).

mode? CodeableConcept - The designated condition for performing a task with the device.

endpoint? Reference[] - Technical endpoints providing access to services provided by the device defined at this resource.

safety? CodeableConcept[] - Provides additional safety characteristics about a medical device. For example devices containing latex.

contact? ContactPoint[] - Contact details for an organization or a particular human that is responsible for the device.

property? DeviceProperty[] - Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

manufactureDate? dateTime - The date and time when the device was manufactured.

definition? CodeableReference - The reference to the definition for the device.

availabilityStatus? CodeableConcept - The availability of the device.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

expirationDate? dateTime - The date and time beyond which this device is no longer valid or should not be used (if applicable).

owner? Reference - An organization that is responsible for the provision and ongoing maintenance of the device.

identifier? Identifier[] - Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

serialNumber? string - The serial number assigned by the organization when the device was manufactured.

lotNumber? string - Lot number assigned by the manufacturer.

'version? DeviceVersion[] - The actual design of the device or software version running on the device.

url? uri - A network address on which the device may be contacted directly.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

udiCarrier? DeviceUdiCarrier[] - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? DeviceName[] - This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

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 place where the device can be found.

modelNumber? string - The manufacturer's model number for the device.

partNumber? string - The part number or catalog number of the device.

conformsTo? DeviceConformsTo[] - Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

category? CodeableConcept[] - Devices may be associated with one or more categories.

gateway? CodeableReference[] - The linked device acting as a communication controller, data collector, translator, or concentrator for the current device (e.g., mobile phone application that relays a blood pressure device's data).

status? DeviceStatus - The Device record status. This is not the status of the device like availability.

Element... - Rest field

health.fhir.r5.international500: DeviceAssociation

FHIR DeviceAssociation resource record.

Fields

resourceType RESOURCE_NAME_DEVICEASSOCIATION(default RESOURCE_NAME_DEVICEASSOCIATION) - The type of the resource describes

identifier? Identifier[] - Instance identifier.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Begin and end dates and times for the device association.

subject? Reference - The individual, group of individuals or device that the device is on or associated with.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

statusReason? CodeableConcept[] - The reasons given for the current association status.

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.

bodyStructure? Reference - Current anatomical location of the device in/on subject.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - Describes the relationship between the device and subject.

device Reference - Reference to the devices associated with the patient or group.

operation? DeviceAssociationOperation[] - The details about the device when it is in use to describe its operation.

status CodeableConcept - Indicates the state of the Device association.

Element... - Rest field

health.fhir.r5.international500: DeviceAssociationOperation

Closed record

FHIR DeviceAssociationOperation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Begin and end dates and times for the device's 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

operator? Reference[] - The individual performing the action enabled by the device.

status CodeableConcept - Device operational condition corresponding to the association.

health.fhir.r5.international500: DeviceConformsTo

Closed record

FHIR DeviceConformsTo datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

specification CodeableConcept - Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - Describes the type of the standard, specification, or formal guidance.

'version? string - Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.

health.fhir.r5.international500: DeviceDefinition

FHIR DeviceDefinition resource record.

Fields

resourceType RESOURCE_NAME_DEVICEDEFINITION(default RESOURCE_NAME_DEVICEDEFINITION) - The type of the resource describes

note? Annotation[] - Descriptive information, usage information or implantation information that is not captured in an existing element.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

link? DeviceDefinitionLink[] - An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.

regulatoryIdentifier? DeviceDefinitionRegulatoryIdentifier[] - Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe.

description? markdown - Additional information to describe the device.

language? code - The base language in which the resource is written.

deviceName? DeviceDefinitionDeviceName[] - The name or names of the device as given by the manufacturer.

manufacturer? Reference - A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.

shelfLifeStorage? ProductShelfLife[] - Shelf Life and storage information.

safety? CodeableConcept[] - Safety characteristics of the device.

contact? ContactPoint[] - Contact details for an organization or a particular human that is responsible for the device.

property? DeviceDefinitionProperty[] - Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

owner? Reference - An organization that is responsible for the provision and ongoing maintenance of the device.

identifier? Identifier[] - Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. The identifier is typically valued if the udiDeviceIdentifier, partNumber or modelNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

hasPart? DeviceDefinitionHasPart[] - A device that is part (for example a component) of the present device.

chargeItem? DeviceDefinitionChargeItem[] - Billing code or reference associated with the device.

packaging? DeviceDefinitionPackaging[] - Information about the packaging of the device, i.e. how the device is packaged.

classification? DeviceDefinitionClassification[] - What kind of device or device system this is.

languageCode? CodeableConcept[] - Language code for the human-readable text strings produced by the device (all supported).

productionIdentifierInUDI? DeviceDefinitionProductionIdentifierInUDI[] - Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.

'version? DeviceDefinitionVersion[] - The version of the device or software.

udiDeviceIdentifier? DeviceDefinitionUdiDeviceIdentifier[] - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

material? DeviceDefinitionMaterial[] - A substance used to create the material(s) of which the device is made.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

guideline? DeviceDefinitionGuideline - Information aimed at providing directions for the usage of this model of device.

correctiveAction? DeviceDefinitionCorrectiveAction - Tracking of latest field safety corrective action.

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.

modelNumber? string - The model number for the device for example as defined by the manufacturer or labeler, or other agency.

partNumber? string - The part number or catalog number of the device.

conformsTo? DeviceDefinitionConformsTo[] - Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

Element... - Rest field

health.fhir.r5.international500: DeviceDefinitionChargeItem

Closed record

FHIR DeviceDefinitionChargeItem datatype record.

Fields

chargeItemCode CodeableReference - The code or reference for the charge item.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

effectivePeriod? Period - A specific time period in which this charge item applies.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

count Quantity - Coefficient applicable to the billing code.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

useContext? UsageContext[] - The context to which this charge item applies.

health.fhir.r5.international500: DeviceDefinitionClassification

Closed record

FHIR DeviceDefinitionClassification datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

justification? RelatedArtifact[] - Further information qualifying this classification of the device model.

'type CodeableConcept - A classification or risk class of the device model.

health.fhir.r5.international500: DeviceDefinitionConformsTo

Closed record

FHIR DeviceDefinitionConformsTo datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

specification CodeableConcept - Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.

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? RelatedArtifact[] - Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance.

category? CodeableConcept - Describes the type of the standard, specification, or formal guidance.

'version? string[] - Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.

health.fhir.r5.international500: DeviceDefinitionCorrectiveAction

Closed record

FHIR DeviceDefinitionCorrectiveAction datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Start and end dates of the corrective 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

recall boolean - Whether the last corrective action known for this device was a recall.

scope? DeviceDefinitionCorrectiveActionScope - The scope of the corrective action - whether the action targeted all units of a given device model, or only a specific set of batches identified by lot numbers, or individually identified devices identified by the serial name.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: DeviceDefinitionDeviceName

Closed record

FHIR DeviceDefinitionDeviceName datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name string - A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type DeviceDefinitionDeviceNameType - The type of deviceName. RegisteredName | UserFriendlyName | PatientReportedName.

health.fhir.r5.international500: DeviceDefinitionGuideline

Closed record

FHIR DeviceDefinitionGuideline datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relatedArtifact? RelatedArtifact[] - A source of information or reference for this guideline.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

intendedUse? string - A description of the general purpose or medical use of the device or its function.

usageInstruction? markdown - Detailed written and visual directions for the user on how to use the device.

warning? CodeableConcept[] - Specific hazard alert information that a user needs to know before using the device.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

indication? CodeableConcept[] - A clinical condition for which the device was designed to be used.

useContext? UsageContext[] - The circumstances that form the setting for using the device.

contraindication? CodeableConcept[] - A specific situation when a device should not be used because it may cause harm.

health.fhir.r5.international500: DeviceDefinitionHasPart

Closed record

FHIR DeviceDefinitionHasPart datatype record.

Fields

reference Reference - Reference to the device that is part of the current device.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

count? integer - Number of instances of the component device in the current device.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: DeviceDefinitionLink

Closed record

FHIR DeviceDefinitionLink datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

relatedDevice CodeableReference - A reference to the linked device.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relation Coding - The type indicates the relationship of the related device to the device instance.

health.fhir.r5.international500: DeviceDefinitionMaterial

Closed record

FHIR DeviceDefinitionMaterial datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - A substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.

alternate? boolean - Indicates an alternative material of the device.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

allergenicIndicator? boolean - Whether the substance is a known or suspected allergen.

health.fhir.r5.international500: DeviceDefinitionPackaging

Closed record

FHIR DeviceDefinitionPackaging datatype record.

Fields

identifier? Identifier - The business identifier of the packaged medication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

count? integer - The number of items contained in the package (devices or sub-packages).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - A code that defines the specific type of packaging.

distributor? DeviceDefinitionPackagingDistributor[] - An organization that distributes the packaged device.

health.fhir.r5.international500: DeviceDefinitionPackagingDistributor

Closed record

FHIR DeviceDefinitionPackagingDistributor datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Distributor's human-readable name.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

organizationReference? Reference[] - Distributor as an Organization resource.

health.fhir.r5.international500: DeviceDefinitionProperty

Closed record

FHIR DeviceDefinitionProperty datatype record.

Fields

valueCodeableConcept CodeableConcept - The value of the property specified by the associated property.type code.

valueBoolean boolean - The value of the property specified by the associated property.type code.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueAttachment Attachment - The value of the property specified by the associated property.type code.

valueString string - The value of the property specified by the associated property.type code.

valueRange Range - The value of the property specified by the associated property.type code.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Code that specifies the property such as a resolution or color being represented.

valueInteger integer - The value of the property specified by the associated property.type code.

valueQuantity Quantity - The value of the property specified by the associated property.type code.

health.fhir.r5.international500: DeviceDefinitionRegulatoryIdentifier

Closed record

FHIR DeviceDefinitionRegulatoryIdentifier datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

deviceIdentifier string - The identifier itself.

jurisdiction uri - The jurisdiction to which the deviceIdentifier applies.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 DeviceDefinitionRegulatoryIdentifierType - The type of identifier itself.

issuer uri - The organization that issued this identifier.

health.fhir.r5.international500: DeviceDefinitionUdiDeviceIdentifier

Closed record

FHIR DeviceDefinitionUdiDeviceIdentifier datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

deviceIdentifier string - The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier.

jurisdiction uri - The jurisdiction to which the deviceIdentifier applies.

marketDistribution? DeviceDefinitionUdiDeviceIdentifierMarketDistribution[] - Indicates where and when the device is available on the market.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

issuer uri - The organization that assigns the identifier algorithm.

health.fhir.r5.international500: DeviceDefinitionUdiDeviceIdentifierMarketDistribution

Closed record

FHIR DeviceDefinitionUdiDeviceIdentifierMarketDistribution datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

marketPeriod Period - Begin and end dates for the commercial distribution of the 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subJurisdiction uri - National state or territory to which the marketDistribution recers, typically where the device is commercialized.

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.r5.international500: DeviceDefinitionVersion

Closed record

FHIR DeviceDefinitionVersion datatype record.

Fields

component? Identifier - The hardware or software module of the device to which the version applies.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The type of the device version, e.g. manufacturer, approved, internal.

value string - The version text.

health.fhir.r5.international500: DeviceDispense

FHIR DeviceDispense resource record.

Fields

resourceType RESOURCE_NAME_DEVICEDISPENSE(default RESOURCE_NAME_DEVICEDISPENSE) - The type of the resource describes

note? Annotation[] - Extra information about the dispense that could not be conveyed in the other attributes.

partOf? Reference[] - The bigger event that this dispense is a part of.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

preparedDate? dateTime - The time when the dispensed product was packaged and reviewed.

subject Reference - A link to a resource representing the person to whom the device is intended.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

destination? Reference - Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.

language? code - The base language in which the resource is written.

'type? CodeableConcept - Indicates the type of dispensing event that is performed.

statusReason? CodeableReference - Indicates the reason why a dispense was or was not performed.

usageInstruction? markdown - The full representation of the instructions.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - The order or request that this dispense is fulfilling.

identifier? Identifier[] - Business identifier for this dispensation.

performer? DeviceDispensePerformer[] - Indicates who or what performed the event.

quantity? SimpleQuantity - The number of devices that have been dispensed.

receiver? Reference - Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.

supportingInformation? Reference[] - Additional information that supports the device being dispensed.

whenHandedOver? dateTime - The time the dispensed product was made available to the patient or their representative.

encounter? Reference - The encounter that establishes the context for this event.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

eventHistory? Reference[] - A summary of the events of interest that have occurred, such as when the dispense was verified.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? Reference - The principal physical location where the dispense was performed.

category? CodeableConcept[] - Indicates the type of device dispense.

device CodeableReference - Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.

status DeviceDispenseStatus - A code specifying the state of the set of dispense events.

Element... - Rest field

health.fhir.r5.international500: DeviceDispensePerformer

Closed record

FHIR DeviceDispensePerformer datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: DeviceMetric

FHIR DeviceMetric resource record.

Fields

resourceType RESOURCE_NAME_DEVICEMETRIC(default RESOURCE_NAME_DEVICEMETRIC) - The type of the resource describes

operationalStatus? DeviceMetricOperationalStatus - Indicates current operational state of the device. For example: On, Off, Standby, etc.

identifier? Identifier[] - Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

color? code - The preferred color associated with the metric (e.g., display color). This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).

measurementFrequency? Quantity - The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured.

language? code - The base language in which the resource is written.

'type CodeableConcept - Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

unit? CodeableConcept - Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category DeviceMetricCategory - Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

calibration? DeviceMetricCalibration[] - Describes the calibrations that have been performed or that are required to be performed.

device Reference - Describes the link to the Device. This is also known as a channel device.

Element... - Rest field

health.fhir.r5.international500: DeviceMetricCalibration

Closed record

FHIR DeviceMetricCalibration datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

state? DeviceMetricCalibrationState - Describes the state of the calibration.

time? instant - Describes the time last calibration has been performed.

'type? DeviceMetricCalibrationType - Describes the type of the calibration method.

health.fhir.r5.international500: DeviceMetricObservationProfile

FHIR DeviceMetricObservationProfile resource record.

Fields

resourceType RESOURCE_NAME_DEVICEMETRICOBSERVATIONPROFILE(default RESOURCE_NAME_DEVICEMETRICOBSERVATIONPROFILE) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

note? Annotation[] - Comments about the observation or the results.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.

valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.

identifier? Identifier[] - A unique identifier assigned to this observation.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? DeviceMetricObservationProfileComponent[] - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

referenceRange? DeviceMetricObservationProfileReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

valueString? string - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

category? CodeableConcept[] - A code that classifies the general type of observation being made.

device Reference - A reference to the device that generates the measurements or the device settings for the device.

status DeviceMetricObservationProfileStatus - The status of the result value.

triggeredBy? DeviceMetricObservationProfileTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: DeviceMetricObservationProfileComponent

Closed record

FHIR DeviceMetricObservationProfileComponent datatype record.

Fields

valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - The information determined as a result of making the observation, if the information has a simple value.

valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.

valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.

valueAttachment? Attachment - The information determined as a result of making the observation, if the information has a simple value.

valueString? string - The information determined as a result of making the observation, if the information has a simple value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r5.international500: DeviceMetricObservationProfileReferenceRange

Closed record

FHIR DeviceMetricObservationProfileReferenceRange datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? markdown - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

normalValue? CodeableConcept - The value of the normal value of the reference range.

age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r5.international500: DeviceMetricObservationProfileTriggeredBy

Closed record

FHIR DeviceMetricObservationProfileTriggeredBy datatype record.

Fields

reason? string - Provides the reason why this observation was performed as a result of the observation(s) referenced.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

observation Reference - Reference to the triggering observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 DeviceMetricObservationProfileTriggeredByType - The type of trigger. Reflex | Repeat | Re-run.

health.fhir.r5.international500: DeviceName

Closed record

FHIR DeviceName datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

display? boolean - Indicates the default or preferred name to be displayed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 DeviceNameType - Indicates the kind of name. RegisteredName | UserFriendlyName | PatientReportedName.

value string - The actual name that identifies the device.

health.fhir.r5.international500: DeviceProperty

Closed record

FHIR DeviceProperty datatype record.

Fields

valueCodeableConcept CodeableConcept - The value of the property specified by the associated property.type code.

valueBoolean boolean - The value of the property specified by the associated property.type code.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueAttachment Attachment - The value of the property specified by the associated property.type code.

valueString string - The value of the property specified by the associated property.type code.

valueRange Range - The value of the property specified by the associated property.type code.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Code that specifies the property, such as resolution, color, size, being represented.

valueInteger integer - The value of the property specified by the associated property.type code.

valueQuantity Quantity - The value of the property specified by the associated property.type code.

health.fhir.r5.international500: DeviceRequest

FHIR DeviceRequest resource record.

Fields

resourceType RESOURCE_NAME_DEVICEREQUEST(default RESOURCE_NAME_DEVICEREQUEST) - The type of the resource describes

insurance? Reference[] - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

note? Annotation[] - Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

reason? CodeableReference[] - Reason or justification for the use of this device.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference - The details of the device to be used.

subject Reference - The patient who will use the device.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

relevantHistory? Reference[] - Key events in the history of the request.

asNeededFor? CodeableConcept - The reason for using the device.

asNeeded? boolean - This status is to indicate whether the request is a PRN or may be given as needed.

supportingInfo? Reference[] - Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

'parameter? DeviceRequestParameter[] - Specific parameters for the ordered item. For example, the prism value for lenses.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform? boolean - If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.

basedOn? Reference[] - Plan/proposal/order fulfilled by this request.

requester? Reference - The individual or entity who initiated the request and has responsibility for its activation.

identifier? Identifier[] - Identifiers assigned to this order by the orderer or by the receiver.

authoredOn? dateTime - When the request transitioned to being actionable.

performer? CodeableReference - The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).

quantity? integer - The number of devices to be provided.

replaces? Reference[] - The request takes the place of the referenced completed or terminated request(s).

encounter? Reference - An encounter that provides additional context in which this request is made.

occurrenceTiming? Timing - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.

instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

priority? DeviceRequestPriority - Indicates how quickly the request should be addressed with respect to other requests.

intent DeviceRequestIntent - Whether the request is a proposal, plan, an original order or a reflex order.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

occurrencePeriod? Period - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime? dateTime - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.

groupIdentifier? Identifier - A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

status? DeviceRequestStatus - The status of the request.

Element... - Rest field

health.fhir.r5.international500: DeviceRequestParameter

Closed record

FHIR DeviceRequestParameter datatype record.

Fields

valueCodeableConcept? CodeableConcept - The value of the device detail.

valueBoolean? boolean - The value of the device detail.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code or string that identifies the device detail being asserted.

valueRange? Range - The value of the device detail.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity? Quantity - The value of the device detail.

health.fhir.r5.international500: DeviceUdiCarrier

Closed record

FHIR DeviceUdiCarrier datatype record.

Fields

entryType? DeviceUdiCarrierEntryType - A coded entry to indicate how the data was entered.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

deviceIdentifier string - The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

carrierHRF? string - The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

jurisdiction? uri - The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/us-fda-udi or in the European Union by the European Commission http://hl7.org/fhir/NamingSystem/eu-ec-udi.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

carrierAIDC? base64Binary - The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.

issuer uri - Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include: 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.

health.fhir.r5.international500: DeviceUsage

FHIR DeviceUsage resource record.

Fields

resourceType RESOURCE_NAME_DEVICEUSAGE(default RESOURCE_NAME_DEVICEUSAGE) - The type of the resource describes

note? Annotation[] - Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

reason? CodeableReference[] - Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsage.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, 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.

usageReason? CodeableConcept[] - The reason for asserting the usage status - for example forgot, lost, stolen, broken.

informationSource? Reference - Who reported the device was being used by the patient.

patient Reference - The patient who used the device.

context? Reference - The encounter or episode of care that establishes the context for this device use statement.

derivedFrom? Reference[] - Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage.

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.

dateAsserted? dateTime - The time at which the statement was recorded by informationSource.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage.

identifier? Identifier[] - An external identifier for this statement such as an IRI.

usageStatus? CodeableConcept - The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.

timingTiming? Timing - How often the device was used.

timingPeriod? Period - How often the device was used.

adherence? DeviceUsageAdherence - This indicates how or if the device is being used.

bodySite? CodeableReference - Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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[] - This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).

device CodeableReference - Code or Reference to device used.

status DeviceUsageStatus - A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.

timingDateTime? dateTime - How often the device was used.

Element... - Rest field

health.fhir.r5.international500: DeviceUsageAdherence

Closed record

FHIR DeviceUsageAdherence datatype record.

Fields

reason CodeableConcept[] - Reason for adherence type.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Type of adherence.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: DeviceVersion

Closed record

FHIR DeviceVersion datatype record.

Fields

component? Identifier - The hardware or software module of the device to which the version applies.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

installDate? dateTime - The date the version was installed on the 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The type of the device version, e.g. manufacturer, approved, internal.

value string - The version text.

health.fhir.r5.international500: DiagnosticReport

FHIR DiagnosticReport resource record.

Fields

resourceType RESOURCE_NAME_DIAGNOSTICREPORT(default RESOURCE_NAME_DIAGNOSTICREPORT) - The type of the resource describes

note? Annotation[] - Comments about the diagnostic report.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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[] - One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted.

code CodeableConcept - A code or name that describes this diagnostic report.

subject? Reference - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

presentedForm? Attachment[] - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

language? code - The base language in which the resource is written.

media? DiagnosticReportMedia[] - A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

conclusion? markdown - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

result? Reference[] - Observations that are part of this diagnostic report.

supportingInfo? DiagnosticReportSupportingInfo[] - This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.

composition? Reference - Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.

specimen? Reference[] - Details about the specimens on which this diagnostic report is based.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.

basedOn? Reference[] - Details concerning a service requested.

identifier? Identifier[] - Identifiers assigned to this report by the performer or other systems.

performer? Reference[] - The diagnostic service that is responsible for issuing the report.

effectivePeriod? Period - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

resultsInterpreter? Reference[] - The practitioner or organization that is responsible for the report's conclusions and interpretations.

conclusionCode? CodeableConcept[] - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

effectiveDateTime? dateTime - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.

status DiagnosticReportStatus - The status of the diagnostic report.

Element... - Rest field

health.fhir.r5.international500: DiagnosticReportMedia

Closed record

FHIR DiagnosticReportMedia datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

link Reference - Reference to the image or data source.

comment? string - A comment about the image or data. Typically, this is used to provide an explanation for why the image or data is included, or to draw the viewer's attention to important features.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: DiagnosticReportSupportingInfo

Closed record

FHIR DiagnosticReportSupportingInfo datatype record.

Fields

reference Reference - The reference for the supporting information in the diagnostic report.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The code value for the role of the supporting information in the diagnostic report.

health.fhir.r5.international500: DocumentReference

FHIR DocumentReference resource record.

Fields

resourceType RESOURCE_NAME_DOCUMENTREFERENCE(default RESOURCE_NAME_DOCUMENTREFERENCE) - The type of the resource describes

date? instant - When the document reference was created.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modality? CodeableConcept[] - Imaging modality used. This may include both acquisition and non-acquisition modalities.

subject? Reference - Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 - Human-readable description of the source document.

language? code - The base language in which the resource is written.

'type? CodeableConcept - Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

content DocumentReferenceContent[] - The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.

docStatus? DocumentReferenceDocStatus - The status of the underlying document.

practiceSetting? CodeableConcept - This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

context? Reference[] - Describes the clinical encounter or type of care that the document content is associated with.

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? CodeableReference[] - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.

relatesTo? DocumentReferenceRelatesTo[] - Relationships that this document has with other document references that already exist.

basedOn? Reference[] - A procedure that is fulfilled in whole or in part by the creation of this media.

identifier? Identifier[] - Other business identifiers associated with the document, including version independent identifiers.

period? Period - The time period over which the service that is described by the document was provided.

custodian? Reference - Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

facilityType? CodeableConcept - The kind of facility where the patient was seen.

author? Reference[] - Identifies who is responsible for adding the information to the document.

securityLabel? CodeableConcept[] - A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.

'version? string - An explicitly assigned identifer of a variation of the content in the DocumentReference.

attester? DocumentReferenceAttester[] - A participant who has authenticated the accuracy of the document.

bodySite? CodeableReference[] - The anatomic structures included in the document.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

status DocumentReferenceStatus - The status of this document reference.

Element... - Rest field

health.fhir.r5.international500: DocumentReferenceAttester

Closed record

FHIR DocumentReferenceAttester datatype record.

Fields

mode CodeableConcept - The type of attestation the authenticator offers.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

time? dateTime - When the document was attested by the party.

party? Reference - Who attested the document in the specified way.

health.fhir.r5.international500: DocumentReferenceContent

Closed record

FHIR DocumentReferenceContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

attachment Attachment - The document or URL of the document along with critical metadata to prove content has integrity.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? DocumentReferenceContentProfile[] - An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: DocumentReferenceContentProfile

Closed record

FHIR DocumentReferenceContentProfile datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueDocumentReferenceCoding Coding - Code|uri|canonical.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueDocumentReferenceUri uri - Code|uri|canonical.

valueDocumentReferenceCanonical canonical - Code|uri|canonical.

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.r5.international500: DocumentReferenceRelatesTo

Closed record

FHIR DocumentReferenceRelatesTo datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - The type of relationship that this document has with anther document.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target Reference - The target document of this relationship.

health.fhir.r5.international500: DocumentSectionLibrary

FHIR DocumentSectionLibrary resource record.

Fields

resourceType RESOURCE_NAME_DOCUMENTSECTIONLIBRARY(default RESOURCE_NAME_DOCUMENTSECTIONLIBRARY) - The type of the resource describes

Element... - Rest field

health.fhir.r5.international500: DocumentStructure

FHIR DocumentStructure resource record.

Fields

resourceType RESOURCE_NAME_DOCUMENTSTRUCTURE(default RESOURCE_NAME_DOCUMENTSTRUCTURE) - The type of the resource describes

Element... - Rest field

health.fhir.r5.international500: EBMRecommendation

FHIR EBMRecommendation resource record.

Fields

resourceType RESOURCE_NAME_EBMRECOMMENDATION(default RESOURCE_NAME_EBMRECOMMENDATION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes.

citeAsReference? Reference - Display of or reference to the bibliographic citation of the recommendation.

identifier? Identifier[] - A formal identifier that is used to identify this artifact assessment when it is represented in other formats, or referenced in a specification, model, design or an instance.

copyright? markdown - A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

artifactReference Reference - A reference to a resource, canonical resource, or non-FHIR resource which is the recommendation this comment or assessment is about.

artifactCanonical canonical - A reference to a resource, canonical resource, or non-FHIR resource which is the recommendation this comment or assessment is about.

workflowStatus? EBMRecommendationWorkflowStatus - Indicates the workflow status of the comment or change request.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).

citeAsMarkdown? markdown - Display of or reference to the bibliographic citation of the recommendation.

language? code - The base language in which the resource is written.

title? string - A short title for the assessment for use in displaying and selecting.

content? EBMRecommendationContent[] - A component comment, classifier, or rating of the artifact.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

disposition? EBMRecommendationDisposition - Indicates the disposition of the responsible party to the comment or change request.

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

artifactUri uri - A reference to a resource, canonical resource, or non-FHIR resource which is the recommendation this comment or assessment is about.

Element... - Rest field

health.fhir.r5.international500: EBMRecommendationContent

Closed record

FHIR EBMRecommendationContent datatype record.

Fields

summary? markdown - A brief summary of the content of this component.

path? uri[] - A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - A quantitative rating of the artifact.

relatedArtifact? RelatedArtifact[] - Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.

author? Reference - Indicates who or what authored the content.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

classifier? CodeableConcept[] - Represents a rating, classifier, or assessment of the artifact.

freeToShare? boolean - Acceptable to publicly share the comment, classifier or rating.

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 - Indicates what type of content this component represents.

informationType? EBMRecommendationContentInformationType - The type of information this component of the content represents.

health.fhir.r5.international500: Element

Closed record

Fields

id? string -

extension? Extension[] -

health.fhir.r5.international500: ElementdefinitionDe

Closed record

Fields

id? string -

extension? Extension[] -

versioning? ElementdefinitionDeTypeVersioning -

strength ElementdefinitionDeBindingStrength -

modifierExtension? Extension[] -

usage? UsageContext[] -

binding? ElementBinding -

rules ElementdefinitionDeSlicingRules -

language? code -

path string -

mustHaveValue? boolean -

'source? canonical -

defaultValueBase64Binary? base64Binary -

mapping? ElementMapping[] -

documentation? markdown -

valueAlternatives? canonical[] -

condition? id[] -

orderMeaning? string -

targetProfile? canonical[] -

meaningWhenMissing? markdown -

'type ElementType[] -

isModifierReason? string -

maxLength? integer -

valueBase64Binary base64Binary -

code? Coding[] -

valueSet? canonical -

maxValueDate? date -

shortDoco? string -

purpose ElementdefinitionDeBindingAdditionalPurpose -

'map string -

additional? Element[] -

description? string -

minValueDate? date -

example? ElementExample[] -

min? unsignedInt -

identity id -

alias? string[] -

definition? markdown -

human string -

sliceIsConstraining? boolean -

key id -

severity ElementdefinitionDeConstraintSeverity -

ordered? boolean -

requirements? markdown -

expression? string -

mustSupport? boolean -

max? string -

label? string -

suppress? boolean -

discriminator? ElementDiscriminator[] -

sliceName? string -

'any? boolean -

comment? markdown -

constraint? ElementConstraint[] -

base? ElementBase -

health.fhir.r5.international500: ELMLibrary

FHIR ELMLibrary resource record.

Fields

resourceType RESOURCE_NAME_ELMLIBRARY(default RESOURCE_NAME_ELMLIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

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 managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

description markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

'type ELMLibraryType - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

title string - A short, descriptive, user-friendly title for the library.

content? ELMLibraryContent[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
- content Slicings
1. ELMLibraryContentElmJsonContent: ELM JSON Content
- min = 0
- max = *

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.
- relatedArtifact Slicings
1. ELMLibraryRelatedArtifactDependency: Additional documentation, citations, etc
- min = 0
- max = *

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

'version string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

url uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status ELMLibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ELMLibraryContent

Closed record

FHIR ELMLibraryContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data? base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType? code - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: ELMLibraryContentElmJsonContent

Closed record

FHIR ELMLibraryContentElmJsonContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType code(default "application/elm+json") - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: ELMLibraryContentElmXmlContent

Closed record

FHIR ELMLibraryContentElmXmlContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType code(default "application/elm+xml") - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: ELMLibraryRelatedArtifactDependency

Closed record

FHIR ELMLibraryRelatedArtifactDependency datatype record.

Fields

publicationStatus? ELMLibraryRelatedArtifactPublicationStatus - The publication status of the artifact being referred to.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

citation? markdown - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

'resource canonical - The related artifact, such as a library, value set, profile, or other knowledge resource.

display? string - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document? Attachment - The document being referenced, represented as an attachment. This is exclusive with the resource element.

classifier? CodeableConcept[] - Provides additional classifiers of the related artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

label? string - A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

'type ELMLibraryRelatedArtifactType(default "depends-on") - The type of relationship to the related artifact.

publicationDate? date - The date of publication of the artifact being referred to.

resourceReference? Reference - The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

health.fhir.r5.international500: ELMLibraryType

Closed record

FHIR ELMLibraryType datatype record.

Fields

coding ELMLibraryTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: ELMLibraryTypeCoding

Closed record

FHIR ELMLibraryTypeCoding datatype record.

Fields

system uri(default "http://terminology.hl7.org/CodeSystem/library-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "module-definition") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r5.international500: Encounter

FHIR Encounter resource record.

Fields

resourceType RESOURCE_NAME_ENCOUNTER(default RESOURCE_NAME_ENCOUNTER) - The type of the resource describes

serviceType? CodeableReference[] - Broad categorization of the service that is to be provided (e.g. cardiology).

partOf? Reference - Another Encounter of which this encounter is a part of (administratively or in time).

reason? EncounterReason[] - The list of medical reasons that are expected to be addressed during the episode of care.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

specialArrangement? CodeableConcept[] - Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.

virtualService? VirtualServiceDetail[] - Connection details of a virtual service (e.g. conference call).

subject? Reference - The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

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 managable, 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).

dietPreference? CodeableConcept[] - Diet preferences reported by the patient.

appointment? Reference[] - The appointment that scheduled this encounter.

language? code - The base language in which the resource is written.

'type? CodeableConcept[] - Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

participant? EncounterParticipant[] - The list of people responsible for providing the service.

plannedEndDate? dateTime - The planned end date/time (or discharge date) of the encounter.

specialCourtesy? CodeableConcept[] - Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).

episodeOfCare? Reference[] - Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

'class? CodeableConcept[] - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

basedOn? Reference[] - The request this encounter satisfies (e.g. incoming referral or procedure request).

careTeam? Reference[] - The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.

identifier? Identifier[] - Identifier(s) by which this encounter is known.

actualPeriod? Period - The actual start and end time of the encounter.

subjectStatus? CodeableConcept - The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

length? Duration - Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.

diagnosis? EncounterDiagnosis[] - The list of diagnosis relevant to this encounter.

admission? EncounterAdmission - Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.

priority? CodeableConcept - Indicates the urgency of the encounter.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

plannedStartDate? dateTime - The planned start date/time (or admission date) of the encounter.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

serviceProvider? Reference - The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the colonoscopy example on the Encounter examples tab.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? EncounterLocation[] - List of locations where the patient has been during this encounter.

account? Reference[] - The set of accounts that may be used for billing for this Encounter.

status EncounterStatus - The current state of the encounter (not the state of the patient within the encounter - that is subjectState).

Element... - Rest field

health.fhir.r5.international500: EncounterAdmission

Closed record

FHIR EncounterAdmission datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

reAdmission? CodeableConcept - Indicates that this encounter is directly related to a prior admission, often because the conditions addressed in the prior admission were not fully addressed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

origin? Reference - The location/organization from which the patient came before admission.

destination? Reference - Location/organization to which the patient is discharged.

preAdmissionIdentifier? Identifier - Pre-admission identifier.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

dischargeDisposition? CodeableConcept - Category or kind of location after discharge.

admitSource? CodeableConcept - From where patient was admitted (physician referral, transfer).

health.fhir.r5.international500: EncounterDiagnosis

Closed record

FHIR EncounterDiagnosis datatype record.

Fields

condition? CodeableReference[] - The coded diagnosis or a reference to a Condition (with other resources referenced in the evidence.detail), the use property will indicate the purpose of this specific diagnosis.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

use? CodeableConcept[] - Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: EncounterHistory

FHIR EncounterHistory resource record.

Fields

resourceType RESOURCE_NAME_ENCOUNTERHISTORY(default RESOURCE_NAME_ENCOUNTERHISTORY) - The type of the resource describes

serviceType? CodeableReference[] - Broad categorization of the service that is to be provided (e.g. cardiology).

identifier? Identifier[] - Identifier(s) by which this encounter is known.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

actualPeriod? Period - The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.

subjectStatus? CodeableConcept - The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

subject? Reference - The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

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 managable, 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).

length? Duration - Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.

language? code - The base language in which the resource is written.

encounter? Reference - The Encounter associated with this set of historic values.

'type? CodeableConcept[] - Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

plannedEndDate? dateTime - The planned end date/time (or discharge date) of the encounter.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

plannedStartDate? dateTime - The planned start date/time (or admission date) of the encounter.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? EncounterHistoryLocation[] - The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

'class CodeableConcept - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

status EncounterHistoryStatus - planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.

Element... - Rest field

health.fhir.r5.international500: EncounterHistoryLocation

Closed record

FHIR EncounterHistoryLocation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

form? CodeableConcept - This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

location Reference - The location where the encounter takes place.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: EncounterLocation

Closed record

FHIR EncounterLocation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - Time period during which the patient was present at the location.

form? CodeableConcept - This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

location Reference - The location where the encounter takes place.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status? EncounterLocationStatus - The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.

health.fhir.r5.international500: EncounterParticipant

Closed record

FHIR EncounterParticipant datatype record.

Fields

actor? Reference - Person involved in the encounter, the patient/group is also included here to indicate that the patient was actually participating in the encounter. Not including the patient here covers use cases such as a case meeting between practitioners about a patient - non contact times.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept[] - Role of participant in encounter.

health.fhir.r5.international500: EncounterReason

Closed record

FHIR EncounterReason datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

use? CodeableConcept[] - What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value? CodeableReference[] - Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.

health.fhir.r5.international500: Endpoint

FHIR Endpoint resource record.

Fields

resourceType RESOURCE_NAME_ENDPOINT(default RESOURCE_NAME_ENDPOINT) - The type of the resource describes

identifier? Identifier[] - Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The interval during which the endpoint is expected to be operational.

address urlType - The uri that describes the actual end-point to connect to.

environmentType? CodeableConcept[] - The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).

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 managable, 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 description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).

language? code - The base language in which the resource is written.

connectionType CodeableConcept[] - A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

managingOrganization? Reference - The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

payload? EndpointPayload[] - The set of payloads that are provided/available at this endpoint.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

contact? ContactPoint[] - Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.

name? string - A friendly name that this endpoint can be referred to with.

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 EndpointStatus - The endpoint status represents the general expected availability of an endpoint.

Element... - Rest field

health.fhir.r5.international500: EndpointPayload

Closed record

FHIR EndpointPayload datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

mimeType? code[] - The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

'type? CodeableConcept[] - The payload type describes the acceptable content that can be communicated on the endpoint.

health.fhir.r5.international500: EnrollmentRequest

FHIR EnrollmentRequest resource record.

Fields

resourceType RESOURCE_NAME_ENROLLMENTREQUEST(default RESOURCE_NAME_ENROLLMENTREQUEST) - The type of the resource describes

coverage? Reference - Reference to the program or plan identification, underwriter or payor.

identifier? Identifier[] - The Response business identifier.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

created? dateTime - The date when this resource was created.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

candidate? Reference - Patient Resource.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

provider? Reference - The practitioner who is responsible for the services rendered to the patient.

insurer? Reference - The Insurer who is target of the request.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status? EnrollmentRequestStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: EnrollmentResponse

FHIR EnrollmentResponse resource record.

Fields

resourceType RESOURCE_NAME_ENROLLMENTRESPONSE(default RESOURCE_NAME_ENROLLMENTRESPONSE) - The type of the resource describes

identifier? Identifier[] - The Response business identifier.

request? Reference - Original request resource reference.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

created? dateTime - The date when the enclosed suite of services were performed or completed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

disposition? string - A description of the status of the adjudication.

requestProvider? Reference - The practitioner who is responsible for the services rendered to the patient.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

organization? Reference - The Insurer who produced this adjudicated response.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome? EnrollmentResponseOutcome - Processing status: error, complete.

status? EnrollmentResponseStatus - The status of the resource instance.

Element... - Rest field

health.fhir.r5.international500: EpisodeOfCare

FHIR EpisodeOfCare resource record.

Fields

resourceType RESOURCE_NAME_EPISODEOFCARE(default RESOURCE_NAME_EPISODEOFCARE) - The type of the resource describes

identifier? Identifier[] - The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

reason? EpisodeOfCareReason[] - The list of medical reasons that are expected to be addressed during the episode of care.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The interval during which the managing organization assumes the defined responsibility.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

diagnosis? EpisodeOfCareDiagnosis[] - The list of medical conditions that were addressed during the episode of care.

careManager? Reference - The practitioner that is the care manager/care coordinator for this patient.

language? code - The base language in which the resource is written.

'type? CodeableConcept[] - A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

statusHistory? EpisodeOfCareStatusHistory[] - The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

managingOrganization? Reference - The organization that has assumed the specific responsibilities for care coordination, care delivery, or other services for the specified duration.

referralRequest? Reference[] - Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient Reference - The patient who is the focus of this episode of care.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

account? Reference[] - The set of accounts that may be used for billing for this EpisodeOfCare.

careTeam? Reference[] - The list of practitioners that may be facilitating this episode of care for specific purposes.

status EpisodeOfCareStatus - planned | waitlist | active | onhold | finished | cancelled.

Element... - Rest field

health.fhir.r5.international500: EpisodeOfCareDiagnosis

Closed record

FHIR EpisodeOfCareDiagnosis datatype record.

Fields

condition? CodeableReference[] - The medical condition that was addressed during the episode of care, expressed as a text, code or a reference to another 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

use? CodeableConcept - Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: EpisodeOfCareReason

Closed record

FHIR EpisodeOfCareReason datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

use? CodeableConcept - What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value? CodeableReference[] - The medical reason that is expected to be addressed during the episode of care, expressed as a text, code or a reference to another resource.

health.fhir.r5.international500: EpisodeOfCareStatusHistory

Closed record

FHIR EpisodeOfCareStatusHistory datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period Period - The period during this EpisodeOfCare that the specific status applied.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status EpisodeOfCareStatusHistoryStatus - planned | waitlist | active | onhold | finished | cancelled.

health.fhir.r5.international500: EventDefinition

FHIR EventDefinition resource record.

Fields

resourceType RESOURCE_NAME_EVENTDEFINITION(default RESOURCE_NAME_EVENTDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the event definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.

copyright? markdown - A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the event definition.

purpose? markdown - Explanation of why this event definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the event definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description of how the event definition is used from a clinical perspective.

description? markdown - A free text natural language description of the event definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the event definition.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact? RelatedArtifact[] - Related resources such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the event definition content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

trigger TriggerDefinition[] - The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

subjectReference? Reference - A code or group definition that describes the intended subject of the event definition.

'version? string - The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url? uri - An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the event definition giving additional information about its content.

name? string - A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the event definition.

topic? CodeableConcept[] - Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.

status EventDefinitionStatus - The status of this event definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: Evidence

FHIR Evidence resource record.

Fields

resourceType RESOURCE_NAME_EVIDENCE(default RESOURCE_NAME_EVIDENCE) - The type of the resource describes

date? dateTime - The date (and optionally time) when the summary was last significantly changed. 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 summary changes.

citeAsReference? Reference - Citation Resource or display of suggested citation for this evidence.

note? Annotation[] - Footnotes and/or explanatory notes.

copyright? markdown - A copyright statement relating to the Evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Evidence.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

purpose? markdown - Explanation of why this Evidence is needed and why it has been designed as it has.

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 managable, 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).

studyDesign? CodeableConcept[] - The design of the study that produced this evidence. The design is described with any number of study design characteristics.

description? markdown - A free text natural language description of the evidence from a consumer's perspective.

citeAsMarkdown? markdown - Citation Resource or display of suggested citation for this evidence.

experimental? boolean - A Boolean value to indicate that this resource 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 summary.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individiual, organization, or device responsible for officially endorsing the content for use in some setting.

assertion? markdown - Declarative description of the Evidence.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individiual, organization, or device primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance.

statistic? EvidenceStatistic[] - Values and parameters for a single statistic.

relatedArtifact? RelatedArtifact[] - Link or citation to artifact associated with the summary.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

author? ContactDetail[] - An individiual, organization, or device primarily involved in the creation and maintenance of the content.

variableDefinition EvidenceVariableDefinition[] - Evidence variable such as population, exposure, or outcome.

certainty? EvidenceCertainty[] - Assessment of certainty, confidence in the estimates, or quality of the evidence.

reviewer? ContactDetail[] - An individiual, organization, or device primarily responsible for review of some aspect of the content.

'version? string - The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary 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 evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

synthesisType? CodeableConcept - The method to combine studies.

name? string - A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the evidence.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.

status EvidenceStatus - The status of this summary. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: EvidenceCertainty

Closed record

FHIR EvidenceCertainty datatype record.

Fields

note? Annotation[] - Footnotes and/or explanatory notes.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

rater? string - Individual or group who did the rating.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

rating? CodeableConcept - Assessment or judgement of the aspect.

description? markdown - Textual description of certainty.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Aspect of certainty being rated.

health.fhir.r5.international500: EvidenceReport

FHIR EvidenceReport resource record.

Fields

resourceType RESOURCE_NAME_EVIDENCEREPORT(default RESOURCE_NAME_EVIDENCEREPORT) - The type of the resource describes

citeAsReference? Reference - Citation Resource or display of suggested citation for this report.

note? Annotation[] - Used for footnotes and annotations.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relatedIdentifier? Identifier[] - A formal identifier that is used to identify things closely related to this EvidenceReport.

subject EvidenceReportSubject - Specifies the subject or focus of the report. Answers 'What is this report about?'.

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 managable, 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).

citeAsMarkdown? markdown - Citation Resource or display of suggested citation for this report.

language? code - The base language in which the resource is written.

section? EvidenceReportSection[] - The root of the sections that make up the composition.

'type? CodeableConcept - Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individiual, organization, or device responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relatesTo? EvidenceReportRelatesTo[] - Relationships that this composition has with other compositions or documents that already exist.

editor? ContactDetail[] - An individiual, organization, or device primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact? RelatedArtifact[] - Link, description or reference to artifact associated with the report.

author? ContactDetail[] - An individiual, organization, or device primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individiual, organization, or device primarily responsible for review of some aspect of the content.

url? uri - An absolute URI that is used to identify this EvidenceReport 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 an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the evidence report.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence report instances.

status EvidenceReportStatus - The status of this summary. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: EvidenceReportRelatesTo

Closed record

FHIR EvidenceReportRelatesTo datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 EvidenceReportRelatesToCode - The type of relationship that this composition has with anther composition or document.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target EvidenceReportRelatesToTarget - The target composition/document of this relationship.

health.fhir.r5.international500: EvidenceReportRelatesToTarget

Closed record

FHIR EvidenceReportRelatesToTarget datatype record.

Fields

identifier? Identifier - Target of the relationship Identifier.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'resource? Reference - Target of the relationship Resource reference.

display? markdown - Target of the relationship Display.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

url? uri - Target of the relationship URL.

health.fhir.r5.international500: EvidenceReportSection

Closed record

FHIR EvidenceReportSection datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

focusReference? Reference - A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title.

emptyReason? CodeableConcept - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

author? Reference[] - Identifies who is responsible for the information in this section, not necessarily who typed it in.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

entryClassifier? CodeableConcept[] - Specifies any type of classification of the evidence report.

focus? CodeableConcept - A code identifying the kind of content contained within the section. This should be consistent with the section title.

entryQuantity? Quantity[] - Quantity as content.

title? string - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

mode? EvidenceReportSectionMode - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? Narrative - A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrative.

entryReference? Reference[] - A reference to the actual resource from which the narrative in the section is derived.

health.fhir.r5.international500: EvidenceReportSubject

Closed record

FHIR EvidenceReportSubject datatype record.

Fields

note? Annotation[] - Used for general notes and annotations not coded elsewhere.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

characteristic? EvidenceReportSubjectCharacteristic[] - Characteristic.

health.fhir.r5.international500: EvidenceReportSubjectCharacteristic

Closed record

FHIR EvidenceReportSubjectCharacteristic datatype record.

Fields

valueEvidenceReportQuantity Quantity - Characteristic value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Timeframe for the characteristic.

code CodeableConcept - Characteristic code.

valueEvidenceReportCodeableConcept CodeableConcept - Characteristic value.

valueEvidenceReportReference Reference - Characteristic value.

valueEvidenceReportRange Range - Characteristic value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

exclude? boolean - Is used to express not the characteristic.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueEvidenceReportBoolean boolean - Characteristic value.

health.fhir.r5.international500: EvidenceStatistic

Closed record

FHIR EvidenceStatistic datatype record.

Fields

note? Annotation[] - Footnotes and/or explanatory notes.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - Statistic value.

modelCharacteristic? EvidenceStatisticModelCharacteristic[] - A component of the method to generate the statistic.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 description of the content value of the statistic.

sampleSize? EvidenceStatisticSampleSize - Number of samples in the statistic.

numberOfEvents? unsignedInt - The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.

statisticType? CodeableConcept - Type of statistic, e.g., relative risk.

numberAffected? unsignedInt - The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.

attributeEstimate? EvidenceStatisticAttributeEstimate[] - A statistical attribute of the statistic such as a measure of heterogeneity.

health.fhir.r5.international500: EvidenceStatisticAttributeEstimate

Closed record

FHIR EvidenceStatisticAttributeEstimate datatype record.

Fields

note? Annotation[] - Footnote or explanatory note about the estimate.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure.

level? decimal - Use 95 for a 95% confidence interval.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Human-readable summary of the estimate.

range? Range - Lower bound of confidence interval.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The type of attribute estimate, e.g., confidence interval or p value.

health.fhir.r5.international500: EvidenceStatisticModelCharacteristic

Closed record

FHIR EvidenceStatisticModelCharacteristic datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Description of a component of the method to generate the statistic.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

variable? EvidenceStatisticModelCharacteristicVariable[] - A variable adjusted for in the adjusted analysis.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value? Quantity - Further specification of the quantified value of the component of the method to generate the statistic.

health.fhir.r5.international500: EvidenceStatisticModelCharacteristicVariable

Closed record

FHIR EvidenceStatisticModelCharacteristicVariable datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueCategory? CodeableConcept[] - Description for grouping of ordinal or polychotomous variables.

valueRange? Range[] - Range of values for grouping of ordinal or polychotomous variables.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

variableDefinition Reference - Description of the variable.

handling? EvidenceStatisticModelCharacteristicVariableHandling - How the variable is classified for use in adjusted analysis.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity? Quantity[] - Discrete value for grouping of ordinal or polychotomous variables.

health.fhir.r5.international500: EvidenceStatisticSampleSize

Closed record

FHIR EvidenceStatisticSampleSize datatype record.

Fields

numberOfParticipants? unsignedInt - A human-readable string to clarify or explain concepts about the sample size.

note? Annotation[] - Footnote or explanatory note about the sample size.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

knownDataCount? unsignedInt - Number of participants with known results for measured variables.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Human-readable summary of population sample size.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

numberOfStudies? unsignedInt - Number of participants in the population.

health.fhir.r5.international500: EvidenceVariable

FHIR EvidenceVariable resource record.

Fields

resourceType RESOURCE_NAME_EVIDENCEVARIABLE(default RESOURCE_NAME_EVIDENCEVARIABLE) - The type of the resource describes

date? dateTime - The date (and optionally time) when the evidence variable was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.

note? Annotation[] - A human-readable string to clarify or explain concepts about the resource.

copyright? markdown - A copyright statement relating to the resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resource.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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. See guidance around (not) making local changes to elements here.

purpose? markdown - Explanation of why this EvidenceVariable is needed and why it has been designed as it has.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A free text natural language description of the evidence variable from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

shortTitle? string - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

title? string - A short, descriptive, user-friendly title for the evidence variable.

characteristic? EvidenceVariableCharacteristic[] - A defining factor of the EvidenceVariable. Multiple characteristics are applied with 'and' semantics.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

actual? boolean - True if the actual variable measured, false if a conceptual representation of the intended variable.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the resource content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

'version? string - The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url? uri - An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable.

handling? EvidenceVariableHandling - The method of handling in statistical analysis.

category? EvidenceVariableCategory[] - A grouping for ordinal or polychotomous variables.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances.

status EvidenceVariableStatus - The status of this evidence variable. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: EvidenceVariableCategory

Closed record

FHIR EvidenceVariableCategory datatype record.

Fields

valueCodeableConcept? CodeableConcept - Definition of the grouping.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueRange? Range - Definition of the grouping.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Description of the grouping.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity? Quantity - Definition of the grouping.

health.fhir.r5.international500: EvidenceVariableCharacteristic

Closed record

FHIR EvidenceVariableCharacteristic datatype record.

Fields

definitionCodeableConcept? CodeableConcept - Defines the characteristic using CodeableConcept.

note? Annotation[] - A human-readable string to clarify or explain concepts about the characteristic.

definitionCanonical? canonical - Defines the characteristic using Canonical.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

durationQuantity? Quantity - Length of time in which the characteristic is met.

instancesQuantity? Quantity - Number of occurrences meeting the characteristic.

definitionReference? Reference - Defines the characteristic using a Reference.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

definitionByTypeAndValue? EvidenceVariableCharacteristicDefinitionByTypeAndValue - Defines the characteristic using both a type and value[x] elements.

timeFromEvent? EvidenceVariableCharacteristicTimeFromEvent[] - Timing in which the characteristic is determined.

durationRange? Range - Length of time in which the characteristic is met.

definitionByCombination? EvidenceVariableCharacteristicDefinitionByCombination - Defines the characteristic as a combination of two or more characteristics.

linkId? id - Label used for when a characteristic refers to another characteristic.

definitionExpression? Expression - Defines the characteristic using Expression.

instancesRange? Range - Number of occurrences meeting the characteristic.

exclude? boolean - When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterion.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

definitionId? id - Defines the characteristic using id.

health.fhir.r5.international500: EvidenceVariableCharacteristicDefinitionByCombination

Closed record

FHIR EvidenceVariableCharacteristicDefinitionByCombination datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 EvidenceVariableCharacteristicDefinitionByCombinationCode - Used to specify if two or more characteristics are combined with OR or AND.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

threshold? positiveInt - Provides the value of 'n' when 'at-least' or 'at-most' codes are 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.r5.international500: EvidenceVariableCharacteristicDefinitionByTypeAndValue

Closed record

FHIR EvidenceVariableCharacteristicDefinitionByTypeAndValue datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

method? CodeableConcept[] - Method for how the characteristic value was determined.

offset? CodeableConcept - Defines the reference point for comparison when valueQuantity or valueRange is not compared to zero.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueEvidenceVariableBoolean boolean - Defines the characteristic when paired with characteristic.type.

'type CodeableConcept - Used to express the type of characteristic.

valueEvidenceVariableReference Reference - Defines the characteristic when paired with characteristic.type.

valueEvidenceVariableId id - Defines the characteristic when paired with characteristic.type.

valueEvidenceVariableQuantity Quantity - Defines the characteristic when paired with characteristic.type.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueEvidenceVariableCodeableConcept CodeableConcept - Defines the characteristic when paired with characteristic.type.

valueEvidenceVariableRange Range - Defines the characteristic when paired with characteristic.type.

device? Reference - Device used for determining characteristic.

health.fhir.r5.international500: EvidenceVariableCharacteristicTimeFromEvent

Closed record

FHIR EvidenceVariableCharacteristicTimeFromEvent datatype record.

Fields

note? Annotation[] - A human-readable string to clarify or explain concepts about the timeFromEvent.

eventEvidenceVariableReference? Reference - The event used as a base point (reference point) in time.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

eventEvidenceVariableId? id - The event used as a base point (reference point) in time.

quantity? Quantity - Used to express the observation at a defined amount of time before or after the 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Human readable description.

eventEvidenceVariableDateTime? dateTime - The event used as a base point (reference point) in time.

range? Range - Used to express the observation within a period before and/or after the event.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

eventEvidenceVariableCodeableConcept? CodeableConcept - The event used as a base point (reference point) in time.

health.fhir.r5.international500: EvidenceVariableDefinition

Closed record

FHIR EvidenceVariableDefinition datatype record.

Fields

note? Annotation[] - Footnotes and/or explanatory notes.

directnessMatch? CodeableConcept - Indication of quality of match between intended variable to actual variable.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

variableRole CodeableConcept - population | subpopulation | exposure | referenceExposure | measuredVariable | confounder.

intended? Reference - Definition of the intended variable related to the Evidence.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 text description or summary of the variable.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

observed? Reference - Definition of the actual variable related to the statistic(s).

health.fhir.r5.international500: ExampleLipidProfile

FHIR ExampleLipidProfile resource record.

Fields

resourceType RESOURCE_NAME_EXAMPLELIPIDPROFILE(default RESOURCE_NAME_EXAMPLELIPIDPROFILE) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

valueTime? time - The information determined as a result of making the observation, if the information has a simple value.

subject? Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity? Quantity - Triglyceride value. If a result is not available, use the comments field.

identifier? Identifier[] - A unique identifier assigned to this observation.

effectivePeriod? Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

effectiveTiming? Timing - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

referenceRange ExampleLipidProfileReferenceRangeThree[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

interpretation? CodeableConcept[] -
- | ++ | +++ | - | -- | ---.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ExampleLipidProfileStatusFour - The status of the result value.

valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.

note? Annotation[] - Comments about result.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ExampleLipidProfileCodeOne - Triglyceride.

valueReference? Reference - The information determined as a result of making the observation, if the information has a simple value.

valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.

valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.

valueAttachment? Attachment - The information determined as a result of making the observation, if the information has a simple value.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? ExampleLipidProfileComponentThree[] - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

valueString? string - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime? dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

category? CodeableConcept[] - A code that classifies the general type of observation being made.

effectiveInstant? instant - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

triggeredBy? ExampleLipidProfileTriggeredByThree[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: ExampleLipidProfileCodeCodingOne

Closed record

FHIR ExampleLipidProfileCodeCodingOne datatype record.

Fields

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "35217-9") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display string(default "Triglyceride [Moles/volume] in Serum or Plasma") - A representation of the meaning of the code in the system, following the rules of the system.

health.fhir.r5.international500: ExampleLipidProfileCodeOne

Closed record

FHIR ExampleLipidProfileCodeOne datatype record.

Fields

coding ExampleLipidProfileCodeCodingOne[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: ExampleLipidProfileComponentThree

Closed record

FHIR ExampleLipidProfileComponentThree datatype record.

Fields

valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - The information determined as a result of making the observation, if the information has a simple value.

valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.

valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.

valueAttachment? Attachment - The information determined as a result of making the observation, if the information has a simple value.

valueString? string - The information determined as a result of making the observation, if the information has a simple value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r5.international500: ExampleLipidProfileReferenceRangeThree

Closed record

FHIR ExampleLipidProfileReferenceRangeThree datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

high Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? markdown - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

normalValue? CodeableConcept - The value of the normal value of the reference range.

age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r5.international500: ExampleLipidProfileTriggeredByThree

Closed record

FHIR ExampleLipidProfileTriggeredByThree datatype record.

Fields

reason? string - Provides the reason why this observation was performed as a result of the observation(s) referenced.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

observation Reference - Reference to the triggering observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ExampleLipidProfileTriggeredByTypeThree - The type of trigger. Reflex | Repeat | Re-run.

health.fhir.r5.international500: ExampleScenario

FHIR ExampleScenario resource record.

Fields

resourceType RESOURCE_NAME_EXAMPLESCENARIO(default RESOURCE_NAME_EXAMPLESCENARIO) - The type of the resource describes

date? dateTime - The date (and optionally time) when the example scenario was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').

copyright? markdown - A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

instance? ExampleScenarioInstance[] - A single data collection that is shared as part of the scenario.

purpose? markdown - What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the example scenario is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 ExampleScenario from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the ExampleScenario.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.

process? ExampleScenarioProcess[] - A group of operations that represents a significant step within a scenario.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

'version? string - The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url? uri - An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.

actor? ExampleScenarioActor[] - A system or person who shares or receives an instance within the scenario.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

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 - Temporarily retained for tooling purposes.

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 responsible for the release and ongoing maintenance of the example scenario.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances.

status ExampleScenarioStatus - The status of this example scenario. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ExampleScenarioActor

Closed record

FHIR ExampleScenarioActor datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - An explanation of who/what the actor is and its role in the scenario.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - The human-readable name for the actor used when rendering the scenario.

'type ExampleScenarioActorType - The category of actor - person or system.

key string - A unique string within the scenario that is used to reference the actor.

health.fhir.r5.international500: ExampleScenarioInstance

Closed record

FHIR ExampleScenarioInstance datatype record.

Fields

structureProfileCanonical? canonical - Refers to a profile, template or other ruleset the instance adheres to.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

structureProfileUri? uri - Refers to a profile, template or other ruleset the instance adheres to.

description? markdown - An explanation of what the instance contains and what it's for.

containedInstance? ExampleScenarioInstanceContainedInstance[] - References to other instances that can be found within this instance (e.g. the observations contained in a bundle).

title string - A short descriptive label the instance to be used in tables or diagrams.

'version? ExampleScenarioInstanceVersion[] - Represents the instance as it was at a specific time-point.

content? Reference - Points to an instance (typically an example) that shows the data that would corespond to this instance.

structureType Coding - A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

key string - A unique string within the scenario that is used to reference the instance.

structureVersion? string - Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

health.fhir.r5.international500: ExampleScenarioInstanceContainedInstance

Closed record

FHIR ExampleScenarioInstanceContainedInstance datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

instanceReference string - A reference to the key of an instance found within this one.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

versionReference? string - A reference to the key of a specific version of an instance in this instance.

health.fhir.r5.international500: ExampleScenarioInstanceVersion

Closed record

FHIR ExampleScenarioInstanceVersion datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - An explanation of what this specific version of the instance contains and represents.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - A short descriptive label the version to be used in tables or diagrams.

content? Reference - Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.

key string - A unique string within the instance that is used to reference the version of the instance.

health.fhir.r5.international500: ExampleScenarioProcess

Closed record

FHIR ExampleScenarioProcess datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

postConditions? markdown - Description of the final state of the actors, environment and data after the process has been successfully completed.

preConditions? markdown - Description of the initial state of the actors, environment and data before the process starts.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - An explanation of what the process represents and what it does.

step? ExampleScenarioProcessStep[] - A significant action that occurs as part of the process.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - A short descriptive label the process to be used in tables or diagrams.

health.fhir.r5.international500: ExampleScenarioProcessStep

Closed record

FHIR ExampleScenarioProcessStep datatype record.

Fields

number? string - The sequential number of the step, e.g. 1.2.5.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

workflow? canonical - Indicates that the step is defined by a seaparate scenario instance.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

alternative? ExampleScenarioProcessStepAlternative[] - Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

operation? ExampleScenarioProcessStepOperation - The step represents a single operation invoked on receiver by sender.

pause? boolean - If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).

health.fhir.r5.international500: ExampleScenarioProcessStepAlternative

Closed record

FHIR ExampleScenarioProcessStepAlternative datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A human-readable description of the alternative explaining when the alternative should occur rather than the base step.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.

health.fhir.r5.international500: ExampleScenarioProcessStepOperation

Closed record

FHIR ExampleScenarioProcessStepOperation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

receiver? string - The system on which the action is invoked/receives the data.

initiator? string - The system that invokes the action/transmits the data.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - An explanation of what the operation represents and what it does.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

receiverActive? boolean - If false, the receiver is deactivated right after the operation.

title string - A short descriptive label the step to be used in tables or diagrams.

'type? Coding - The standardized type of action (FHIR or otherwise).

initiatorActive? boolean - If false, the initiator is deactivated right after the operation.

health.fhir.r5.international500: ExplanationOfBenefit

FHIR ExplanationOfBenefit resource record.

Fields

resourceType RESOURCE_NAME_EXPLANATIONOFBENEFIT(default RESOURCE_NAME_EXPLANATIONOFBENEFIT) - The type of the resource describes

benefitPeriod? Period - The term of the benefits documented in this response.

insurance? ExplanationOfBenefitInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.

claimResponse? Reference - The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

use ExplanationOfBenefitUse - A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

preAuthRef? string[] - Reference from the Insurer which is used in later communications which refers to this adjudication.

language? code - The base language in which the resource is written.

diagnosisRelatedGroup? CodeableConcept - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

'type CodeableConcept - The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

precedence? positiveInt - This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

processNote? ExplanationOfBenefitProcessNote[] - A note that describes or explains adjudication results in a human readable form.

payee? ExplanationOfBenefitPayee - The party to be reimbursed for cost of the products and services according to the terms of the policy.

supportingInfo? ExplanationOfBenefitSupportingInfo[] - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

claim? Reference - The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.

enterer? Reference - Individual who created the claim, predetermination or preauthorization.

payment? ExplanationOfBenefitPayment - Payment details for the adjudication of the claim.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

careTeam? ExplanationOfBenefitCareTeam[] - The members of the team who provided the products and services.

identifier? Identifier[] - A unique identifier assigned to this explanation of benefit.

item? ExplanationOfBenefitItem[] - A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

created dateTime - The date this resource was created.

diagnosis? ExplanationOfBenefitDiagnosis[] - Information about diagnoses relevant to the claim items.

priority? CodeableConcept - The provider-required urgency of processing the request. Typical values include: stat, normal deferred.

preAuthRefPeriod? Period[] - The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

billablePeriod? Period - The period for which charges are being submitted.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType? CodeableConcept - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

status ExplanationOfBenefitStatus - The status of the resource instance.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

benefitBalance? ExplanationOfBenefitBenefitBalance[] - Balance by Benefit Category.

accident? ExplanationOfBenefitAccident - Details of a accident which resulted in injuries which required the products and services listed in the claim.

addItem? ExplanationOfBenefitAddItem[] - The first-tier service adjudications for payor added product or service lines.

total? ExplanationOfBenefitTotal[] - Categorized monetary totals for the adjudication.

fundsReserve? CodeableConcept - A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

fundsReserveRequested? CodeableConcept - A code to indicate whether and for whom funds are to be reserved for future claims.

provider? Reference - The provider which is responsible for the claim, predetermination or preauthorization.

insurer? Reference - The party responsible for authorization, adjudication and reimbursement.

patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.

event? ExplanationOfBenefitEvent[] - Information code for an event with a corresponding date or period.

outcome ExplanationOfBenefitOutcome - The outcome of the claim, predetermination, or preauthorization processing.

decision? CodeableConcept - The result of the claim, predetermination, or preauthorization adjudication.

formCode? CodeableConcept - A code for the form to be used for printing the content.

encounter? Reference[] - Healthcare encounters related to this claim.

originalPrescription? Reference - Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

procedure? ExplanationOfBenefitProcedure[] - Procedures performed on the patient relevant to the billing items with the claim.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

disposition? string - A human readable description of the status of the adjudication.

referral? Reference - The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.

form? Attachment - The actual form, by reference or inclusion, for printing the content or an EOB.

prescription? Reference - Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.

facility? Reference - Facility where the services were provided.

Element... - Rest field

health.fhir.r5.international500: ExplanationOfBenefitAccident

Closed record

FHIR ExplanationOfBenefitAccident datatype record.

Fields

date? date - Date of an accident event related to the products and services contained in the claim.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationAddress? Address - The physical location of the accident event.

locationReference? Reference - The physical location of the accident event.

'type? CodeableConcept - The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

health.fhir.r5.international500: ExplanationOfBenefitAddItem

Closed record

FHIR ExplanationOfBenefitAddItem datatype record.

Fields

request? Reference[] - Request or Referral for Goods or Service to be rendered.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

locationAddress? Address - Where the product or service was provided.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

servicedPeriod? Period - The date or dates when the service or product was supplied, performed or completed.

subDetailSequence? positiveInt[] - The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.

itemSequence? positiveInt[] - Claim items which this service line is intended to replace.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

locationCodeableConcept? CodeableConcept - Where the product or service was provided.

provider? Reference[] - The providers who are authorized for the services rendered to the patient.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference? Reference - Where the product or service was provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

tax? Money - The total of taxes applicable for this product or service.

bodySite? ExplanationOfBenefitAddItemBodySite[] - Physical location where the service is performed or applies.

detailSequence? positiveInt[] - The sequence number of the details within the claim item which this line is intended to replace.

detail? ExplanationOfBenefitAddItemDetail[] - The second-tier service adjudications for payor added services.

servicedDate? date - The date or dates when the service or product was supplied, performed or completed.

health.fhir.r5.international500: ExplanationOfBenefitAddItemBodySite

Closed record

FHIR ExplanationOfBenefitAddItemBodySite datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference[] - Physical service site on the patient (limb, tooth, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subSite? CodeableConcept[] - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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.r5.international500: ExplanationOfBenefitAddItemDetail

Closed record

FHIR ExplanationOfBenefitAddItemDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subDetail? ExplanationOfBenefitAddItemDetailSubDetail[] - The third-tier service adjudications for payor added services.

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ExplanationOfBenefitAddItemDetailSubDetail

Closed record

FHIR ExplanationOfBenefitAddItemDetailSubDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ExplanationOfBenefitBenefitBalance

Closed record

FHIR ExplanationOfBenefitBenefitBalance datatype record.

Fields

excluded? boolean - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unit? CodeableConcept - Indicates if the benefits apply to an individual or to the family.

financial? ExplanationOfBenefitBenefitBalanceFinancial[] - Benefits Used to date.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name? string - A short name or tag for the benefit.

description? string - A richer description of the benefit or services covered.

term? CodeableConcept - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

network? CodeableConcept - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

health.fhir.r5.international500: ExplanationOfBenefitBenefitBalanceFinancial

Closed record

FHIR ExplanationOfBenefitBenefitBalanceFinancial datatype record.

Fields

allowedExplanationOfBenefitMoney? Money - The quantity of the benefit which is permitted under the coverage.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

allowedExplanationOfBenefitUnsignedInt? unsignedInt - The quantity of the benefit which is permitted under the coverage.

allowedExplanationOfBenefitString? string - The quantity of the benefit which is permitted under the coverage.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

usedExplanationOfBenefitUnsignedInt? unsignedInt - The quantity of the benefit which have been consumed to date.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

usedExplanationOfBenefitMoney? Money - The quantity of the benefit which have been consumed to date.

'type CodeableConcept - Classification of benefit being provided.

health.fhir.r5.international500: ExplanationOfBenefitCareTeam

Closed record

FHIR ExplanationOfBenefitCareTeam datatype record.

Fields

sequence positiveInt - A number to uniquely identify care team entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 specialization of the practitioner or provider which is applicable for this service.

role? CodeableConcept - The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

provider Reference - Member of the team who provided the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

responsible? boolean - The party who is billing and/or responsible for the claimed products or services.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ExplanationOfBenefitDiagnosis

Closed record

FHIR ExplanationOfBenefitDiagnosis datatype record.

Fields

sequence positiveInt - A number to uniquely identify diagnosis entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

onAdmission? CodeableConcept - Indication of whether the diagnosis was present on admission to a facility.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept[] - When the condition was observed or the relative ranking.

diagnosisReference Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

diagnosisCodeableConcept CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

health.fhir.r5.international500: ExplanationOfBenefitEvent

Closed record

FHIR ExplanationOfBenefitEvent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

whenDateTime dateTime - A date or period in the past or future indicating when the event occurred or is expectd to occur.

whenPeriod Period - A date or period in the past or future indicating when the event occurred or is expectd to occur.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - A coded event such as when a service is expected or a card printed.

health.fhir.r5.international500: ExplanationOfBenefitInsurance

Closed record

FHIR ExplanationOfBenefitInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

preAuthRef? string[] - Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ExplanationOfBenefitItem

Closed record

FHIR ExplanationOfBenefitItem datatype record.

Fields

request? Reference[] - Request or Referral for Goods or Service to be rendered.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

locationAddress? Address - Where the product or service was provided.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

servicedPeriod? Period - The date or dates when the service or product was supplied, performed or completed.

adjudication? ExplanationOfBenefitItemAdjudication[] - If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

informationSequence? positiveInt[] - Exceptions, special conditions and supporting information applicable for this service or product.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

locationCodeableConcept? CodeableConcept - Where the product or service was provided.

diagnosisSequence? positiveInt[] - Diagnoses applicable for this service or product.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference? Reference - Where the product or service was provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

careTeamSequence? positiveInt[] - Care team members related to this service or product.

tax? Money - The total of taxes applicable for this product or service.

encounter? Reference[] - Healthcare encounters related to this claim.

sequence positiveInt - A number to uniquely identify item entries.

bodySite? ExplanationOfBenefitItemBodySite[] - Physical location where the service is performed or applies.

reviewOutcome? ExplanationOfBenefitItemReviewOutcome - The high-level results of the adjudication if adjudication has been performed.

detail? ExplanationOfBenefitItemDetail[] - Second-tier of goods and services.

servicedDate? date - The date or dates when the service or product was supplied, performed or completed.

udi? Reference[] - Unique Device Identifiers associated with this line item.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

procedureSequence? positiveInt[] - Procedures applicable for this service or product.

health.fhir.r5.international500: ExplanationOfBenefitItemAdjudication

Closed record

FHIR ExplanationOfBenefitItemAdjudication datatype record.

Fields

reason? CodeableConcept - A code supporting the understanding of the adjudication result and explaining variance from expected amount.

amount? Money - Monetary amount associated with the category.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - A non-monetary value associated with the category. Mutually exclusive to the amount element above.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

health.fhir.r5.international500: ExplanationOfBenefitItemBodySite

Closed record

FHIR ExplanationOfBenefitItemBodySite datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference[] - Physical service site on the patient (limb, tooth, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subSite? CodeableConcept[] - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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.r5.international500: ExplanationOfBenefitItemDetail

Closed record

FHIR ExplanationOfBenefitItemDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subDetail? ExplanationOfBenefitItemDetailSubDetail[] - Third-tier of goods and services.

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

sequence positiveInt - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi? Reference[] - Unique Device Identifiers associated with this line item.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ExplanationOfBenefitItemDetailSubDetail

Closed record

FHIR ExplanationOfBenefitItemDetailSubDetail datatype record.

Fields

unitPrice? Money - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientPaid? Money - The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity? Quantity - The number of repetitions of a service or product.

productOrServiceEnd? CodeableConcept - This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

traceNumber? Identifier[] - Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

programCode? CodeableConcept[] - Identifies the program under which this may be recovered.

modifier? CodeableConcept[] - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

tax? Money - The total of taxes applicable for this product or service.

productOrService? CodeableConcept - When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

noteNumber? positiveInt[] - The numbers associated with notes below which apply to the adjudication of this item.

sequence positiveInt - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

revenue? CodeableConcept - The type of revenue or cost center providing the product and/or service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi? Reference[] - Unique Device Identifiers associated with this line item.

category? CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

factor? decimal - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net? Money - The total amount claimed for the line item.detail.subDetail. Net = unit price * quantity * factor.

health.fhir.r5.international500: ExplanationOfBenefitItemReviewOutcome

Closed record

FHIR ExplanationOfBenefitItemReviewOutcome datatype record.

Fields

reason? CodeableConcept[] - The reasons for the result of the claim, predetermination, or preauthorization adjudication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

preAuthPeriod? Period - The time frame during which this authorization is effective.

decision? CodeableConcept - The result of the claim, predetermination, or preauthorization adjudication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

preAuthRef? string - Reference from the Insurer which is used in later communications which refers to this adjudication.

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.r5.international500: ExplanationOfBenefitPayee

Closed record

FHIR ExplanationOfBenefitPayee datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Type of Party to be reimbursed: Subscriber, provider, other.

party? Reference - Reference to the individual or organization to whom any payment will be made.

health.fhir.r5.international500: ExplanationOfBenefitPayment

Closed record

FHIR ExplanationOfBenefitPayment datatype record.

Fields

date? date - Estimated date the payment will be issued or the actual issue date of payment.

identifier? Identifier - Issuer's unique identifier for the payment instrument.

adjustmentReason? CodeableConcept - Reason for the payment adjustment.

amount? Money - Benefits payable less any payment adjustment.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

adjustment? Money - Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Whether this represents partial or complete payment of the benefits payable.

health.fhir.r5.international500: ExplanationOfBenefitProcedure

Closed record

FHIR ExplanationOfBenefitProcedure datatype record.

Fields

date? dateTime - Date and optionally time the procedure was performed.

sequence positiveInt - A number to uniquely identify procedure entries.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

procedureCodeableConcept CodeableConcept - The code or reference to a Procedure resource which identifies the clinical intervention performed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

procedureReference Reference - The code or reference to a Procedure resource which identifies the clinical intervention performed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi? Reference[] - Unique Device Identifiers associated with this line item.

'type? CodeableConcept[] - When the condition was observed or the relative ranking.

health.fhir.r5.international500: ExplanationOfBenefitProcessNote

Closed record

FHIR ExplanationOfBenefitProcessNote datatype record.

Fields

number? positiveInt - A number to uniquely identify a note entry.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? CodeableConcept - A code to define the language used in the text of the note.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - The explanation or description associated with the processing.

'type? CodeableConcept - The business purpose of the note text.

health.fhir.r5.international500: ExplanationOfBenefitRelated

Closed record

FHIR ExplanationOfBenefitRelated datatype record.

Fields

reference? Identifier - An alternate organizational reference to the case or file to which this particular claim pertains.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

claim? Reference - Reference to a related claim.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship? CodeableConcept - A code to convey how the claims are related.

health.fhir.r5.international500: ExplanationOfBenefitSupportingInfo

Closed record

FHIR ExplanationOfBenefitSupportingInfo datatype record.

Fields

valueBoolean? boolean - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

reason? Coding - Provides the reason in the situation where a reason code is required in addition to the content.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueIdentifier? Identifier - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

code? CodeableConcept - System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

valueReference? Reference - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

timingPeriod? Period - The date when or period to which this information refers.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

timingDate? date - The date when or period to which this information refers.

sequence positiveInt - A number to uniquely identify supporting information entries.

valueAttachment? Attachment - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

valueString? string - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - The general class of the information supplied: information; exception; accident, employment; onset, etc.

valueQuantity? Quantity - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

health.fhir.r5.international500: ExplanationOfBenefitTotal

Closed record

FHIR ExplanationOfBenefitTotal datatype record.

Fields

amount Money - Monetary total amount associated with the category.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

health.fhir.r5.international500: FamilyMemberHistory

FHIR FamilyMemberHistory resource record.

Fields

resourceType RESOURCE_NAME_FAMILYMEMBERHISTORY(default RESOURCE_NAME_FAMILYMEMBERHISTORY) - The type of the resource describes

ageRange? Range - The age of the relative at the time the family member history is recorded.

date? dateTime - The date (and possibly time) when the family member history was recorded or last updated.

dataAbsentReason? CodeableConcept - Describes why the family member's history is not available.

note? Annotation[] - This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

reason? CodeableReference[] - Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, 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.

bornString? string - The actual or approximate date of birth of the relative.

instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

participant? FamilyMemberHistoryParticipant[] - Indicates who or what participated in the activities related to the family member history and how they were involved.

estimatedAge? boolean - If true, indicates that the age value specified is an estimated value.

patient Reference - The person who this history concerns.

deceasedRange? Range - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relationship CodeableConcept - The type of relationship this person has to the patient (father, mother, brother etc.).

ageAge? Age - The age of the relative at the time the family member history is recorded.

identifier? Identifier[] - Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

ageString? string - The age of the relative at the time the family member history is recorded.

sex? CodeableConcept - The birth sex of the family member.

bornDate? date - The actual or approximate date of birth of the relative.

procedure? FamilyMemberHistoryProcedure[] - The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.

instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

bornPeriod? Period - The actual or approximate date of birth of the relative.

condition? FamilyMemberHistoryCondition[] - The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

deceasedBoolean? boolean - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

deceasedString? string - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - This will either be a name or a description; e.g. 'Aunt Susan', 'my cousin with the red hair'.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

deceasedDate? date - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

deceasedAge? Age - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

status FamilyMemberHistoryStatus - A code specifying the status of the record of the family history of a specific family member.

Element... - Rest field

health.fhir.r5.international500: FamilyMemberHistoryCondition

Closed record

FHIR FamilyMemberHistoryCondition datatype record.

Fields

contributedToDeath? boolean - This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

note? Annotation[] - An area where general notes can be placed about this specific condition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.

onsetPeriod? Period - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

onsetRange? Range - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

onsetString? string - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

onsetAge? Age - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

outcome? CodeableConcept - Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

health.fhir.r5.international500: FamilyMemberHistoryForGeneticsAnalysis

FHIR FamilyMemberHistoryForGeneticsAnalysis resource record.

Fields

resourceType RESOURCE_NAME_FAMILYMEMBERHISTORYFORGENETICSANALYSIS(default RESOURCE_NAME_FAMILYMEMBERHISTORYFORGENETICSANALYSIS) - The type of the resource describes

ageRange? Range - The age of the relative at the time the family member history is recorded.

date? dateTime - The date (and possibly time) when the family member history was recorded or last updated.

dataAbsentReason? CodeableConcept - Describes why the family member's history is not available.

note? Annotation[] - This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

reason? CodeableReference[] - Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

extension? Extension[] - An 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 managable, 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.

bornString? string - The actual or approximate date of birth of the relative.

instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

participant? FamilyMemberHistoryForGeneticsAnalysisParticipant[] - Indicates who or what participated in the activities related to the family member history and how they were involved.

estimatedAge? boolean - If true, indicates that the age value specified is an estimated value.

patient Reference - The person who this history concerns.

deceasedRange? Range - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relationship CodeableConcept - The type of relationship this person has to the patient (father, mother, brother etc.).

ageAge? Age - The age of the relative at the time the family member history is recorded.

identifier? Identifier[] - Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

ageString? string - The age of the relative at the time the family member history is recorded.

sex? CodeableConcept - The birth sex of the family member.

bornDate? date - The actual or approximate date of birth of the relative.

procedure? FamilyMemberHistoryForGeneticsAnalysisProcedure[] - The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.

instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

bornPeriod? Period - The actual or approximate date of birth of the relative.

condition? FamilyMemberHistoryForGeneticsAnalysisCondition[] - The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

deceasedBoolean? boolean - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

deceasedString? string - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - This will either be a name or a description; e.g. 'Aunt Susan', 'my cousin with the red hair'.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

deceasedDate? date - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

deceasedAge? Age - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

status FamilyMemberHistoryForGeneticsAnalysisStatus - A code specifying the status of the record of the family history of a specific family member.

Element... - Rest field

health.fhir.r5.international500: FamilyMemberHistoryForGeneticsAnalysisCondition

Closed record

FHIR FamilyMemberHistoryForGeneticsAnalysisCondition datatype record.

Fields

contributedToDeath? boolean - This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

note? Annotation[] - An area where general notes can be placed about this specific condition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.

onsetPeriod? Period - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

onsetRange? Range - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

onsetString? string - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

onsetAge? Age - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

outcome? CodeableConcept - Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

health.fhir.r5.international500: FamilyMemberHistoryForGeneticsAnalysisParticipant

Closed record

FHIR FamilyMemberHistoryForGeneticsAnalysisParticipant datatype record.

Fields

actor Reference - Indicates who or what participated in the activities related to the family member history.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the actor in the activities related to the family member history.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: FamilyMemberHistoryForGeneticsAnalysisProcedure

Closed record

FHIR FamilyMemberHistoryForGeneticsAnalysisProcedure datatype record.

Fields

performedString? string - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

contributedToDeath? boolean - This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

note? Annotation[] - An area where general notes can be placed about this specific procedure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

performedRange? Range - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedDateTime? dateTime - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedAge? Age - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

outcome? CodeableConcept - Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.

performedPeriod? Period - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

health.fhir.r5.international500: FamilyMemberHistoryParticipant

Closed record

FHIR FamilyMemberHistoryParticipant datatype record.

Fields

actor Reference - Indicates who or what participated in the activities related to the family member history.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the actor in the activities related to the family member history.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: FamilyMemberHistoryProcedure

Closed record

FHIR FamilyMemberHistoryProcedure datatype record.

Fields

performedString? string - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

contributedToDeath? boolean - This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

note? Annotation[] - An area where general notes can be placed about this specific procedure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

performedRange? Range - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedDateTime? dateTime - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedAge? Age - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

outcome? CodeableConcept - Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.

performedPeriod? Period - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

health.fhir.r5.international500: FHIRPathLibrary

FHIR FHIRPathLibrary resource record.

Fields

resourceType RESOURCE_NAME_FHIRPATHLIBRARY(default RESOURCE_NAME_FHIRPATHLIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

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 managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

description markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

'type FHIRPathLibraryType - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

title string - A short, descriptive, user-friendly title for the library.

content? FHIRPathLibraryContent[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
- content Slicings
1. FHIRPathLibraryContentFhirPathContent: FHIRPath Content
- min = 1
- max = *

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.
- relatedArtifact Slicings
1. FHIRPathLibraryRelatedArtifactDependency: Additional documentation, citations, etc
- min = 0
- max = *

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

'version string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

url uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status FHIRPathLibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: FHIRPathLibraryContent

Closed record

FHIR FHIRPathLibraryContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data? base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType? code - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: FHIRPathLibraryContentFhirPathContent

Closed record

FHIR FHIRPathLibraryContentFhirPathContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id string - The id of the FHIRPath expression. This id allows the expressions of the library to be referenced.

contentType code(default "text/fhirpath") - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: FHIRPathLibraryRelatedArtifactDependency

Closed record

FHIR FHIRPathLibraryRelatedArtifactDependency datatype record.

Fields

publicationStatus? FHIRPathLibraryRelatedArtifactPublicationStatus - The publication status of the artifact being referred to.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

citation? markdown - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

'resource canonical - The related artifact, such as a library, value set, profile, or other knowledge resource.

display? string - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document? Attachment - The document being referenced, represented as an attachment. This is exclusive with the resource element.

classifier? CodeableConcept[] - Provides additional classifiers of the related artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

label? string - A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

'type FHIRPathLibraryRelatedArtifactType(default "depends-on") - The type of relationship to the related artifact.

publicationDate? date - The date of publication of the artifact being referred to.

resourceReference? Reference - The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

health.fhir.r5.international500: FHIRPathLibraryType

Closed record

FHIR FHIRPathLibraryType datatype record.

Fields

coding FHIRPathLibraryTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: FHIRPathLibraryTypeCoding

Closed record

FHIR FHIRPathLibraryTypeCoding datatype record.

Fields

system uri(default "http://terminology.hl7.org/CodeSystem/library-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "module-definition") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r5.international500: Flag

FHIR Flag resource record.

Fields

resourceType RESOURCE_NAME_FLAG(default RESOURCE_NAME_FLAG) - The type of the resource describes

identifier? Identifier[] - Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

code CodeableConcept - The coded value or textual component of the flag to display to the user.

author? Reference - The person, organization or device that created the flag.

subject Reference - The patient, related person, location, group, organization, or practitioner etc. this is about record this flag is associated with.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

encounter? Reference - This alert is only relevant during the encounter.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

status FlagStatus - Supports basic workflow.

Element... - Rest field

health.fhir.r5.international500: FormularyItem

FHIR FormularyItem resource record.

Fields

resourceType RESOURCE_NAME_FORMULARYITEM(default RESOURCE_NAME_FORMULARYITEM) - The type of the resource describes

identifier? Identifier[] - Business identifier for this formulary item.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code (or set of codes) that specify the product or service that is identified by this formulary item.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language? code - The base language in which the resource is written.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status? FormularyItemStatus - The validity about the information of the formulary item and not of the underlying product or service itself.

Element... - Rest field

health.fhir.r5.international500: GenomicStudy

FHIR GenomicStudy resource record.

Fields

resourceType RESOURCE_NAME_GENOMICSTUDY(default RESOURCE_NAME_GENOMICSTUDY) - The type of the resource describes

identifier? Identifier[] - Identifiers for this genomic study.

note? Annotation[] - Comments related to the genomic study.

reason? CodeableReference[] - Why the genomic study was performed.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject Reference - The primary subject of the genomic study.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 - Description of the genomic study.

interpreter? Reference[] - Healthcare professionals who interpreted the genomic study.

language? code - The base language in which the resource is written.

encounter? Reference - The healthcare event with which this genomics study is associated.

analysis? GenomicStudyAnalysis[] - The details about a specific analysis that was performed in this GenomicStudy.

instantiatesCanonical? canonical - The defined protocol that describes the study.

'type? CodeableConcept[] - The type of the study, e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling.

instantiatesUri? uri - The URL pointing to an externally maintained protocol that describes the study.

referrer? Reference - Healthcare professional who requested or referred the genomic study.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - Event resources that the genomic study is based on.

startDate? dateTime - When the genomic study was started.

status GenomicStudyStatus - The status of the genomic study.

Element... - Rest field

health.fhir.r5.international500: GenomicStudyAnalysis

Closed record

FHIR GenomicStudyAnalysis datatype record.

Fields

date? dateTime - The date of the analysis event.

identifier? Identifier[] - Identifiers for the analysis event.

note? Annotation[] - Any notes capture with the analysis 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

performer? GenomicStudyAnalysisPerformer[] - Performer for the analysis event.

regionsStudied? Reference[] - The genomic regions to be studied in the analysis (BED file).

changeType? CodeableConcept[] - Type of the genomic changes studied in the analysis, e.g., DNA, RNA, or amino acid change.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The focus of a genomic analysis when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the GenomicStudy.subject would be the child (proband) and the GenomicStudy.analysis.focus of a specific analysis would be the parent.

instantiatesCanonical? canonical - The defined protocol that describes the analysis.

title? string - Name of the analysis event (human friendly).

instantiatesUri? uri - The URL pointing to an externally maintained protocol that describes the analysis.

output? GenomicStudyAnalysisOutput[] - Outputs for the analysis event.

input? GenomicStudyAnalysisInput[] - Inputs for the analysis event.

methodType? CodeableConcept[] - Type of the methods used in the analysis, e.g., Fluorescence in situ hybridization (FISH), Karyotyping, or Microsatellite instability testing (MSI).

genomeBuild? CodeableConcept - The reference genome build that is used in this analysis.

regionsCalled? Reference[] - Genomic regions actually called in the analysis event (BED file).

specimen? Reference[] - The specimen used in the analysis event.

protocolPerformed? Reference - The protocol that was performed for the analysis event.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

device? GenomicStudyAnalysisDevice[] - Devices used for the analysis (e.g., instruments, software), with settings and parameters.

health.fhir.r5.international500: GenomicStudyAnalysisDevice

Closed record

FHIR GenomicStudyAnalysisDevice datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Specific function for the device used for the analysis.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

device? Reference - Device used for the analysis.

health.fhir.r5.international500: GenomicStudyAnalysisInput

Closed record

FHIR GenomicStudyAnalysisInput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

generatedByGenomicStudyReference? Reference - The analysis event or other GenomicStudy that generated this input file.

file? Reference - File containing input data.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

generatedByGenomicStudyIdentifier? Identifier - The analysis event or other GenomicStudy that generated this input file.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Type of input data, e.g., BAM, CRAM, or FASTA.

health.fhir.r5.international500: GenomicStudyAnalysisOutput

Closed record

FHIR GenomicStudyAnalysisOutput datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

file? Reference - File containing output data.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Type of output data, e.g., VCF, MAF, or BAM.

health.fhir.r5.international500: GenomicStudyAnalysisPerformer

Closed record

FHIR GenomicStudyAnalysisPerformer datatype record.

Fields

actor? Reference - The organization, healthcare professional, or others who participated in performing this analysis.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

role? CodeableConcept - Role of the actor for this analysis.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Goal

FHIR Goal resource record.

Fields

resourceType RESOURCE_NAME_GOAL(default RESOURCE_NAME_GOAL) - The type of the resource describes

statusDate? date - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

note? Annotation[] - Any comments related to the goal.

addresses? Reference[] - The identified conditions and other health record elements that are intended to be addressed by the goal.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

lifecycleStatus GoalLifecycleStatus - The state of the goal throughout its lifecycle.

subject Reference - Identifies the patient, group or organization for whom the goal is being established.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.

language? code - The base language in which the resource is written.

'source? Reference - Indicates whose goal this is - patient goal, practitioner goal, etc.

statusReason? string - Captures the reason for the current status.

continuous? boolean - After meeting the goal, ongoing activity is needed to sustain the goal objective.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome? CodeableReference[] - Identifies the change (or lack of change) at the point when the status of the goal is assessed.

identifier? Identifier[] - Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

priority? CodeableConcept - Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

target? GoalTarget[] - Indicates what should be done by when.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

startCodeableConcept? CodeableConcept - The date or event after which the goal should begin being pursued.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

achievementStatus? CodeableConcept - Describes the progression, or lack thereof, towards the goal against the target.

category? CodeableConcept[] - Indicates a category the goal falls within.

startDate? date - The date or event after which the goal should begin being pursued.

Element... - Rest field

health.fhir.r5.international500: GoalTarget

Closed record

FHIR GoalTarget datatype record.

Fields

detailRange? Range - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

detailQuantity? Quantity - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

dueDate? date - Indicates either the date or the duration after start by which the goal should be met.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

detailString? string - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailBoolean? boolean - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

dueDuration? Duration - Indicates either the date or the duration after start by which the goal should be met.

measure? CodeableConcept - The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

detailRatio? Ratio - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailInteger? integer - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailCodeableConcept? CodeableConcept - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: GraphDefinition

FHIR GraphDefinition resource record.

Fields

resourceType RESOURCE_NAME_GRAPHDEFINITION(default RESOURCE_NAME_GRAPHDEFINITION) - The type of the resource describes

date? dateTime - The date (and optionally time) when the graph definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.

copyright? markdown - A copyright statement relating to the graph definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the graph definition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose? markdown - Explanation of why this graph definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the graph definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

link? GraphDefinitionLink[] - Links this graph makes rules about.

description? markdown - A free text natural language description of the graph definition from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the capability statement.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this GraphDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

'start? id - The Node at which instances of this graph start. If there is no nominated start, the graph can start at any of the nodes.

'version? string - The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url? uri - An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers.

node? GraphDefinitionNode[] - Potential target for the link.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

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 graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the graph definition.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.

status GraphDefinitionStatus - The status of this graph definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: GraphDefinitionLink

Closed record

FHIR GraphDefinitionLink datatype record.

Fields

sourceId id - The source node for this link.

path? string - A FHIRPath expression that identifies one of FHIR References to other resources.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

sliceName? string - Which slice (if profiled).

min? integer - Minimum occurrences for this link.

targetId id - The target node for this link.

max? string - Maximum occurrences for this link.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? GraphDefinitionLinkCompartment[] - Compartment Consistency Rules.

description? string - Information about why this link is of interest in this graph definition.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

params? string - A set of parameters to look up.

health.fhir.r5.international500: GraphDefinitionLinkCompartment

Closed record

FHIR GraphDefinitionLinkCompartment datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 GraphDefinitionLinkCompartmentCode - Identifies the compartment.

expression? string - Custom rule, as a FHIRPath expression.

use GraphDefinitionLinkCompartmentUse - Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? string - Documentation for FHIRPath expression.

rule GraphDefinitionLinkCompartmentRule - identical | matching | different | no-rule | custom.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: GraphDefinitionNode

Closed record

FHIR GraphDefinitionNode datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

profile? canonical - Profile for the target resource.

description? string - Information about why this node is of interest in this graph definition.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type code - Type of resource this link refers to.

nodeId id - Internal ID of node - target for link references.

health.fhir.r5.international500: Group

FHIR Group resource record.

Fields

resourceType RESOURCE_NAME_GROUP(default RESOURCE_NAME_GROUP) - The type of the resource describes

identifier? Identifier[] - Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc.

quantity? unsignedInt - A count of the number of resource instances that are part of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active? boolean - Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

description? markdown - Explanation of what the group represents and how it is intended to be used.

language? code - The base language in which the resource is written.

membership GroupMembership - Basis for membership in the Group: * 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. * 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.

'type GroupType - Identifies the broad classification of the kind of resources the group includes.

characteristic? GroupCharacteristic[] - Identifies traits whose presence r absence is shared by members of the group.

managingEntity? Reference - Entity responsible for defining and maintaining Group characteristics and/or registered members.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

member? GroupMember[] - Identifies the resource instances that are members of the group.

name? string - A label assigned to the group for human identification and communication.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r5.international500: GroupCharacteristic

Closed record

FHIR GroupCharacteristic datatype record.

Fields

valueCodeableConcept CodeableConcept - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueBoolean boolean - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

code CodeableConcept - A code that identifies the kind of trait being asserted.

valueReference Reference - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueRange Range - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

exclude boolean - If true, indicates the characteristic is one that is NOT held by members of the group.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity Quantity - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

health.fhir.r5.international500: GroupDefinition

FHIR GroupDefinition resource record.

Fields

resourceType RESOURCE_NAME_GROUPDEFINITION(default RESOURCE_NAME_GROUPDEFINITION) - The type of the resource describes

identifier? Identifier[] - Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc.

quantity? unsignedInt - A count of the number of resource instances that are part of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active? boolean - Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

description? markdown - Explanation of what the group represents and how it is intended to be used.

language? code - The base language in which the resource is written.

membership GroupDefinitionMembership - Basis for membership in the Group: * 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. * 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.

'type GroupDefinitionType - Identifies the broad classification of the kind of resources the group includes.

characteristic GroupDefinitionCharacteristic[] - Identifies traits whose presence r absence is shared by members of the group.

managingEntity? Reference - Entity responsible for defining and maintaining Group characteristics and/or registered members.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

member? GroupDefinitionMember[] - Identifies the resource instances that are members of the group.

name? string - A label assigned to the group for human identification and communication.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r5.international500: GroupDefinitionCharacteristic

Closed record

FHIR GroupDefinitionCharacteristic datatype record.

Fields

valueCodeableConcept CodeableConcept - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueBoolean boolean - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

code CodeableConcept - A code that identifies the kind of trait being asserted.

valueReference Reference - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueRange Range - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

exclude boolean - If true, indicates the characteristic is one that is NOT held by members of the group.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity Quantity - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

health.fhir.r5.international500: GroupDefinitionMember

Closed record

FHIR GroupDefinitionMember datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period that the member was in the group, if known.

inactive? boolean - A flag to indicate that the member is no longer in the group, but previously may have been a member.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

entity Reference - A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

health.fhir.r5.international500: GroupMember

Closed record

FHIR GroupMember datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period that the member was in the group, if known.

inactive? boolean - A flag to indicate that the member is no longer in the group, but previously may have been a member.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

entity Reference - A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

health.fhir.r5.international500: GuidanceResponse

FHIR GuidanceResponse resource record.

Fields

resourceType RESOURCE_NAME_GUIDANCERESPONSE(default RESOURCE_NAME_GUIDANCERESPONSE) - The type of the resource describes

identifier? Identifier[] - Allows a service to provide unique, business identifiers for the response.

note? Annotation[] - Provides a mechanism to communicate additional information about the response.

reason? CodeableReference[] - Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

performer? Reference - Provides a reference to the device that performed the guidance.

subject? Reference - The patient for which the request was processed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

encounter? Reference - The encounter during which this response was created or to which the creation of this record is tightly associated.

moduleCodeableConcept CodeableConcept - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

result? Reference[] - The actions, if any, produced by the evaluation of the artifact.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

evaluationMessage? Reference - Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

moduleCanonical canonical - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

dataRequirement? DataRequirement[] - If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime? dateTime - Indicates when the guidance response was processed.

requestIdentifier? Identifier - The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

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.

moduleUri uri - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

outputParameters? Reference - The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

status GuidanceResponseStatus - The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

Element... - Rest field

health.fhir.r5.international500: HealthcareService

FHIR HealthcareService resource record.

Fields

resourceType RESOURCE_NAME_HEALTHCARESERVICE(default RESOURCE_NAME_HEALTHCARESERVICE) - The type of the resource describes

serviceProvisionCode? CodeableConcept[] - The code(s) that detail the conditions under which the healthcare service is available/offered.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

specialty? CodeableConcept[] - Collection of specialties handled by the Healthcare service. This is more of a medical term.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

eligibility? HealthcareServiceEligibility[] - Does this service have specific eligibility requirements that need to be met in order to use the service?

language? code - The base language in which the resource is written.

availability? Availability[] - A collection of times that the healthcare service is available.

program? CodeableConcept[] - Programs that this service is applicable to.

'type? CodeableConcept[] - The specific type of service that may be delivered or performed.

characteristic? CodeableConcept[] - Collection of characteristics (attributes).

endpoint? Reference[] - Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

contact? ExtendedContactDetail[] - The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication? CodeableConcept[] - Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

referralMethod? CodeableConcept[] - Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

providedBy? Reference - The organization that provides this healthcare service.

identifier? Identifier[] - External identifiers for this item.

appointmentRequired? boolean - Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

active? boolean - This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

photo? Attachment - If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

offeredIn? Reference[] - When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - Further description of the service as it would be presented to a consumer while searching.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

comment? markdown - Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

location? Reference[] - The location(s) where this healthcare service may be provided.

category? CodeableConcept[] - Identifies the broad category of service being performed or delivered.

extraDetails? markdown - Extra details about the service that can't be placed in the other fields.

coverageArea? Reference[] - The location(s) that this service is available to (not where the service is provided).

Element... - Rest field

health.fhir.r5.international500: HealthcareServiceEligibility

Closed record

FHIR HealthcareServiceEligibility datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Coded value for the eligibility.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

comment? markdown - Describes the eligibility conditions for the service.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ImagingSelection

FHIR ImagingSelection resource record.

Fields

resourceType RESOURCE_NAME_IMAGINGSELECTION(default RESOURCE_NAME_IMAGINGSELECTION) - The type of the resource describes

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Reason for referencing the selected content.

instance? ImagingSelectionInstance[] - Each imaging selection includes one or more selected DICOM SOP instances.

subject? Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placed.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

endpoint? Reference[] - The network service providing retrieval access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints.

seriesUid? id - The Series Instance UID for the DICOM Series from which the images were selected.

derivedFrom? Reference[] - The imaging study from which the imaging selection is made.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this imaging selection was created.

studyUid? id - The Study Instance UID for the DICOM Study from which the images were selected.

basedOn? Reference[] - A list of the diagnostic requests that resulted in this imaging selection being performed.

identifier? Identifier[] - A unique identifier assigned to this imaging selection.

performer? ImagingSelectionPerformer[] - Selector of the instances – human or machine.

frameOfReferenceUid? id - The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames.

seriesNumber? unsignedInt - The Series Number for the DICOM Series from which the images were selected.

bodySite? CodeableReference - The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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[] - Classifies the imaging selection.

status ImagingSelectionStatus - The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection.

Element... - Rest field

health.fhir.r5.international500: ImagingSelectionInstance

Closed record

FHIR ImagingSelectionInstance datatype record.

Fields

number? unsignedInt - The Instance Number for the selected DICOM instance.

uid id - The SOP Instance UID for the selected DICOM instance.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

imageRegion2D? ImagingSelectionInstanceImageRegion2D[] - Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.

sopClass? Coding - The SOP Class UID for the selected DICOM instance.

imageRegion3D? ImagingSelectionInstanceImageRegion3D[] - Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

subset? string[] - Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.

health.fhir.r5.international500: ImagingSelectionInstanceImageRegion2D

Closed record

FHIR ImagingSelectionInstanceImageRegion2D datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

coordinate decimal[] - The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames.

regionType ImagingSelectionInstanceImageRegion2DRegionType - Specifies the type of image region.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ImagingSelectionInstanceImageRegion3D

Closed record

FHIR ImagingSelectionInstanceImageRegion3D datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

coordinate decimal[] - The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and may be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid element.

regionType ImagingSelectionInstanceImageRegion3DRegionType - Specifies the type of image region.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ImagingSelectionPerformer

Closed record

FHIR ImagingSelectionPerformer datatype record.

Fields

actor? Reference - Author – human or machine.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the performer.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ImagingStudy

FHIR ImagingStudy resource record.

Fields

resourceType RESOURCE_NAME_IMAGINGSTUDY(default RESOURCE_NAME_IMAGINGSTUDY) - The type of the resource describes

note? Annotation[] - Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.

partOf? Reference[] - A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure.

reason? CodeableReference[] - Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modality? CodeableConcept[] - A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.

subject Reference - The subject, typically a patient, of the imaging study.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? string - The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.

language? code - The base language in which the resource is written.

endpoint? Reference[] - The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

numberOfInstances? unsignedInt - Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - A list of the diagnostic requests that resulted in this imaging study being performed.

identifier? Identifier[] - Identifiers for the ImagingStudy such as DICOM Study Instance UID.

numberOfSeries? unsignedInt - Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.

started? dateTime - Date and time the study started.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.

procedure? CodeableReference[] - This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy.

referrer? Reference - The requesting/referring physician.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

series? ImagingStudySeries[] - Each study has one or more series of images or other content.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? Reference - The principal physical location where the ImagingStudy was performed.

status ImagingStudyStatus - The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy.

Element... - Rest field

health.fhir.r5.international500: ImagingStudySeries

Closed record

FHIR ImagingStudySeries datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

instance? ImagingStudySeriesInstance[] - A single SOP instance within the series, e.g. an image, or presentation state.

modality CodeableConcept - The distinct modality for this series. This may include both acquisition and non-acquisition modalities.

performer? ImagingStudySeriesPerformer[] - Indicates who or what performed the series and how they were involved.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? string - A description of the series.

started? dateTime - The date and time the series was started.

laterality? CodeableConcept - The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.

number? unsignedInt - The numeric identifier of this series in the study.

uid id - The DICOM Series Instance UID for the series.

bodySite? CodeableReference - The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.

endpoint? Reference[] - The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.

numberOfInstances? unsignedInt - Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

specimen? Reference[] - The specimen imaged, e.g., for whole slide imaging of a biopsy.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ImagingStudySeriesInstance

Closed record

FHIR ImagingStudySeriesInstance datatype record.

Fields

number? unsignedInt - The number of instance in the series.

uid id - The DICOM SOP Instance UID for this image or other DICOM content.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

sopClass Coding - DICOM instance type.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title? string - The description of the instance.

health.fhir.r5.international500: ImagingStudySeriesPerformer

Closed record

FHIR ImagingStudySeriesPerformer datatype record.

Fields

actor Reference - Indicates who or what performed the series.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the performer in the series.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Immunization

FHIR Immunization resource record.

Fields

resourceType RESOURCE_NAME_IMMUNIZATION(default RESOURCE_NAME_IMMUNIZATION) - The type of the resource describes

note? Annotation[] - Extra information about the immunization that is not conveyed by the other attributes.

primarySource? boolean - Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.

reason? CodeableReference[] - Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

doseQuantity? SimpleQuantity - The quantity of vaccine product that was administered.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

manufacturer? CodeableReference - Name of vaccine manufacturer.

programEligibility? ImmunizationProgramEligibility[] - Indicates a patient's eligibility for a funding program.

statusReason? CodeableConcept - Indicates the reason the immunization event was not performed.

isSubpotent? boolean - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

informationSource? CodeableReference - Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

patient Reference - The patient who either received or did not receive the immunization.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - A plan, order or recommendation fulfilled in whole or in part by this immunization.

vaccineCode CodeableConcept - Vaccine that was administered or was to be administered.

expirationDate? date - Date vaccine batch expires.

identifier? Identifier[] - A unique identifier assigned to this immunization record.

performer? ImmunizationPerformer[] - Indicates who performed the immunization event.

reaction? ImmunizationReaction[] - Categorical data indicating that an adverse event is associated in time to an immunization.

subpotentReason? CodeableConcept[] - Reason why a dose is considered to be subpotent.

supportingInformation? Reference[] - Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.

encounter? Reference - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

lotNumber? string - Lot number of the vaccine product.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

site? CodeableConcept - Body site where vaccine was administered.

route? CodeableConcept - The path by which the vaccine product is taken into the body.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

protocolApplied? ImmunizationProtocolApplied[] - The protocol (set of recommendations) being followed by the provider who administered the dose.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? Reference - The service delivery location where the vaccine administration occurred.

occurrenceDateTime dateTime - Date vaccine administered or was to be administered.

occurrenceString string - Date vaccine administered or was to be administered.

fundingSource? CodeableConcept - Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

administeredProduct? CodeableReference - An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.

status ImmunizationStatus - Indicates the current status of the immunization event.

Element... - Rest field

health.fhir.r5.international500: ImmunizationEvaluation

FHIR ImmunizationEvaluation resource record.

Fields

resourceType RESOURCE_NAME_IMMUNIZATIONEVALUATION(default RESOURCE_NAME_IMMUNIZATIONEVALUATION) - The type of the resource describes

date? dateTime - The date the evaluation of the vaccine administration event was performed.

identifier? Identifier[] - A unique identifier assigned to this immunization evaluation record.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

doseStatus CodeableConcept - Indicates if the dose is valid or not valid with respect to the published recommendations.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 - Additional information about the evaluation.

language? code - The base language in which the resource is written.

immunizationEvent Reference - The vaccine administration event being evaluated.

doseNumber? string - Nominal position in a series as determined by the outcome of the evaluation process.

seriesDoses? string - The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

doseStatusReason? CodeableConcept[] - Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient Reference - The individual for whom the evaluation is being done.

series? string - One possible path to achieve presumed immunity against a disease - within the context of an authority.

authority? Reference - Indicates the authority who published the protocol (e.g. ACIP).

targetDisease CodeableConcept - The vaccine preventable disease the dose is being evaluated against.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status ImmunizationEvaluationStatus - Indicates the current status of the evaluation of the vaccination administration event.

Element... - Rest field

health.fhir.r5.international500: ImmunizationPerformer

Closed record

FHIR ImmunizationPerformer datatype record.

Fields

actor Reference - The practitioner or organization who performed the action.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Describes the type of performance (e.g. ordering provider, administering provider, etc.).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: ImmunizationProgramEligibility

Closed record

FHIR ImmunizationProgramEligibility datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

program CodeableConcept - Indicates which program the patient had their eligility evaluated for.

programStatus CodeableConcept - Indicates the patient's eligility status for for a specific payment program.

health.fhir.r5.international500: ImmunizationProtocolApplied

Closed record

FHIR ImmunizationProtocolApplied datatype record.

Fields

doseNumber string - Nominal position in a series as intended by the practitioner administering the dose.

seriesDoses? string - The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

series? string - One possible path to achieve presumed immunity against a disease - within the context of an authority.

authority? Reference - Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

targetDisease? CodeableConcept[] - The vaccine preventable disease the dose is being administered against.

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.r5.international500: ImmunizationReaction

Closed record

FHIR ImmunizationReaction datatype record.

Fields

date? dateTime - Date of reaction to the immunization.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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? CodeableReference - Details of the reaction.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

reported? boolean - Self-reported indicator.

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.r5.international500: ImmunizationRecommendation

FHIR ImmunizationRecommendation resource record.

Fields

resourceType RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION(default RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION) - The type of the resource describes

date dateTime - The date the immunization recommendation(s) were created.

identifier? Identifier[] - A unique identifier assigned to this particular recommendation record.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

recommendation ImmunizationRecommendationRecommendation[] - Vaccine administration recommendations.

language? code - The base language in which the resource is written.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

patient Reference - The patient the recommendation(s) are for.

authority? Reference - Indicates the authority who published the protocol (e.g. ACIP).

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r5.international500: ImmunizationRecommendationRecommendation

Closed record

FHIR ImmunizationRecommendationRecommendation datatype record.

Fields

supportingImmunization? Reference[] - Immunization event history and/or evaluation that supports the status and recommendation.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

forecastReason? CodeableConcept[] - The reason for the assigned forecast status.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

forecastStatus CodeableConcept - Indicates the patient status with respect to the path to immunity for the target disease.

description? markdown - Contains the description about the protocol under which the vaccine was administered.

supportingPatientInformation? Reference[] - Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

doseNumber? string - Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).

seriesDoses? string - The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.

contraindicatedVaccineCode? CodeableConcept[] - Vaccine(s) which should not be used to fulfill the recommendation.

series? string - One possible path to achieve presumed immunity against a disease - within the context of an authority.

targetDisease? CodeableConcept[] - The targeted disease for the recommendation.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

dateCriterion? ImmunizationRecommendationRecommendationDateCriterion[] - Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

vaccineCode? CodeableConcept[] - Vaccine(s) or vaccine group that pertain to the recommendation.

health.fhir.r5.international500: ImmunizationRecommendationRecommendationDateCriterion

Closed record

FHIR ImmunizationRecommendationRecommendationDateCriterion datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value dateTime - The date whose meaning is specified by dateCriterion.code.

health.fhir.r5.international500: ImplementationGuide

FHIR ImplementationGuide resource record.

Fields

resourceType RESOURCE_NAME_IMPLEMENTATIONGUIDE(default RESOURCE_NAME_IMPLEMENTATIONGUIDE) - The type of the resource describes

date? dateTime - The date (and optionally time) when the implementation guide was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.

copyright? markdown - A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose? markdown - Explanation of why this implementation guide is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the implementation guide is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A free text natural language description of the implementation guide from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

global? ImplementationGuideGlobal[] - A set of profiles that all resources covered by this implementation guide must conform to.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the implementation guide.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

fhirVersion code[] - The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.

definition? ImplementationGuideDefinition - The information needed by an IG publisher tool to publish the whole implementation guide.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

dependsOn? ImplementationGuideDependsOn[] - Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

manifest? ImplementationGuideManifest - Information about an assembled implementation guide, created by the publication tooling.

packageId id - The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

'version? string - The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri - An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.

license? code - The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name string - A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.

status ImplementationGuideStatus - The status of this implementation guide. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ImplementationGuideDefinition

Closed record

FHIR ImplementationGuideDefinition datatype record.

Fields

template? ImplementationGuideDefinitionTemplate[] - A template for building resources.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'resource? ImplementationGuideDefinitionResource[] - A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'parameter? ImplementationGuideDefinitionParameter[] - A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

page? ImplementationGuideDefinitionPage - A page / section in the implementation guide. The root page is the implementation guide home page.

grouping? ImplementationGuideDefinitionGrouping[] - A logical group of resources. Logical groups can be used when building pages.

health.fhir.r5.international500: ImplementationGuideDefinitionGrouping

Closed record

FHIR ImplementationGuideDefinitionGrouping datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name string - The human-readable title to display for the package of resources when rendering the implementation guide.

description? markdown - Human readable text describing the package.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ImplementationGuideDefinitionPage

Closed record

FHIR ImplementationGuideDefinitionPage datatype record.

Fields

generation ImplementationGuideDefinitionPageGeneration - A code that indicates how the page is generated.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

sourceImplementationGuideString? string - Indicates the URL or the actual content to provide for the page.

sourceImplementationGuideMarkdown? markdown - Indicates the URL or the actual content to provide for the page.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 urlType - The url by which the page should be known when published.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.

sourceImplementationGuideUrl? urlType - Indicates the URL or the actual content to provide for the page.

health.fhir.r5.international500: ImplementationGuideDefinitionParameter

Closed record

FHIR ImplementationGuideDefinitionParameter datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code Coding - A tool-specific code that defines the parameter.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - Value for named type.

health.fhir.r5.international500: ImplementationGuideDefinitionResource

Closed record

FHIR ImplementationGuideDefinitionResource datatype record.

Fields

reference Reference - Where this resource is found.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

groupingId? id - Reference to the id of the grouping this resource appears in.

isExample? boolean - If true, indicates the resource is an example instance.

fhirVersion? code[] - Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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[] - If present, indicates profile(s) the instance is valid against.

name? string - A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).

description? markdown - A description of the reason that a resource has been included in the implementation guide.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: ImplementationGuideDefinitionTemplate

Closed record

FHIR ImplementationGuideDefinitionTemplate datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code - Type of template specified.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

scope? string - The scope in which the template applies.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source string - The source location for the template.

health.fhir.r5.international500: ImplementationGuideDependsOn

Closed record

FHIR ImplementationGuideDependsOn datatype record.

Fields

reason? markdown - A description explaining the nature of the dependency on the listed IG.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

packageId? id - The NPM package name for the Implementation Guide that this IG depends on.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

uri canonical - A canonical reference to the Implementation guide for the dependency.

'version? string - The version of the IG that is depended on, when the correct version is required to understand the IG correctly.

health.fhir.r5.international500: ImplementationGuideGlobal

Closed record

FHIR ImplementationGuideGlobal datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

profile canonical - A reference to the profile that all instances must conform to.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type code - The type of resource that all instances must conform to.

health.fhir.r5.international500: ImplementationGuideManifest

Closed record

FHIR ImplementationGuideManifest datatype record.

Fields

image? string[] - Indicates a relative path to an image that exists within the IG.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

other? string[] - Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.

'resource ImplementationGuideManifestResource[] - A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

rendering? urlType - A pointer to official web page, PDF or other rendering of the implementation guide.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

page? ImplementationGuideManifestPage[] - Information about a page within the IG.

health.fhir.r5.international500: ImplementationGuideManifestPage

Closed record

FHIR ImplementationGuideManifestPage datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

anchor? string[] - The name of an anchor available on the page.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name string - Relative path to the page.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title? string - Label for the page intended for human display.

health.fhir.r5.international500: ImplementationGuideManifestResource

Closed record

FHIR ImplementationGuideManifestResource datatype record.

Fields

reference Reference - Where this resource is found.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

isExample? boolean - If true, indicates the resource is an example instance.

relativePath? urlType - The relative path for primary page for this resource within the IG.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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[] - If present, indicates profile(s) the instance is valid against.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: Ingredient

FHIR Ingredient resource record.

Fields

resourceType RESOURCE_NAME_INGREDIENT(default RESOURCE_NAME_INGREDIENT) - The type of the resource describes

identifier? Identifier - The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

substance IngredientSubstance - The substance that comprises this ingredient.

for? Reference[] - The product which this ingredient is a constituent part of.

language? code - The base language in which the resource is written.

allergenicIndicator? boolean - If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.

manufacturer? IngredientManufacturer[] - The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

'function? CodeableConcept[] - A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent.

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? markdown - A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

group? CodeableConcept - A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.

status IngredientStatus - The status of this ingredient. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: IngredientManufacturer

Closed record

FHIR IngredientManufacturer datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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? IngredientManufacturerRole - The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

manufacturer Reference - An organization that manufactures this ingredient.

health.fhir.r5.international500: IngredientSubstance

Closed record

FHIR IngredientSubstance datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 CodeableReference - A code or full resource that represents the ingredient's substance.

strength? IngredientSubstanceStrength[] - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: IngredientSubstanceStrength

Closed record

FHIR IngredientSubstanceStrength datatype record.

Fields

concentrationIngredientCodeableConcept? CodeableConcept - The strength per unitary volume (or mass).

country? CodeableConcept[] - The country or countries for which the strength range applies.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

textConcentration? string - A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.

presentationIngredientRatioRange? RatioRange - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

presentationIngredientCodeableConcept? CodeableConcept - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

basis? CodeableConcept - A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).

concentrationIngredientQuantity? Quantity - The strength per unitary volume (or mass).

textPresentation? string - A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

referenceStrength? IngredientSubstanceStrengthReferenceStrength[] - Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

concentrationIngredientRatioRange? RatioRange - The strength per unitary volume (or mass).

concentrationIngredientRatio? Ratio - The strength per unitary volume (or mass).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

presentationIngredientQuantity? Quantity - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

measurementPoint? string - For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.

presentationIngredientRatio? Ratio - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

health.fhir.r5.international500: IngredientSubstanceStrengthReferenceStrength

Closed record

FHIR IngredientSubstanceStrengthReferenceStrength datatype record.

Fields

country? CodeableConcept[] - The country or countries for which the strength range applies.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

strengthIngredientRatio Ratio - Strength expressed in terms of a reference substance.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

strengthIngredientQuantity Quantity - Strength expressed in terms of a reference substance.

substance CodeableReference - Relevant reference substance.

strengthIngredientRatioRange RatioRange - Strength expressed in terms of a reference substance.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

measurementPoint? string - For when strength is measured at a particular point or distance.

health.fhir.r5.international500: InsurancePlan

FHIR InsurancePlan resource record.

Fields

resourceType RESOURCE_NAME_INSURANCEPLAN(default RESOURCE_NAME_INSURANCEPLAN) - The type of the resource describes

coverage? InsurancePlanCoverage[] - Details about the coverage offered by the insurance product.

identifier? Identifier[] - Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - The period of time that the health insurance product is available.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

administeredBy? Reference - An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.

'type? CodeableConcept[] - The kind of health insurance product.

network? Reference[] - Reference to the network included in the health insurance product.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

endpoint? Reference[] - The technical endpoints providing access to services operated for the health insurance product.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

contact? ExtendedContactDetail[] - The contact details of communication devices available relevant to the specific Insurance Plan/Product. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

name? string - Official name of the health insurance product as designated by the owner.

alias? string[] - A list of alternate names that the product is known as, or was known as in the past.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ownedBy? Reference - The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.

plan? InsurancePlanPlan[] - Details about an insurance plan.

coverageArea? Reference[] - The geographic region in which a health insurance product's benefits apply.

status? InsurancePlanStatus - The current state of the health insurance product.

Element... - Rest field

health.fhir.r5.international500: InsurancePlanCoverage

Closed record

FHIR InsurancePlanCoverage datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).

benefit InsurancePlanCoverageBenefit[] - Specific benefits under this type of coverage.

network? Reference[] - Reference to the network that providing the type of coverage.

health.fhir.r5.international500: InsurancePlanCoverageBenefit

Closed record

FHIR InsurancePlanCoverageBenefit datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

'limit? InsurancePlanCoverageBenefitLimit[] - The specific limits on the benefit.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement? string - The referral requirements to have access/coverage for this benefit.

'type CodeableConcept - Type of benefit (primary care; speciality care; inpatient; outpatient).

health.fhir.r5.international500: InsurancePlanCoverageBenefitLimit

Closed record

FHIR InsurancePlanCoverageBenefitLimit datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The specific limit on the benefit.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value? Quantity - The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.

health.fhir.r5.international500: InsurancePlanPlan

Closed record

FHIR InsurancePlanPlan datatype record.

Fields

identifier? Identifier[] - Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

specificCost? InsurancePlanPlanSpecificCost[] - Costs associated with the coverage provided by the product.

'type? CodeableConcept - Type of plan. For example, 'Platinum' or 'High Deductable'.

coverageArea? Reference[] - The geographic region in which a health insurance plan's benefits apply.

generalCost? InsurancePlanPlanGeneralCost[] - Overall costs associated with the plan.

network? Reference[] - Reference to the network that providing the type of coverage.

health.fhir.r5.international500: InsurancePlanPlanGeneralCost

Closed record

FHIR InsurancePlanPlanGeneralCost datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

cost? Money - Value of the cost.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

comment? string - Additional information about the general costs associated with this plan.

groupSize? positiveInt - Number of participants enrolled in the plan.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Type of cost.

health.fhir.r5.international500: InsurancePlanPlanSpecificCost

Closed record

FHIR InsurancePlanPlanSpecificCost datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).

benefit? InsurancePlanPlanSpecificCostBenefit[] - List of the specific benefits under this category of benefit.

health.fhir.r5.international500: InsurancePlanPlanSpecificCostBenefit

Closed record

FHIR InsurancePlanPlanSpecificCostBenefit datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

cost? InsurancePlanPlanSpecificCostBenefitCost[] - List of the costs associated with a specific benefit.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).

health.fhir.r5.international500: InsurancePlanPlanSpecificCostBenefitCost

Closed record

FHIR InsurancePlanPlanSpecificCostBenefitCost datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

qualifiers? CodeableConcept[] - Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).

applicability? CodeableConcept - Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of cost (copay; individual cap; family cap; coinsurance; deductible).

value? Quantity - The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).

health.fhir.r5.international500: InventoryItem

FHIR InventoryItem resource record.

Fields

resourceType RESOURCE_NAME_INVENTORYITEM(default RESOURCE_NAME_INVENTORYITEM) - The type of the resource describes

identifier? Identifier[] - Business identifier for the inventory item.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 designating the specific type of item.

instance? InventoryItemInstance - Instances or occurrences of the product.

inventoryStatus? CodeableConcept[] - The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etc.

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 managable, 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).

association? InventoryItemAssociation[] - Association with other items or products.

description? InventoryItemDescription - The descriptive characteristics of the inventory item.

productReference? Reference - Link to a product resource used in clinical workflows.

responsibleOrganization? InventoryItemResponsibleOrganization[] - Organization(s) responsible for the product.

language? code - The base language in which the resource is written.

characteristic? InventoryItemCharacteristic[] - The descriptive or identifying characteristics of the item.

baseUnit? CodeableConcept - The base unit of measure - the unit in which the product is used or counted.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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? InventoryItemName[] - The item name(s) - the brand name, or common name, functional name, generic name.

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.

netContent? SimpleQuantity - Net content or amount present in the item.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - Category or class of the item.

status InventoryItemStatus - Status of the item entry.

Element... - Rest field

health.fhir.r5.international500: InventoryItemAssociation

Closed record

FHIR InventoryItemAssociation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity Ratio - The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present product.

associationType CodeableConcept - This attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed with.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

relatedItem Reference - The related item or product.

health.fhir.r5.international500: InventoryItemCharacteristic

Closed record

FHIR InventoryItemCharacteristic datatype record.

Fields

valueBoolean boolean - The value of the attribute.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueRange Range - The value of the attribute.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

characteristicType CodeableConcept - The type of characteristic that is being defined.

valueDecimal decimal - The value of the attribute.

valueUrl urlType - The value of the attribute.

valueAddress Address - The value of the attribute.

valueCodeableConcept CodeableConcept - The value of the attribute.

valueRatio Ratio - The value of the attribute.

valueString string - The value of the attribute.

valueDateTime dateTime - The value of the attribute.

valueDuration Duration - The value of the attribute.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer - The value of the attribute.

valueQuantity Quantity - The value of the attribute.

valueAnnotation Annotation - The value of the attribute.

health.fhir.r5.international500: InventoryItemDescription

Closed record

FHIR InventoryItemDescription datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? string - Textual description of the item.

language? code - The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language.

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.r5.international500: InventoryItemInstance

Closed record

FHIR InventoryItemInstance datatype record.

Fields

identifier? Identifier[] - The identifier for the physical instance, typically a serial number.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject? Reference - The subject that the item is associated with.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

location? Reference - The location that the item is associated with.

expiry? dateTime - The expiry date or date and time for the product.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

lotNumber? string - The lot or batch number of the item.

health.fhir.r5.international500: InventoryItemName

Closed record

FHIR InventoryItemName datatype record.

Fields

nameType Coding - The type of name e.g. 'brand-name', 'functional-name', 'common-name'.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 or designation that the item is given.

language code - The language that the item name is expressed in.

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.r5.international500: InventoryItemResponsibleOrganization

Closed record

FHIR InventoryItemResponsibleOrganization datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 of the organization e.g. manufacturer, distributor, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

organization Reference - An organization that has an association with the item, e.g. manufacturer, distributor, responsible, 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.r5.international500: InventoryReport

FHIR InventoryReport resource record.

Fields

resourceType RESOURCE_NAME_INVENTORYREPORT(default RESOURCE_NAME_INVENTORYREPORT) - The type of the resource describes

identifier? Identifier[] - Business identifier for the InventoryReport.

note? Annotation[] - A note associated with the InventoryReport.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

reportingPeriod? Period - The period the report refers to.

inventoryListing? InventoryReportInventoryListing[] - An inventory listing section (grouped by any of the attributes).

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 managable, 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).

operationTypeReason? CodeableConcept - The reason for this count - regular count, ad-hoc count, new arrivals, etc.

language? code - The base language in which the resource is written.

reportedDateTime dateTime - When the report has been submitted.

reporter? Reference - Who submits the report.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

operationType? CodeableConcept - What type of operation is being performed - addition or subtraction.

countType InventoryReportCountType - Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change).

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 InventoryReportStatus - The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active.

Element... - Rest field

health.fhir.r5.international500: InventoryReportInventoryListing

Closed record

FHIR InventoryReportInventoryListing datatype record.

Fields

countingDateTime? dateTime - The date and time when the items were counted.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item? InventoryReportInventoryListingItem[] - The item or items in this listing.

itemStatus? CodeableConcept - The status of the items.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

location? Reference - Location of the inventory items.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: InventoryReportInventoryListingItem

Closed record

FHIR InventoryReportInventoryListingItem datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item CodeableReference - The code or reference to the item type.

quantity Quantity - The quantity of the item or items being reported.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category? CodeableConcept - The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. 'pending recount' or 'damaged'.

health.fhir.r5.international500: Invoice

FHIR Invoice resource record.

Fields

resourceType RESOURCE_NAME_INVOICE(default RESOURCE_NAME_INVOICE) - The type of the resource describes

date? dateTime - Depricared by the element below.

note? Annotation[] - Comments made about the invoice by the issuer, subject, or other participants.

totalGross? Money - Invoice total, tax included.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject? Reference - The individual or set of individuals receiving the goods and services billed in this invoice.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

'type? CodeableConcept - Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

issuer? Reference - The organizationissuing the Invoice.

participant? InvoiceParticipant[] - Indicates who or what performed or participated in the charged service.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

cancelledReason? string - In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).

creation? dateTime - Date/time(s) of when this Invoice was posted.

paymentTerms? markdown - Payment details such as banking details, period of payment, deductibles, methods of payment.

identifier? Identifier[] - Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.

totalPriceComponent? MonetaryComponent[] - The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.

periodDate? date - Date/time(s) range of services included in this invoice.

totalNet? Money - Invoice total , taxes excluded.

periodPeriod? Period - Date/time(s) range of services included in this invoice.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

lineItem? InvoiceLineItem[] - Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

recipient? Reference - The individual or Organization responsible for balancing of this invoice.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

account? Reference - Account which is supposed to be balanced with this Invoice.

status InvoiceStatus - The current state of the Invoice.

Element... - Rest field

health.fhir.r5.international500: InvoiceLineItem

Closed record

FHIR InvoiceLineItem datatype record.

Fields

chargeItemCodeableConcept CodeableConcept - The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.

sequence? positiveInt - Sequence in which the items appear on the invoice.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

servicedDate? date - Date/time(s) range when this service was delivered or completed.

priceComponent? MonetaryComponent[] - The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.

servicedPeriod? Period - Date/time(s) range when this service was delivered or completed.

chargeItemReference Reference - The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.

health.fhir.r5.international500: InvoiceParticipant

Closed record

FHIR InvoiceParticipant datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed or participated in the service.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

role? CodeableConcept - Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Library

FHIR Library resource record.

Fields

resourceType RESOURCE_NAME_LIBRARY(default RESOURCE_NAME_LIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

description? markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the library.

'type CodeableConcept - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

content? Attachment[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

'version? string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url? uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status LibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: Linkage

FHIR Linkage resource record.

Fields

resourceType RESOURCE_NAME_LINKAGE(default RESOURCE_NAME_LINKAGE) - The type of the resource describes

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item LinkageItem[] - Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.

author? Reference - Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

active? boolean - Indicates whether the asserted set of linkages are considered to be 'in effect'.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language? code - The base language in which the resource is written.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r5.international500: LinkageItem

Closed record

FHIR LinkageItem datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'resource Reference - The resource instance being linked as part of the group.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type LinkageItemType - Distinguishes which item is 'source of truth' (if any) and which items are no longer considered to be current representations.

health.fhir.r5.international500: List

FHIR List resource record.

Fields

resourceType RESOURCE_NAME_LIST(default RESOURCE_NAME_LIST) - The type of the resource describes

date? dateTime - Date list was last reviewed/revised and determined to be 'current'.

identifier? Identifier[] - Identifier for the List assigned for business purposes outside the context of FHIR.

note? Annotation[] - Comments that apply to the overall list.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - This code defines the purpose of the list - why it was created.

emptyReason? CodeableConcept - If the list is empty, why the list is empty.

subject? Reference[] - The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects).

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

encounter? Reference - The encounter that is the context in which this list was created.

'source? Reference - The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

title? string - A label for the list assigned by the author.

mode ListMode - How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

entry? ListEntry[] - Entries in this list.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

orderedBy? CodeableConcept - What order applies to the items in the list.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status ListStatus - Indicates the current state of this list.

Element... - Rest field

health.fhir.r5.international500: ListEntry

Closed record

FHIR ListEntry datatype record.

Fields

date? dateTime - When this item was added to the list.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item Reference - A reference to the actual resource from which data was derived.

deleted? boolean - True if this item is marked as deleted in the list.

flag? CodeableConcept - The flag allows the system constructing the list to indicate the role and significance of the item in the list.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Location

FHIR Location resource record.

Fields

resourceType RESOURCE_NAME_LOCATION(default RESOURCE_NAME_LOCATION) - The type of the resource describes

operationalStatus? Coding - The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

partOf? Reference - Another Location of which this Location is physically a part of.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

virtualService? VirtualServiceDetail[] - Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).

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 managable, 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 - Description of the Location, which helps in finding or referencing the place.

hoursOfOperation? Availability[] - What days/times during a week is this location usually open, and any exceptions where the location is not available.

language? code - The base language in which the resource is written.

'type? CodeableConcept[] - Indicates the type of function performed at the location.

characteristic? CodeableConcept[] - Collection of characteristics (attributes).

mode? LocationMode - Indicates whether a resource instance represents a specific location or a class of locations.

endpoint? Reference[] - Technical endpoints providing access to services operated for the location.

contact? ExtendedContactDetail[] - The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

alias? string[] - A list of alternate names that the location is known as, or was known as, in the past.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - Unique code or number identifying the location to its users.

address? Address - Physical location.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

managingOrganization? Reference - The organization responsible for the provisioning and upkeep of the location.

form? CodeableConcept - Physical form of the location, e.g. building, room, vehicle, road, virtual.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - Name of the location as used by humans. Does not need to be unique.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

position? LocationPosition - The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

status? LocationStatus - The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Element... - Rest field

health.fhir.r5.international500: LocationPosition

Closed record

FHIR LocationPosition datatype record.

Fields

altitude? decimal - Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes on Location main page).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

latitude decimal - Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes on Location main page).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

longitude decimal - Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes on Location main page).

health.fhir.r5.international500: LogicLibrary

FHIR LogicLibrary resource record.

Fields

resourceType RESOURCE_NAME_LOGICLIBRARY(default RESOURCE_NAME_LOGICLIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

description markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title string - A short, descriptive, user-friendly title for the library.

'type LogicLibraryType - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

content? LogicLibraryContent[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.
- relatedArtifact Slicings
1. LogicLibraryRelatedArtifactDependency: Additional documentation, citations, etc
- min = 0
- max = *

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

'version string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status LogicLibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: LogicLibraryContent

Closed record

FHIR LogicLibraryContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data? base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType? code - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: LogicLibraryRelatedArtifactDependency

Closed record

FHIR LogicLibraryRelatedArtifactDependency datatype record.

Fields

publicationStatus? LogicLibraryRelatedArtifactPublicationStatus - The publication status of the artifact being referred to.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

citation? markdown - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

'resource canonical - The related artifact, such as a library, value set, profile, or other knowledge resource.

display? string - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document? Attachment - The document being referenced, represented as an attachment. This is exclusive with the resource element.

classifier? CodeableConcept[] - Provides additional classifiers of the related artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

label? string - A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

'type LogicLibraryRelatedArtifactType(default "depends-on") - The type of relationship to the related artifact.

publicationDate? date - The date of publication of the artifact being referred to.

resourceReference? Reference - The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

health.fhir.r5.international500: LogicLibraryType

Closed record

FHIR LogicLibraryType datatype record.

Fields

coding LogicLibraryTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: LogicLibraryTypeCoding

Closed record

FHIR LogicLibraryTypeCoding datatype record.

Fields

system uri(default "http://terminology.hl7.org/CodeSystem/library-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "module-definition") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r5.international500: ManufacturedItemDefinition

FHIR ManufacturedItemDefinition resource record.

Fields

resourceType RESOURCE_NAME_MANUFACTUREDITEMDEFINITION(default RESOURCE_NAME_MANUFACTUREDITEMDEFINITION) - The type of the resource describes

identifier? Identifier[] - Unique identifier.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ingredient? CodeableConcept[] - The ingredients of this manufactured item. This is only needed if the ingredients are not specified by incoming references from the Ingredient 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 managable, 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.

manufacturer? Reference[] - Manufacturer of the item, one of several possible.

marketingStatus? MarketingStatus[] - Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.

component? ManufacturedItemDefinitionComponent[] - Physical parts of the manufactured item, that it is intrisically made from. This is distinct from the ingredients that are part of its chemical makeup.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

unitOfPresentation? CodeableConcept - The “real-world” units in which the quantity of the manufactured item is described.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A descriptive name applied to this item.

property? ManufacturedItemDefinitionProperty[] - General characteristics of this item.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

manufacturedDoseForm CodeableConcept - Dose form as manufactured and before any transformation into the pharmaceutical product.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status ManufacturedItemDefinitionStatus - The status of this item. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ManufacturedItemDefinitionComponent

Closed record

FHIR ManufacturedItemDefinitionComponent datatype record.

Fields

amount? Quantity[] - The measurable amount of total quantity of all substances in the component, expressable in different ways (e.g. by mass or volume).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

constituent? ManufacturedItemDefinitionComponentConstituent[] - A reference to a constituent of the manufactured item as a whole, linked here so that its component location within the item can be indicated. This not where the item's ingredient are primarily stated (for which see Ingredient.for or ManufacturedItemDefinition.ingredient).

'function? CodeableConcept[] - The function of this component within the item e.g. delivers active ingredient, masks taste.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Defining type of the component e.g. shell, layer, ink.

health.fhir.r5.international500: ManufacturedItemDefinitionComponentConstituent

Closed record

FHIR ManufacturedItemDefinitionComponentConstituent datatype record.

Fields

hasIngredient? CodeableReference[] - The ingredient that is the constituent of the given component.

amount? Quantity[] - The measurable amount of the substance, expressable in different ways (e.g. by mass or volume).

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept[] - The function of this constituent within the component e.g. binder.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

location? CodeableConcept[] - The physical location of the constituent/ingredient within the component. Example – if the component is the bead in the capsule, then the location would be where the ingredient resides within the product part – intragranular, extra-granular, 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.r5.international500: ManufacturedItemDefinitionProperty

Closed record

FHIR ManufacturedItemDefinitionProperty datatype record.

Fields

valueCodeableConcept? CodeableConcept - A value for the characteristic.

valueBoolean? boolean - A value for the characteristic.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMarkdown? markdown - A value for the characteristic.

valueAttachment? Attachment - A value for the characteristic.

valueReference? Reference - A value for the characteristic.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

valueDate? date - A value for the characteristic.

'type CodeableConcept - A code expressing the type of characteristic.

valueQuantity? Quantity - A value for the characteristic.

health.fhir.r5.international500: MarketingStatus

Closed record

Fields

id? string -

extension? Extension[] -

country? CodeableConcept -

dateRange? Period -

modifierExtension? Extension[] -

jurisdiction? CodeableConcept -

status CodeableConcept -

restoreDate? dateTime -

health.fhir.r5.international500: Measure

FHIR Measure resource record.

Fields

resourceType RESOURCE_NAME_MEASURE(default RESOURCE_NAME_MEASURE) - The type of the resource describes

date? dateTime - The date (and optionally time) when the measure was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.

copyright? markdown - A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description, from a clinical perspective, of how the measure is used.

experimental? boolean - A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

'type? CodeableConcept[] - Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.

riskAdjustment? markdown - A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

group? MeasureGroup[] - A group of population criteria for the measure.

identifier? Identifier[] - A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the measure content was or is planned to be in active use.

rateAggregation? markdown - Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

compositeScoring? CodeableConcept - If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.

supplementalData? MeasureSupplementalData[] - The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

basis? code - The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.

'version? string - The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the measure giving additional information about its content.

name? string - A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the measure.

topic? CodeableConcept[] - Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.

status MeasureStatus - The status of this measure. Enables tracking the life-cycle of the content.

clinicalRecommendationStatement? markdown - Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

purpose? markdown - Explanation of why this measure is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the measure is intended to be used.

description? markdown - A free text natural language description of the measure from a consumer's perspective.

improvementNotation? CodeableConcept - Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).

title? string - A short, descriptive, user-friendly title for the measure.

library? canonical[] - A reference to a Library resource containing the formal logic used by the measure.

term? MeasureTerm[] - Provides a description of an individual term used within the measure.

disclaimer? markdown - Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

scoring? CodeableConcept - Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

rationale? markdown - Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.

subjectReference? Reference - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

url? uri - An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

guidance? markdown - Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

scoringUnit? CodeableConcept - Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.

Element... - Rest field

health.fhir.r5.international500: MeasureGroup

Closed record

FHIR MeasureGroup datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

scoring? CodeableConcept - Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.

code? CodeableConcept - Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.

rateAggregation? markdown - Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.

subjectCodeableConcept? CodeableConcept - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - The human readable description of this population group.

improvementNotation? CodeableConcept - Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).

basis? code - The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.

'type? CodeableConcept[] - Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.

subjectReference? Reference - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

population? MeasureGroupPopulation[] - A population criteria for the measure.

library? canonical[] - A reference to a Library resource containing the formal logic used by the measure group.

linkId? string - An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.

stratifier? MeasureGroupStratifier[] - The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

scoringUnit? CodeableConcept - Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.

health.fhir.r5.international500: MeasureGroupPopulation

Closed record

FHIR MeasureGroupPopulation datatype record.

Fields

aggregateMethod? CodeableConcept - Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation.

inputPopulationId? string - The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The type of population criteria.

linkId? string - An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource.

criteria? Expression - An expression that specifies the criteria for the population, typically the name of an expression in a library.

groupDefinition? Reference - A Group resource that defines this population as a set of characteristics.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - The human readable description of this population criteria.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MeasureGroupStratifier

Closed record

FHIR MeasureGroupStratifier datatype record.

Fields

component? MeasureGroupStratifierComponent[] - A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.

linkId? string - An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.

criteria? Expression - An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.

groupDefinition? Reference - A Group resource that defines this population as a set of characteristics.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - The human readable description of this stratifier criteria.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MeasureGroupStratifierComponent

Closed record

FHIR MeasureGroupStratifierComponent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.

linkId? string - An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.

criteria? Expression - An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.

groupDefinition? Reference - A Group resource that defines this population as a set of characteristics.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - The human readable description of this stratifier criteria component.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MeasureReport

FHIR MeasureReport resource record.

Fields

resourceType RESOURCE_NAME_MEASUREREPORT(default RESOURCE_NAME_MEASUREREPORT) - The type of the resource describes

date? dateTime - The date this measure was calculated.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Optional subject identifying the individual or individuals the report is for.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

improvementNotation? CodeableConcept - Whether improvement in the measure is noted by an increase or decrease in the measure score.

language? code - The base language in which the resource is written.

'type MeasureReportType - The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.

inputParameters? Reference - A reference to a Parameters resource (typically represented using a contained resource) that represents any input parameters that were provided to the operation that generated the report.

evaluatedResource? Reference[] - Evaluated resources are used to capture what data was involved in the calculation of a measure. This usage is only allowed for individual reports to ensure that the size of the MeasureReport resource is bounded.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

group? MeasureReportGroup[] - The results of the calculation, one for each population group in the measure.

identifier? Identifier[] - A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.

period Period - The reporting period for which the report was calculated.

scoring? CodeableConcept - Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. It is expected to be the same as the scoring element on the referenced Measure.

supplementalData? Reference[] - A reference to a Resource that represents additional information collected for the report. If the value of the supplemental data is not a Resource (i.e. evaluating the supplementalData expression for this case in the measure results in a value that is not a FHIR Resource), it is reported as a reference to a contained Observation resource.

reporter? Reference - The individual or organization that is reporting the data.

dataUpdateType? MeasureReportDataUpdateType - Indicates whether the data submitted in a data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.

reportingVendor? Reference - A reference to the vendor who queried the data, calculated results and/or generated the report. The ‘reporting vendor’ is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

measure? canonical - A reference to the Measure that was calculated to produce this report.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? Reference - A reference to the location for which the data is being reported.

status MeasureReportStatus - The MeasureReport status. No data will be available until the MeasureReport status is complete.

Element... - Rest field

health.fhir.r5.international500: MeasureReportGroup

Closed record

FHIR MeasureReportGroup datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The meaning of the population group as defined in the measure definition.

subject? Reference - Optional subject identifying the individual or individuals the report is for.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

measureScoreDuration? Duration - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

measureScoreCodeableConcept? CodeableConcept - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

population? MeasureReportGroupPopulation[] - The populations that make up the population group, one for each type of population appropriate for the measure.

linkId? string - The group from the Measure that corresponds to this group in the MeasureReport resource.

measureScorePeriod? Period - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

measureScoreDateTime? dateTime - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

stratifier? MeasureReportGroupStratifier[] - When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.

measureScoreQuantity? Quantity - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

measureScoreRange? Range - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

health.fhir.r5.international500: MeasureReportGroupPopulation

Closed record

FHIR MeasureReportGroupPopulation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The type of the population.

linkId? string - The population from the Measure that corresponds to this population in the MeasureReport 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subjects? Reference - Optional Group identifying the individuals that make up the population.

count? integer - The number of members of the population.

subjectResults? Reference - This element refers to a List of individual level MeasureReport resources, one for each subject in this population.

subjectReport? Reference[] - A reference to an individual level MeasureReport resource for a member of the population.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MeasureReportGroupStratifier

Closed record

FHIR MeasureReportGroupStratifier datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The meaning of this stratifier, as defined in the measure definition.

linkId? string - The stratifier from the Measure that corresponds to this stratifier in the MeasureReport 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

stratum? MeasureReportGroupStratifierStratum[] - This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.

health.fhir.r5.international500: MeasureReportGroupStratifierStratum

Closed record

FHIR MeasureReportGroupStratifierStratum datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMeasureReportRange? Range - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

valueMeasureReportBoolean? boolean - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

measureScoreMeasureReportDuration? Duration - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

measureScoreMeasureReportCodeableConcept? CodeableConcept - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

valueMeasureReportQuantity? Quantity - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

population? MeasureReportGroupStratifierStratumPopulation[] - The populations that make up the stratum, one for each type of population appropriate to the measure.

measureScoreMeasureReportQuantity? Quantity - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

component? MeasureReportGroupStratifierStratumComponent[] - A stratifier component value.

valueMeasureReportCodeableConcept? CodeableConcept - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

valueMeasureReportReference? Reference - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

measureScoreMeasureReportPeriod? Period - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

measureScoreMeasureReportDateTime? dateTime - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

measureScoreMeasureReportRange? Range - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

health.fhir.r5.international500: MeasureReportGroupStratifierStratumComponent

Closed record

FHIR MeasureReportGroupStratifierStratumComponent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMeasureReportCodeableConcept CodeableConcept - The stratum component value.

valueMeasureReportRange Range - The stratum component value.

valueMeasureReportReference Reference - The stratum component value.

code CodeableConcept - The code for the stratum component value.

linkId? string - The stratifier component from the Measure that corresponds to this stratifier component in the MeasureReport resource.

valueMeasureReportBoolean boolean - The stratum component value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

valueMeasureReportQuantity Quantity - The stratum component value.

health.fhir.r5.international500: MeasureReportGroupStratifierStratumPopulation

Closed record

FHIR MeasureReportGroupStratifierStratumPopulation datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The type of the population.

linkId? string - The population from the Measure that corresponds to this population in the MeasureReport 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

subjects? Reference - Optional Group identifying the individuals that make up the population.

count? integer - The number of members of the population in this stratum.

subjectResults? Reference - This element refers to a List of individual level MeasureReport resources, one for each subject in this population in this stratum.

subjectReport? Reference[] - A reference to an individual level MeasureReport resource for a member of the population.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MeasureSupplementalData

Closed record

FHIR MeasureSupplementalData datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures.

linkId? string - An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.

criteria Expression - The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

usage? CodeableConcept[] - An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.

description? markdown - The human readable description of this supplemental data.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MeasureTerm

Closed record

FHIR MeasureTerm datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A codeable representation of the defined term.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? markdown - Provides a definition for the term as used within the measure.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: Medication

FHIR Medication resource record.

Fields

resourceType RESOURCE_NAME_MEDICATION(default RESOURCE_NAME_MEDICATION) - The type of the resource describes

totalVolume? Quantity - When the specified product code does not infer a package size, this is the specific amount of drug in the product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

identifier? Identifier[] - Business identifier for this medication.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

ingredient? MedicationIngredient[] - Identifies a particular constituent of interest in the product.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

batch? MedicationBatch - Information that only applies to packages (not products).

language? code - The base language in which the resource is written.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

doseForm? CodeableConcept - Describes the form of the item. Powder; tablets; capsule.

marketingAuthorizationHolder? Reference - The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).

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.

definition? Reference - A reference to a knowledge resource that provides more information about this medication.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status? MedicationStatus - A code to indicate if the medication is in active use.

Element... - Rest field

health.fhir.r5.international500: MedicationAdministration

FHIR MedicationAdministration resource record.

Fields

resourceType RESOURCE_NAME_MEDICATIONADMINISTRATION(default RESOURCE_NAME_MEDICATIONADMINISTRATION) - The type of the resource describes

dosage? MedicationAdministrationDosage - Describes the medication dosage information details e.g. dose, rate, site, route, etc.

note? Annotation[] - Extra information about the medication administration that is not conveyed by the other attributes.

partOf? Reference[] - A larger event of which this particular event is a component or step.

reason? CodeableReference[] - A code, Condition or observation that supports why the medication was administered.

request? Reference - The original request, instruction or authority to perform the administration.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject Reference - The person or animal or group receiving the medication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

isSubPotent? boolean - An indication that the full dose was not administered.

statusReason? CodeableConcept[] - A code indicating why the administration was not performed.

occurenceTiming Timing - A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - A plan that is fulfilled in whole or in part by this MedicationAdministration.

identifier? Identifier[] - Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

performer? MedicationAdministrationPerformer[] - The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.

occurenceDateTime dateTime - A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

supportingInformation? Reference[] - Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says 'give 'x' if the heartrate exceeds 'y'', then the heart rate can be included using this attribute.

medication CodeableReference - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

encounter? Reference - The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.

recorded? dateTime - The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

subPotentReason? CodeableConcept[] - The reason or reasons why the full dose was not administered.

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.

occurencePeriod Period - A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

eventHistory? Reference[] - A summary of the events of interest that have occurred, such as when the administration was verified.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).

device? CodeableReference[] - The device that is to be used for the administration of the medication (for example, PCA Pump).

status MedicationAdministrationStatus - Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.

Element... - Rest field

health.fhir.r5.international500: MedicationAdministrationDosage

Closed record

FHIR MedicationAdministrationDosage datatype record.

Fields

dose? Quantity - The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

rateRatio? Ratio - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

site? CodeableConcept - A coded specification of the anatomic site where the medication first entered the body. For example, 'left arm'.

route? CodeableConcept - A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

method? CodeableConcept - A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.

rateQuantity? Quantity - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.

health.fhir.r5.international500: MedicationAdministrationPerformer

Closed record

FHIR MedicationAdministrationPerformer datatype record.

Fields

actor CodeableReference - Indicates who or what performed the medication administration.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of involvement of the performer in the medication administration.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicationBatch

Closed record

FHIR MedicationBatch datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

lotNumber? string - The assigned lot number of a batch of the specified product.

expirationDate? dateTime - When this specific batch of product will expire.

health.fhir.r5.international500: MedicationDispense

FHIR MedicationDispense resource record.

Fields

resourceType RESOURCE_NAME_MEDICATIONDISPENSE(default RESOURCE_NAME_MEDICATIONDISPENSE) - The type of the resource describes

note? Annotation[] - Extra information about the dispense that could not be conveyed in the other attributes.

partOf? Reference[] - The procedure or medication administration that triggered the dispense.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

notPerformedReason? CodeableReference - Indicates the reason why a dispense was not performed.

substitution? MedicationDispenseSubstitution - Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

subject Reference - A link to a resource representing the person or the group to whom the medication will be given.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

destination? Reference - Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event.

language? code - The base language in which the resource is written.

'type? CodeableConcept - Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

renderedDosageInstruction? markdown - The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

statusChanged? dateTime - The date (and maybe time) when the status of the dispense record changed.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

authorizingPrescription? Reference[] - Indicates the medication order that is being dispensed against.

basedOn? Reference[] - A plan that is fulfilled in whole or in part by this MedicationDispense.

identifier? Identifier[] - Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

performer? MedicationDispensePerformer[] - Indicates who or what performed the event.

quantity? SimpleQuantity - The amount of medication that has been dispensed. Includes unit of measure.

receiver? Reference[] - Identifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.

whenPrepared? dateTime - The time when the dispensed product was packaged and reviewed.

daysSupply? SimpleQuantity - The amount of medication expressed as a timing amount.

supportingInformation? Reference[] - Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.

whenHandedOver? dateTime - The time the dispensed product was provided to the patient or their representative.

medication CodeableReference - Identifies the medication supplied. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

encounter? Reference - The encounter that establishes the context for this event.

recorded? dateTime - The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

dosageInstruction? Dosage[] - Indicates how the medication is to be used by the patient.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

eventHistory? Reference[] - A summary of the events of interest that have occurred, such as when the dispense was verified.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? Reference - The principal physical location where the dispense was performed.

category? CodeableConcept[] - Indicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).

status MedicationDispenseStatus - A code specifying the state of the set of dispense events.

Element... - Rest field

health.fhir.r5.international500: MedicationDispensePerformer

Closed record

FHIR MedicationDispensePerformer datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicationDispenseSubstitution

Closed record

FHIR MedicationDispenseSubstitution datatype record.

Fields

reason? CodeableConcept[] - Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

wasSubstituted boolean - True if the dispenser dispensed a different drug or product from what was prescribed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

responsibleParty? Reference - The person or organization that has primary responsibility for the substitution.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - A code signifying whether a different drug was dispensed from what was prescribed.

health.fhir.r5.international500: MedicationIngredient

Closed record

FHIR MedicationIngredient datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item CodeableReference - The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).

strengthRatio? Ratio - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

strengthQuantity? Quantity - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

strengthCodeableConcept? CodeableConcept - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

isActive? boolean - Indication of whether this ingredient affects the therapeutic action of the drug.

health.fhir.r5.international500: MedicationKnowledge

FHIR MedicationKnowledge resource record.

Fields

resourceType RESOURCE_NAME_MEDICATIONKNOWLEDGE(default RESOURCE_NAME_MEDICATIONKNOWLEDGE) - The type of the resource describes

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

clinicalUseIssue? Reference[] - Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

regulatory? MedicationKnowledgeRegulatory[] - Regulatory information about a medication.

medicineClassification? MedicationKnowledgeMedicineClassification[] - Categorization of the medication within a formulary or classification system.

storageGuideline? MedicationKnowledgeStorageGuideline[] - Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.

associatedMedication? Reference[] - Links to associated medications that could be prescribed, dispensed or administered.

language? code - The base language in which the resource is written.

intendedJurisdiction? CodeableConcept[] - Lists the jurisdictions that this medication knowledge was written for.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relatedMedicationKnowledge? MedicationKnowledgeRelatedMedicationKnowledge[] - Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.

productType? CodeableConcept[] - Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

identifier? Identifier[] - Business identifier for this medication.

cost? MedicationKnowledgeCost[] - The price of the medication.

indicationGuideline? MedicationKnowledgeIndicationGuideline[] - Guidelines or protocols that are applicable for the administration of the medication based on indication.

author? Reference - The creator or owner of the knowledge or information about the medication.

preparationInstruction? markdown - The instructions for preparing the medication.

packaging? MedicationKnowledgePackaging[] - Information that only applies to packages (not products).

monitoringProgram? MedicationKnowledgeMonitoringProgram[] - The program under which the medication is reviewed.

definitional? MedicationKnowledgeDefinitional - Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

monograph? MedicationKnowledgeMonograph[] - Associated documentation about the medication.

name? string[] - All of the names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

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.

status? MedicationKnowledgeStatus - A code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system. The status refers to the validity about the information of the medication and not to its medicinal properties.

Element... - Rest field

health.fhir.r5.international500: MedicationKnowledgeCost

Closed record

FHIR MedicationKnowledgeCost datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

costMoney Money - The price or representation of the cost (for example, Band A, Band B or $, $$) of the medication.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source? string - The source or owner that assigns the price to the medication.

'type CodeableConcept - The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.

costCodeableConcept CodeableConcept - The price or representation of the cost (for example, Band A, Band B or $, $$) of the medication.

effectiveDate? Period[] - The date range for which the cost information of the medication is effective.

health.fhir.r5.international500: MedicationKnowledgeDefinitional

Closed record

FHIR MedicationKnowledgeDefinitional datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

intendedRoute? CodeableConcept[] - The intended or approved route of administration.

ingredient? MedicationKnowledgeDefinitionalIngredient[] - Identifies a particular constituent of interest in the product.

drugCharacteristic? MedicationKnowledgeDefinitionalDrugCharacteristic[] - Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

doseForm? CodeableConcept - Describes the form of the item. Powder; tablets; capsule.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? Reference[] - Associated definitions for this medication.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MedicationKnowledgeDefinitionalDrugCharacteristic

Closed record

FHIR MedicationKnowledgeDefinitionalDrugCharacteristic datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMedicationKnowledgeString? string - Description of the characteristic.

valueMedicationKnowledgeQuantity? Quantity - Description of the characteristic.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueMedicationKnowledgeBase64Binary? base64Binary - Description of the characteristic.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).

valueMedicationKnowledgeCodeableConcept? CodeableConcept - Description of the characteristic.

valueMedicationKnowledgeAttachment? Attachment - Description of the characteristic.

health.fhir.r5.international500: MedicationKnowledgeDefinitionalIngredient

Closed record

FHIR MedicationKnowledgeDefinitionalIngredient datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item CodeableReference - A reference to the resource that provides information about the ingredient.

strengthMedicationKnowledgeCodeableConcept? CodeableConcept - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

strengthMedicationKnowledgeRatio? Ratio - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

strengthMedicationKnowledgeQuantity? Quantity - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

'type? CodeableConcept - Indication of whether this ingredient affects the therapeutic action of the drug.

health.fhir.r5.international500: MedicationKnowledgeIndicationGuideline

Closed record

FHIR MedicationKnowledgeIndicationGuideline datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

dosingGuideline? MedicationKnowledgeIndicationGuidelineDosingGuideline[] - The guidelines for the dosage of the medication for the indication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

indication? CodeableReference[] - Indication or reason for use of the medication that applies to the specific administration guideline.

health.fhir.r5.international500: MedicationKnowledgeIndicationGuidelineDosingGuideline

Closed record

FHIR MedicationKnowledgeIndicationGuidelineDosingGuideline datatype record.

Fields

administrationTreatment? CodeableConcept - The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.

dosage? MedicationKnowledgeIndicationGuidelineDosingGuidelineDosage[] - Dosage for the medication for the specific guidelines.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patientCharacteristic? MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristic[] - Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).

treatmentIntent? CodeableConcept - The overall intention of the treatment, for example, prophylactic, supporative, curative, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicationKnowledgeIndicationGuidelineDosingGuidelineDosage

Closed record

FHIR MedicationKnowledgeIndicationGuidelineDosingGuidelineDosage datatype record.

Fields

dosage Dosage[] - Dosage for the medication for the specific guidelines.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).

health.fhir.r5.international500: MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristic

Closed record

FHIR MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristic datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMedicationKnowledgeRange? Range - The specific characteristic (e.g. height, weight, gender, etc.).

valueMedicationKnowledgeQuantity? Quantity - The specific characteristic (e.g. height, weight, gender, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

valueMedicationKnowledgeCodeableConcept? CodeableConcept - The specific characteristic (e.g. height, weight, gender, etc.).

health.fhir.r5.international500: MedicationKnowledgeMedicineClassification

Closed record

FHIR MedicationKnowledgeMedicineClassification datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

sourceUri? uri - Either a textual source of the classification or a reference to an online source.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

sourceString? string - Either a textual source of the classification or a reference to an online source.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

classification? CodeableConcept[] - Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).

'type CodeableConcept - The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).

health.fhir.r5.international500: MedicationKnowledgeMonitoringProgram

Closed record

FHIR MedicationKnowledgeMonitoringProgram datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name? string - Name of the reviewing program.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Type of program under which the medication is monitored.

health.fhir.r5.international500: MedicationKnowledgeMonograph

Closed record

FHIR MedicationKnowledgeMonograph datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source? Reference - Associated documentation about the medication.

'type? CodeableConcept - The category of documentation about the medication. (e.g. professional monograph, patient education monograph).

health.fhir.r5.international500: MedicationKnowledgePackaging

Closed record

FHIR MedicationKnowledgePackaging datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

packagedProduct? Reference - A reference to a PackagedProductDefinition that provides the details of the product that is in the packaging and is being priced.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicationKnowledgeRegulatory

Closed record

FHIR MedicationKnowledgeRegulatory datatype record.

Fields

schedule? CodeableConcept[] - Specifies the schedule of a medication in jurisdiction.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

substitution? MedicationKnowledgeRegulatorySubstitution[] - Specifies if changes are allowed when dispensing a medication from a regulatory perspective.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

maxDispense? MedicationKnowledgeRegulatoryMaxDispense - The maximum number of units of the medication that can be dispensed in a period.

regulatoryAuthority Reference - The authority that is specifying the regulations.

health.fhir.r5.international500: MedicationKnowledgeRegulatoryMaxDispense

Closed record

FHIR MedicationKnowledgeRegulatoryMaxDispense datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Duration - The period that applies to the maximum number of units.

quantity Quantity - The maximum number of units of the medication that can be dispensed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicationKnowledgeRegulatorySubstitution

Closed record

FHIR MedicationKnowledgeRegulatorySubstitution datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

allowed boolean - Specifies if regulation allows for changes in the medication when dispensing.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Specifies the type of substitution allowed.

health.fhir.r5.international500: MedicationKnowledgeRelatedMedicationKnowledge

Closed record

FHIR MedicationKnowledgeRelatedMedicationKnowledge datatype record.

Fields

reference Reference[] - Associated documentation about the associated medication knowledge.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The category of the associated medication knowledge reference.

health.fhir.r5.international500: MedicationKnowledgeStorageGuideline

Closed record

FHIR MedicationKnowledgeStorageGuideline datatype record.

Fields

reference? uri - Reference to additional information about the storage guidelines.

note? Annotation[] - Additional notes about the storage.

stabilityDuration? Duration - Duration that the medication remains stable if the environmentalSetting is respected.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

environmentalSetting? MedicationKnowledgeStorageGuidelineEnvironmentalSetting[] - Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.

health.fhir.r5.international500: MedicationKnowledgeStorageGuidelineEnvironmentalSetting

Closed record

FHIR MedicationKnowledgeStorageGuidelineEnvironmentalSetting datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMedicationKnowledgeRange Range - Value associated to the setting. E.g., 40° – 50°F for temperature.

valueMedicationKnowledgeQuantity Quantity - Value associated to the setting. E.g., 40° – 50°F for temperature.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Identifies the category or type of setting (e.g., type of location, temperature, humidity).

valueMedicationKnowledgeCodeableConcept CodeableConcept - Value associated to the setting. E.g., 40° – 50°F for temperature.

health.fhir.r5.international500: MedicationRequest

FHIR MedicationRequest resource record.

Fields

resourceType RESOURCE_NAME_MEDICATIONREQUEST(default RESOURCE_NAME_MEDICATIONREQUEST) - The type of the resource describes

insurance? Reference[] - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

note? Annotation[] - Extra information about the prescription that could not be conveyed by the other attributes.

reason? CodeableReference[] - The reason or the indication for ordering or not ordering the medication.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

substitution? MedicationRequestSubstitution - Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

courseOfTherapyType? CodeableConcept - The description of the overall pattern of the administration of the medication to the patient.

priorPrescription? Reference - Reference to an order/prescription that is being replaced by this MedicationRequest.

subject Reference - The individual or group for whom the medication has been requested.

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 managable, 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.

statusReason? CodeableConcept - Captures the reason for the current state of the MedicationRequest.

dispenseRequest? MedicationRequestDispenseRequest - Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

informationSource? Reference[] - The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.

renderedDosageInstruction? markdown - The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

reported? boolean - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

statusChanged? dateTime - The date (and perhaps time) when the status was changed.

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 - If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.

basedOn? Reference[] - A plan or request that is fulfilled in whole or in part by this medication request.

requester? Reference - The individual, organization, or device that initiated the request and has responsibility for its activation.

identifier? Identifier[] - Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

recorder? Reference - The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

authoredOn? dateTime - The date (and perhaps time) when the prescription was initially written or authored on.

performer? Reference[] - The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.

supportingInformation? Reference[] - Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).

medication CodeableReference - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

encounter? Reference - The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

priority? MedicationRequestPriority - Indicates how quickly the Medication Request should be addressed with respect to other requests.

intent MedicationRequestIntent - Whether the request is a proposal, plan, or an original order.

performerType? CodeableConcept - Indicates the type of performer of the administration of the medication.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

dosageInstruction? Dosage[] - Specific instructions for how the medication is to be used by the patient.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

eventHistory? Reference[] - Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.

groupIdentifier? Identifier - A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

device? CodeableReference[] - The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).

effectiveDosePeriod? Period - The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.

status MedicationRequestStatus - A code specifying the current state of the order. Generally, this will be active or completed state.

Element... - Rest field

health.fhir.r5.international500: MedicationRequestDispenseRequest

Closed record

FHIR MedicationRequestDispenseRequest datatype record.

Fields

dispenser? Reference - Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.

dispenserInstruction? Annotation[] - Provides additional information to the dispenser, for example, counselling to be provided to the patient.

validityPeriod? Period - This indicates the validity period of a prescription (stale dating the Prescription).

dispenseInterval? Duration - The minimum period of time that must occur between dispenses of the medication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The amount that is to be dispensed for one fill.

numberOfRepeatsAllowed? unsignedInt - An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus '3 repeats', then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

doseAdministrationAid? CodeableConcept - Provides information about the type of adherence packaging to be supplied for the medication dispense.

initialFill? MedicationRequestDispenseRequestInitialFill - Indicates the quantity or duration for the first dispense of the medication.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

expectedSupplyDuration? Duration - Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

health.fhir.r5.international500: MedicationRequestDispenseRequestInitialFill

Closed record

FHIR MedicationRequestDispenseRequestInitialFill datatype record.

Fields

duration? Duration - The length of time that the first dispense is expected to last.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The amount or quantity to provide as part of the first dispense.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicationRequestSubstitution

Closed record

FHIR MedicationRequestSubstitution datatype record.

Fields

allowedCodeableConcept CodeableConcept - True if the prescriber allows a different drug to be dispensed from what was prescribed.

reason? CodeableConcept - Indicates the reason for the substitution, or why substitution must or must not be performed.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

allowedBoolean boolean - True if the prescriber allows a different drug to be dispensed from what was prescribed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MedicationStatement

FHIR MedicationStatement resource record.

Fields

resourceType RESOURCE_NAME_MEDICATIONSTATEMENT(default RESOURCE_NAME_MEDICATIONSTATEMENT) - The type of the resource describes

dosage? Dosage[] - Indicates how the medication is/was or should be taken by the patient.

note? Annotation[] - Provides extra information about the Medication Statement that is not conveyed by the other attributes.

partOf? Reference[] - A larger event of which this particular MedicationStatement is a component or step.

reason? CodeableReference[] - A concept, Condition or observation that supports why the medication is being/was taken.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject Reference - The person, animal or group who is/was taking the medication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

informationSource? Reference[] - The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.

renderedDosageInstruction? markdown - The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

derivedFrom? Reference[] - Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

dateAsserted? dateTime - The date when the Medication Statement was asserted by the information source.

identifier? Identifier[] - Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

effectivePeriod? Period - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.adherence element is Not Taking).

effectiveTiming? Timing - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.adherence element is Not Taking).

adherence? MedicationStatementAdherence - Indicates whether the medication is or is not being consumed or administered.

relatedClinicalInformation? Reference[] - Link to information that is relevant to a medication statement, for example, illicit drug use, gestational age, etc.

medication CodeableReference - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

encounter? Reference - The encounter that establishes the context for this MedicationStatement.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

effectiveDateTime? dateTime - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.adherence element is Not Taking).

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category? CodeableConcept[] - Type of medication statement (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).

status MedicationStatementStatus - A code representing the status of recording the medication statement.

Element... - Rest field

health.fhir.r5.international500: MedicationStatementAdherence

Closed record

FHIR MedicationStatementAdherence datatype record.

Fields

reason? CodeableConcept - Captures the reason for the current use or adherence of a medication.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Type of the adherence for the medication.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: MedicinalProductDefinition

FHIR MedicinalProductDefinition resource record.

Fields

resourceType RESOURCE_NAME_MEDICINALPRODUCTDEFINITION(default RESOURCE_NAME_MEDICINALPRODUCTDEFINITION) - The type of the resource describes

statusDate? dateTime - The date at which the given status became applicable.

attachedDocument? Reference[] - Additional information or supporting documentation about the medicinal 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

impurity? CodeableReference[] - Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products.

code? Coding[] - A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e. not the manufacturer or regulator). Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations.

crossReference? MedicinalProductDefinitionCrossReference[] - Reference to another product, e.g. for linking authorised to investigational product, or a virtual 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 managable, 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 - General description of this product.

language? code - The base language in which the resource is written.

'type? CodeableConcept - Regulatory type, e.g. Investigational or Authorized.

pediatricUseIndicator? CodeableConcept - If authorised for use in children, or infants, neonates etc.

characteristic? MedicinalProductDefinitionCharacteristic[] - Allows the key product features to be recorded, such as 'sugar free', 'modified release', 'parallel import'.

marketingStatus? MarketingStatus[] - Marketing status of the medicinal product, in contrast to marketing authorization. This refers to the product being actually 'on the market' as opposed to being allowed to be on the market (which is an authorization).

masterFile? Reference[] - A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products.

contact? MedicinalProductDefinitionContact[] - A product specific contact, person (in a role), or an organization.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - Business identifier for this product. Could be an MPID. When in development or being regulated, products are typically referenced by official identifiers, assigned by a manufacturer or regulator, and unique to a product (which, when compared to a product instance being prescribed, is actually a product type). See also MedicinalProductDefinition.code.

ingredient? CodeableConcept[] - The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes.

comprisedOf? Reference[] - Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes. Used as a direct link when the item's packaging is not being recorded (see also PackagedProductDefinition.package.containedItem.item).

additionalMonitoringIndicator? CodeableConcept - Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements.

classification? CodeableConcept[] - Allows the product to be classified by various systems, commonly WHO ATC.

packagedMedicinalProduct? CodeableConcept[] - Package type for the product. See also the PackagedProductDefinition resource.

'version? string - A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.

specialMeasures? CodeableConcept[] - Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorization studies.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

route? CodeableConcept[] - The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. See also AdministrableProductDefinition resource. MedicinalProductDefinition.route is the same concept as AdministrableProductDefinition.routeOfAdministration.code, and they cannot be used together.

legalStatusOfSupply? CodeableConcept - The legal status of supply of the medicinal product as classified by the regulator.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

domain? CodeableConcept - If this medicine applies to human or veterinary uses.

name MedicinalProductDefinitionName[] - The product's name, including full name and possibly coded parts.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

indication? markdown - Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.

operation? MedicinalProductDefinitionOperation[] - A manufacturing or administrative process or step associated with (or performed on) the medicinal product.

clinicalTrial? Reference[] - Clinical trials or studies that this product is involved in.

combinedPharmaceuticalDoseForm? CodeableConcept - The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm).

status? CodeableConcept - The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status.

Element... - Rest field

health.fhir.r5.international500: MedicinalProductDefinitionCharacteristic

Closed record

FHIR MedicinalProductDefinitionCharacteristic datatype record.

Fields

valueCodeableConcept? CodeableConcept - A value for the characteristic.text.

valueBoolean? boolean - A value for the characteristic.text.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueMarkdown? markdown - A value for the characteristic.text.

valueAttachment? Attachment - A value for the characteristic.text.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

valueDate? date - A value for the characteristic.text.

'type CodeableConcept - A code expressing the type of characteristic.

valueInteger? integer - A value for the characteristic.text.

valueQuantity? Quantity - A value for the characteristic.text.

health.fhir.r5.international500: MedicinalProductDefinitionContact

Closed record

FHIR MedicinalProductDefinitionContact datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

contact Reference - A product specific contact, person (in a role), or an organization.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 - Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information.

health.fhir.r5.international500: MedicinalProductDefinitionCrossReference

Closed record

FHIR MedicinalProductDefinitionCrossReference datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

product CodeableReference - Reference to another product, e.g. for linking authorised to investigational product.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - The type of relationship, for instance branded to generic, virtual to actual product, product to development product (investigational), parallel import version.

health.fhir.r5.international500: MedicinalProductDefinitionName

Closed record

FHIR MedicinalProductDefinitionName datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

part? MedicinalProductDefinitionNamePart[] - Coding words or phrases of the name.

usage? MedicinalProductDefinitionNameUsage[] - Country and jurisdiction where the name applies, and associated language.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept - Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary.

productName string - The full product name.

health.fhir.r5.international500: MedicinalProductDefinitionNamePart

Closed record

FHIR MedicinalProductDefinitionNamePart datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

part string - A fragment of a product name.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Identifying type for this part of the name (e.g. strength part).

health.fhir.r5.international500: MedicinalProductDefinitionNameUsage

Closed record

FHIR MedicinalProductDefinitionNameUsage datatype record.

Fields

country CodeableConcept - Country code for where this name applies.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

jurisdiction? CodeableConcept - Jurisdiction code for where this name applies. A jurisdiction may be a sub- or supra-national entity (e.g. a state or a geographic region).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language CodeableConcept - Language code for this name.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MedicinalProductDefinitionOperation

Closed record

FHIR MedicinalProductDefinitionOperation datatype record.

Fields

confidentialityIndicator? CodeableConcept - Specifies whether this particular business or manufacturing process is considered proprietary or confidential.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

organization? Reference[] - The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent.

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? CodeableReference - The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here.

effectiveDate? Period - Date range of applicability.

health.fhir.r5.international500: MessageDefinition

FHIR MessageDefinition resource record.

Fields

resourceType RESOURCE_NAME_MESSAGEDEFINITION(default RESOURCE_NAME_MESSAGEDEFINITION) - The type of the resource describes

date dateTime - The date (and optionally time) when the message definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.

parent? canonical[] - Identifies a protocol or workflow that this MessageDefinition represents a step in.

copyright? markdown - A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

purpose? markdown - Explanation of why this message definition is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the message definition is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

description? markdown - A free text natural language description of the message definition from a consumer's perspective.

focus? MessageDefinitionFocus[] - Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

experimental? boolean - A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the message definition.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

allowedResponse? MessageDefinitionAllowedResponse[] - Indicates what types of messages may be sent as an application-level response to this message.

eventUri uri - Event code or link to the EventDefinition.

identifier? Identifier[] - A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

replaces? canonical[] - A MessageDefinition that is superseded by this definition.

eventCoding Coding - Event code or link to the EventDefinition.

'version? string - The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

graph? canonical - Graph is Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what additional resources are to be added to the Bundle when building the message. The GraphDefinition can also specify profiles that apply to the various resources.

responseRequired? MessageDefinitionResponseRequired - Declare at a message definition level whether a response is required or only upon error or success, or never.

url? uri - The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the message definition.

category? MessageDefinitionCategory - The impact of the content of the message.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.

base? canonical - The MessageDefinition that is the basis for the contents of this resource.

status MessageDefinitionStatus - The status of this message definition. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: MessageDefinitionAllowedResponse

Closed record

FHIR MessageDefinitionAllowedResponse datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

message canonical - A reference to the message definition that must be adhered to by this supported response.

situation? markdown - Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).

health.fhir.r5.international500: MessageDefinitionFocus

Closed record

FHIR MessageDefinitionFocus datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code - The kind of resource that must be the focus for this message.

min unsignedInt - Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.

max? string - Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

profile? canonical - A profile that reflects constraints for the focal resource (and potentially for related resources).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MessageHeader

FHIR MessageHeader resource record.

Fields

resourceType RESOURCE_NAME_MESSAGEHEADER(default RESOURCE_NAME_MESSAGEHEADER) - The type of the resource describes

reason? CodeableConcept - Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

eventCanonical canonical - Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.

author? Reference - The logical author of the message - the personor device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

destination? MessageHeaderDestination[] - The destination application which the message is intended for.

focus? Reference[] - The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.

language? code - The base language in which the resource is written.

'source MessageHeaderSource - The source application from which this message originated.

eventCoding Coding - Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

sender? Reference - Identifies the sending system to allow the use of a trust relationship.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

response? MessageHeaderResponse - Information about the message that this message is a response to. Only present if this message is a response.

responsible? Reference - The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

definition? canonical - Permanent link to the MessageDefinition for this message.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Element... - Rest field

health.fhir.r5.international500: MessageHeaderDestination

Closed record

FHIR MessageHeaderDestination datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

endpointReference? Reference - Indicates where the message should be routed.

receiver? Reference - Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

endpointUrl? urlType - Indicates where the message should be routed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name? string - Human-readable name for the target system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target? Reference - Identifies the target end system in situations where the initial message transmission is to an intermediary system.

health.fhir.r5.international500: MessageHeaderResponse

Closed record

FHIR MessageHeaderResponse datatype record.

Fields

identifier Identifier - The Bundle.identifier of the message to which this message is a response.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code MessageHeaderResponseCode - Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

details? Reference - Full details of any issues found in the message.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MessageHeaderSource

Closed record

FHIR MessageHeaderSource datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

endpointReference? Reference - Identifies the routing target to send acknowledgements to.

software? string - May include configuration or other information useful in debugging.

endpointUrl? urlType - Identifies the routing target to send acknowledgements to.

contact? ContactPoint - An e-mail, phone, website or other contact point to use to resolve issues with message communications.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name? string - Human-readable name for the source system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - Can convey versions of multiple systems in situations where a message passes through multiple hands.

health.fhir.r5.international500: MetadataResource

FHIR MetadataResource resource record.

Fields

resourceType RESOURCE_NAME_METADATARESOURCE(default RESOURCE_NAME_METADATARESOURCE) - The type of the resource describes

date? dateTime - The date (and optionally time) when the {{title}} was last significantly changed. 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 {{title}} changes.

copyright? markdown - A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

purpose? markdown - Explanation of why this {{title}} is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the {{title}} 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 managable, 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 {{title}} from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

language? code - The base language in which the resource is written.

title? string - A short, descriptive, user-friendly title for the {{title}}.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the {{title}}.

identifier? Identifier[] - A formal identifier that is used to identify this {{title}} 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, dependencies, bibliographic references, and predecessor and successor artifacts.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the {{title}} 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 {{title}}.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}.

'version? string - The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 without additional knowledge. (See the versionAlgorithm element.)

url? uri - An absolute URI that is used to identify this {{title}} 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 an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name? string - A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource 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 responsible for the release and ongoing maintenance of the {{title}}.

topic? CodeableConcept[] - Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} 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 {{title}}s.

status MetadataResourceStatus - The current state of this {{title}}.

Element... - Rest field

health.fhir.r5.international500: ModelInfoLibrary

FHIR ModelInfoLibrary resource record.

Fields

resourceType RESOURCE_NAME_MODELINFOLIBRARY(default RESOURCE_NAME_MODELINFOLIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

description markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

title string - A short, descriptive, user-friendly title for the library.

'type ModelInfoLibraryType - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

content? Attachment[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
- content Slicings
1. ModelInfoLibraryContentModelInfoJsonContent: ModelInfo JSON Content
- min = 0
- max = *

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

'version string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status ModelInfoLibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ModelInfoLibraryContentModelInfoJsonContent

Closed record

FHIR ModelInfoLibraryContentModelInfoJsonContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType code(default "application/json") - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: ModelInfoLibraryContentModelInfoXmlContent

Closed record

FHIR ModelInfoLibraryContentModelInfoXmlContent datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

data base64Binary - The actual data of the attachment - a sequence of bytes, base64 encoded.

frames? positiveInt - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

language? code - The human language of the content. The value can be any valid value according to BCP 47.

title? string - A label or set of text to display in place of the data.

url? urlType - A location where the data can be accessed.

duration? decimal - The duration of the recording in seconds - for audio and video.

pages? positiveInt - The number of pages when printed.

size? integer64 - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

width? positiveInt - Width of the image in pixels (photo/video).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType code(default "application/xml") - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation? dateTime - The date that the attachment was first created.

hash? base64Binary - The calculated hash of the data using SHA-1. Represented using base64.

height? positiveInt - Height of the image in pixels (photo/video).

health.fhir.r5.international500: ModelInfoLibraryType

Closed record

FHIR ModelInfoLibraryType datatype record.

Fields

coding ModelInfoLibraryTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: ModelInfoLibraryTypeCoding

Closed record

FHIR ModelInfoLibraryTypeCoding datatype record.

Fields

system uri(default "http://terminology.hl7.org/CodeSystem/library-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "model-definition") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r5.international500: ModuleDefinitionLibrary

FHIR ModuleDefinitionLibrary resource record.

Fields

resourceType RESOURCE_NAME_MODULEDEFINITIONLIBRARY(default RESOURCE_NAME_MODULEDEFINITIONLIBRARY) - The type of the resource describes

date? dateTime - The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright? markdown - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension? Extension[] - An Extension

approvalDate? date - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept? CodeableConcept - A code or group definition that describes the intended subject of the contents of the library.

purpose? markdown - Explanation of why this library is needed and why it has been designed as it has.

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 managable, 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? markdown - A detailed description of how the library is used from a clinical perspective.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the library is intended to be used.

description markdown - A free text natural language description of the library from a consumer's perspective.

experimental? boolean - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language? code - The base language in which the resource is written.

'type ModuleDefinitionLibraryType - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

title string - A short, descriptive, user-friendly title for the library.

content? Attachment[] - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

'parameter? ParameterDefinition[] - The parameter element defines parameters used by the library.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier? Identifier[] - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the content.

relatedArtifact? RelatedArtifact[] - Related artifacts such as additional documentation, justification, or bibliographic references.
- relatedArtifact Slicings
1. ModuleDefinitionLibraryRelatedArtifactDependency: Additional documentation, citations, etc
- min = 0
- max = *

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which is more current.

effectivePeriod? Period - The period during which the library content was or is planned to be in active use.

author? ContactDetail[] - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

'version string - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

subjectReference? Reference - A code or group definition that describes the intended subject of the contents of the library.

url uri - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

subtitle? string - An explanatory or alternate title for the library giving additional information about its content.

name? string - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement? DataRequirement[] - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the library.

topic? CodeableConcept[] - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

status ModuleDefinitionLibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: ModuleDefinitionLibraryRelatedArtifactDependency

Closed record

FHIR ModuleDefinitionLibraryRelatedArtifactDependency datatype record.

Fields

publicationStatus? ModuleDefinitionLibraryRelatedArtifactPublicationStatus - The publication status of the artifact being referred to.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

citation? markdown - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

'resource canonical - The related artifact, such as a library, value set, profile, or other knowledge resource.

display? string - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document? Attachment - The document being referenced, represented as an attachment. This is exclusive with the resource element.

classifier? CodeableConcept[] - Provides additional classifiers of the related artifact.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

label? string - A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

'type ModuleDefinitionLibraryRelatedArtifactType(default "depends-on") - The type of relationship to the related artifact.

publicationDate? date - The date of publication of the artifact being referred to.

resourceReference? Reference - The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

health.fhir.r5.international500: ModuleDefinitionLibraryType

Closed record

FHIR ModuleDefinitionLibraryType datatype record.

Fields

coding ModuleDefinitionLibraryTypeCoding[] - A reference to a code defined by a terminology system.

health.fhir.r5.international500: ModuleDefinitionLibraryTypeCoding

Closed record

FHIR ModuleDefinitionLibraryTypeCoding datatype record.

Fields

system uri(default "http://terminology.hl7.org/CodeSystem/library-type") - The identification of the code system that defines the meaning of the symbol in the code.

code code(default "logic-library") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

health.fhir.r5.international500: MolecularSequence

FHIR MolecularSequence resource record.

Fields

resourceType RESOURCE_NAME_MOLECULARSEQUENCE(default RESOURCE_NAME_MOLECULARSEQUENCE) - The type of the resource describes

identifier? Identifier[] - A unique identifier for this particular sequence instance.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

performer? Reference - The organization or lab that should be responsible for this result.

formatted? Attachment[] - Sequence that was observed as file content. Can be an actual file contents, or referenced by a URL to an external system.

subject? Reference - Indicates the subject this sequence is associated too.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of a molecular sequence when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the subject would be the child (proband) and the focus would be the parent.

language? code - The base language in which the resource is written.

'type? MolecularSequenceType - Amino Acid Sequence/ DNA Sequence / RNA Sequence.

literal? string - Sequence that was observed.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

specimen? Reference - Specimen used for sequencing.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

device? Reference - The method for sequencing, for example, chip information.

relative? MolecularSequenceRelative[] - A sequence defined relative to another sequence.

Element... - Rest field

health.fhir.r5.international500: MolecularSequenceRelative

Closed record

FHIR MolecularSequenceRelative datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

startingSequence? MolecularSequenceRelativeStartingSequence - A sequence that is used as a starting sequence to describe variants that are present in a sequence analyzed.

edit? MolecularSequenceRelativeEdit[] - Changes in sequence from the starting sequence.

sequenceRange? Range - Indicates the nucleotide range in the composed sequence when multiple 'relative' elements are used together.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

coordinateSystem CodeableConcept - These are different ways of identifying nucleotides or amino acids within a sequence. Different databases and file types may use different systems. For detail definitions, see https://loinc.org/92822-6/ for more detail.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ordinalPosition? integer - Indicates the order in which the sequence should be considered when putting multiple 'relative' elements together.

health.fhir.r5.international500: MolecularSequenceRelativeEdit

Closed record

FHIR MolecularSequenceRelativeEdit datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

replacedSequence? string - Allele in the starting sequence. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the starting sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

replacementSequence? string - Allele that was observed. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.

'start? integer - Start position of the edit on the starting sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

end? integer - End position of the edit on the starting sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r5.international500: MolecularSequenceRelativeStartingSequence

Closed record

FHIR MolecularSequenceRelativeStartingSequence datatype record.

Fields

sequenceMolecularSequenceString? string - The reference sequence that represents the starting sequence.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

orientation? MolecularSequenceRelativeStartingSequenceOrientation - A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the 'sense' strand, and the opposite complementary strand is the 'antisense' strand.

strand? MolecularSequenceRelativeStartingSequenceStrand - An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.

genomeAssembly? CodeableConcept - The genome assembly used for starting sequence, e.g. GRCh38.

windowStart? integer - Start position of the window on the starting sequence. This value should honor the rules of the coordinateSystem.

chromosome? CodeableConcept - Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication (SO:0000340).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

sequenceMolecularSequenceReference? Reference - The reference sequence that represents the starting sequence.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

windowEnd? integer - End position of the window on the starting sequence. This value should honor the rules of the coordinateSystem.

sequenceMolecularSequenceCodeableConcept? CodeableConcept - The reference sequence that represents the starting sequence.

health.fhir.r5.international500: NamingSystem

FHIR NamingSystem resource record.

Fields

resourceType RESOURCE_NAME_NAMINGSYSTEM(default RESOURCE_NAME_NAMINGSYSTEM) - The type of the resource describes

date dateTime - The date (and optionally time) when the naming system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.

copyright? markdown - A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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.

purpose? markdown - Explanation of why this naming system is needed and why it has been designed as it has.

jurisdiction? CodeableConcept[] - A legal or geographic region in which the naming system is intended to be used.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

usage? string - Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

description? markdown - A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.

experimental? boolean - A Boolean value to indicate that this naming system 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 naming system.

'type? CodeableConcept - Categorizes a naming system for easier search by grouping related naming systems.

versionAlgorithmString? string - Indicates the mechanism used to compare versions to determine which NamingSystem is more current.

contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.

responsible? string - The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

endorser? ContactDetail[] - An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor? ContactDetail[] - An individual or organization primarily responsible for internal coherence of the NamingSystem.

identifier? Identifier[] - A formal identifier that is used to identify this naming system 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, dependencies, bibliographic references, and predecessor and successor artifacts.

versionAlgorithmCoding? Coding - Indicates the mechanism used to compare versions to determine which NamingSystem is more current.

effectivePeriod? Period - The period during which the NamingSystem 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 NamingSystem.

kind NamingSystemKind - Indicates the purpose for the naming system - what kinds of things does it make unique?

reviewer? ContactDetail[] - An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem.

'version? string - The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system 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 naming system 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 an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

copyrightLabel? string - A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

lastReviewDate? date - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

name string - A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher? string - The name of the organization or individual responsible for the release and ongoing maintenance of the naming system.

topic? CodeableConcept[] - Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem 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 naming system instances.

uniqueId NamingSystemUniqueId[] - Indicates how the system may be identified when referenced in electronic exchange.

status NamingSystemStatus - The status of this naming system. Enables tracking the life-cycle of the content.

Element... - Rest field

health.fhir.r5.international500: NamingSystemUniqueId

Closed record

FHIR NamingSystemUniqueId datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

period? Period - Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.

authoritative? boolean - Indicates whether this identifier ie endorsed by the official owner of the associated naming 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

comment? string - Notes about the past or intended usage of this identifier.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type NamingSystemUniqueIdType - Identifies the unique identifier scheme used for this particular identifier.

value string - The string that should be sent over the wire to identify the code system or identifier system.

preferred? boolean - Indicates whether this identifier is the 'preferred' identifier of this type.

health.fhir.r5.international500: NutritionIntake

FHIR NutritionIntake resource record.

Fields

resourceType RESOURCE_NAME_NUTRITIONINTAKE(default RESOURCE_NAME_NUTRITIONINTAKE) - The type of the resource describes

note? Annotation[] - Provides extra information about the Nutrition Intake that is not conveyed by the other attributes.

partOf? Reference[] - A larger event of which this particular event is a component or step.

reason? CodeableReference[] - A reason, Condition or observation for why the food or fluid is /was consumed.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 - Overall type of nutrition intake.

subject Reference - The person, animal or group who is/was consuming the food or fluid.

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 managable, 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.

consumedItem NutritionIntakeConsumedItem[] - What food or fluid product or item was consumed.

ingredientLabel? NutritionIntakeIngredientLabel[] - Total nutrient amounts for the whole meal, product, serving, etc.

instantiatesUri? uri[] - Instantiates external protocol or definition.

reportedReference? Reference - The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.

statusReason? CodeableConcept[] - Captures the reason for the current state of the NutritionIntake.

derivedFrom? Reference[] - Allows linking the NutritionIntake to the underlying NutritionOrder, or to other information, such as AllergyIntolerance, that supports or is used to derive the NutritionIntake.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event.

identifier? Identifier[] - Identifiers associated with this Nutrition Intake that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

reportedBoolean? boolean - The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.

performer? NutritionIntakePerformer[] - Who performed the intake and how they were involved.

encounter? Reference - The encounter that establishes the context for this NutritionIntake.

instantiatesCanonical? canonical[] - Instantiates FHIR protocol or definition.

recorded? dateTime - The date when the Nutrition Intake was asserted by the information source.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

occurrencePeriod? Period - The interval of time during which it is being asserted that the patient is/was consuming the food or fluid.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location? Reference - Where the intake occurred.

occurrenceDateTime? dateTime - The interval of time during which it is being asserted that the patient is/was consuming the food or fluid.

status NutritionIntakeStatus - A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.

Element... - Rest field

health.fhir.r5.international500: NutritionIntakeConsumedItem

Closed record

FHIR NutritionIntakeConsumedItem datatype record.

Fields

schedule? Timing - Scheduled frequency of consumption.

amount? Quantity - Quantity of the specified food.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

rate? Quantity - Rate at which enteral feeding was administered.

notConsumedReason? CodeableConcept - Document the reason the food or fluid was not consumed, such as refused, held, 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

notConsumed? boolean - Indicator when a patient is in a setting where it is helpful to know if food was not consumed, such as it was refused, held (as in tube feedings), or otherwise not provided. If a consumption is being recorded from an app, such as MyFitnessPal, this indicator will likely not be used.

nutritionProduct CodeableReference - Identifies the food or fluid product that was consumed. This is potentially a link to a resource representing the details of the food product (TBD) or a simple attribute carrying a code that identifies the food from a known list of foods.

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 - Indicates what a category of item that was consumed: e.g., food, fluid, enteral, etc.

health.fhir.r5.international500: NutritionIntakeIngredientLabel

Closed record

FHIR NutritionIntakeIngredientLabel datatype record.

Fields

amount Quantity - Total amount of nutrient consumed.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

nutrient CodeableReference - Total nutrient consumed. This could be a macronutrient (protein, fat, carbohydrate), or a vitamin and mineral.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: NutritionIntakePerformer

Closed record

FHIR NutritionIntakePerformer datatype record.

Fields

actor Reference - Who performed the intake.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

'function? CodeableConcept - Type of performer.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: NutritionOrder

FHIR NutritionOrder resource record.

Fields

resourceType RESOURCE_NAME_NUTRITIONORDER(default RESOURCE_NAME_NUTRITIONORDER) - The type of the resource describes

dateTime dateTime - The date and time that this nutrition order was requested.

instantiates? uri[] - The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

note? Annotation[] - Comments made about the {{title}} by the requester, performer, subject or other participants.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject Reference - The person or set of individuals who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

language? code - The base language in which the resource is written.

instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn? Reference[] - A plan or request that is fulfilled in whole or in part by this nutrition order.

foodPreferenceModifier? CodeableConcept[] - This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.

identifier? Identifier[] - Identifiers assigned to this order by the order sender or by the order receiver.

enteralFormula? NutritionOrderEnteralFormula - Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

oralDiet? NutritionOrderOralDiet - Diet given orally in contrast to enteral (tube) feeding.

performer? CodeableReference[] - The specified desired performer of the nutrition order.

excludeFoodModifier? CodeableConcept[] - This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.

supportingInformation? Reference[] - Information to support fulfilling (i.e. dispensing or administering) of the nutrition, for example, patient height and weight).

encounter? Reference - An encounter that provides additional information about the healthcare context in which this request is made.

instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

priority? NutritionOrderPriority - Indicates how quickly the Nutrition Order should be addressed with respect to other requests.

intent NutritionOrderIntent - Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

supplement? NutritionOrderSupplement[] - Oral nutritional products given in order to add further nutritional value to the patient's diet.

orderer? Reference - The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.

outsideFoodAllowed? boolean - This modifier is used to convey whether a food item is allowed to be brought in by the patient and/or family. If set to true, indicates that the receiving system does not need to supply the food item.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

groupIdentifier? Identifier - A shared identifier common to all nutrition orders that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

allergyIntolerance? Reference[] - A link to a record of allergies or intolerances which should be included in the nutrition order.

status NutritionOrderStatus - The workflow status of the nutrition order/request.

Element... - Rest field

health.fhir.r5.international500: NutritionOrderEnteralFormula

Closed record

FHIR NutritionOrderEnteralFormula datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

administrationInstruction? markdown - Free text formula administration, feeding instructions or additional instructions or information.

baseFormulaProductName? string - The product or brand name of the enteral or infant formula product such as 'ACME Adult Standard Formula'.

administration? NutritionOrderEnteralFormulaAdministration[] - Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.

baseFormulaType? CodeableReference - The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

caloricDensity? Quantity - The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.

routeOfAdministration? CodeableConcept - The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

maxVolumeToDeliver? Quantity - The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.

additive? NutritionOrderEnteralFormulaAdditive[] - Indicates modular components to be provided in addition or mixed with the base formula.

deliveryDevice? CodeableReference[] - The intended type of device that is to be used for the administration of the enteral formula.

health.fhir.r5.international500: NutritionOrderEnteralFormulaAdditive

Closed record

FHIR NutritionOrderEnteralFormulaAdditive datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The amount of additive to be given in addition or to be mixed in with the base formula.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? CodeableReference - Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.

productName? string - The product or brand name of the type of modular component to be added to the formula.

health.fhir.r5.international500: NutritionOrderEnteralFormulaAdministration

Closed record

FHIR NutritionOrderEnteralFormulaAdministration datatype record.

Fields

schedule? NutritionOrderEnteralFormulaAdministrationSchedule - Schedule information for an enteral formula.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The volume of formula to provide to the patient per the specified administration schedule.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

rateNutritionOrderRatio? Ratio - The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

rateNutritionOrderQuantity? Quantity - The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.

health.fhir.r5.international500: NutritionOrderEnteralFormulaAdministrationSchedule

Closed record

FHIR NutritionOrderEnteralFormulaAdministrationSchedule datatype record.

Fields

asNeeded? boolean - Indicates whether the enteral formula is only taken when needed within a specific dosing schedule.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

timing? Timing[] - The time period and frequency at which the enteral formula should be given. The enteral formula should be given for the combination of all schedules if more than one schedule is present.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

asNeededFor? CodeableConcept - Indicates whether the enteral formula is only taken based on a precondition for taking the enteral formula.

health.fhir.r5.international500: NutritionOrderOralDiet

Closed record

FHIR NutritionOrderOralDiet datatype record.

Fields

schedule? NutritionOrderOralDietSchedule - Schedule information for an oral diet.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

nutrient? NutritionOrderOralDietNutrient[] - Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.

instruction? string - Free text or additional instructions or information pertaining to the oral diet.

texture? NutritionOrderOralDietTexture[] - Class that describes any texture modifications required for the patient to safely consume various types of solid foods.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

fluidConsistencyType? CodeableConcept[] - The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type? CodeableConcept[] - The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.

health.fhir.r5.international500: NutritionOrderOralDietNutrient

Closed record

FHIR NutritionOrderOralDietNutrient datatype record.

Fields

amount? Quantity - The quantity of the specified nutrient to include in diet.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifier? CodeableConcept - The nutrient that is being modified such as carbohydrate or sodium.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: NutritionOrderOralDietSchedule

Closed record

FHIR NutritionOrderOralDietSchedule datatype record.

Fields

asNeeded? boolean - Indicates whether the product is only taken when needed within a specific dosing schedule.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

timing? Timing[] - The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

asNeededFor? CodeableConcept - Indicates whether the product is only taken based on a precondition for taking the product.

health.fhir.r5.international500: NutritionOrderOralDietTexture

Closed record

FHIR NutritionOrderOralDietTexture datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

foodType? CodeableConcept - The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.

modifier? CodeableConcept - Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: NutritionOrderSupplement

Closed record

FHIR NutritionOrderSupplement datatype record.

Fields

schedule? NutritionOrderSupplementSchedule - Schedule information for a supplement.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

quantity? Quantity - The amount of the nutritional supplement to be given.

instruction? string - Free text or additional instructions or information pertaining to the oral supplement.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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? CodeableReference - The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.

productName? string - The product or brand name of the nutritional supplement such as 'Acme Protein Shake'.

health.fhir.r5.international500: NutritionOrderSupplementSchedule

Closed record

FHIR NutritionOrderSupplementSchedule datatype record.

Fields

asNeeded? boolean - Indicates whether the supplement is only taken when needed within a specific dosing schedule.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

timing? Timing[] - The time period and frequency at which the supplement should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.

asNeededFor? CodeableConcept - Indicates whether the supplement is only taken based on a precondition for taking the supplement.

health.fhir.r5.international500: NutritionProduct

FHIR NutritionProduct resource record.

Fields

resourceType RESOURCE_NAME_NUTRITIONPRODUCT(default RESOURCE_NAME_NUTRITIONPRODUCT) - The type of the resource describes

note? Annotation[] - Comments made about the 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code? CodeableConcept - The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.

ingredient? NutritionProductIngredient[] - Ingredients contained in this product.

instance? NutritionProductInstance[] - Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.

nutrient? NutritionProductNutrient[] - The product's nutritional information expressed by the nutrients.

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 managable, 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.

characteristic? NutritionProductCharacteristic[] - Specifies descriptive properties of the nutrition product.

knownAllergen? CodeableReference[] - Allergens that are known or suspected to be a part of this nutrition product.

manufacturer? Reference[] - The organisation (manufacturer, representative or legal authorization holder) that is responsible for the device.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category? CodeableConcept[] - Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.

status NutritionProductStatus - The current state of the product.

Element... - Rest field

health.fhir.r5.international500: NutritionProductCharacteristic

Closed record

FHIR NutritionProductCharacteristic datatype record.

Fields

valueCodeableConcept CodeableConcept - The actual characteristic value corresponding to the type.

valueBase64Binary base64Binary - The actual characteristic value corresponding to the type.

valueBoolean boolean - The actual characteristic value corresponding to the type.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueAttachment Attachment - The actual characteristic value corresponding to the type.

valueString string - The actual characteristic value corresponding to the type.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - A code specifying which characteristic of the product is being described (for example, colour, shape).

valueQuantity Quantity - The actual characteristic value corresponding to the type.

health.fhir.r5.international500: NutritionProductIngredient

Closed record

FHIR NutritionProductIngredient datatype record.

Fields

amount? Ratio[] - The amount of ingredient that is in the product.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item CodeableReference - The ingredient contained in the product.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: NutritionProductInstance

Closed record

FHIR NutritionProductInstance datatype record.

Fields

identifier? Identifier[] - The identifier for the physical instance, typically a serial number or manufacturer number.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

biologicalSourceEvent? Identifier - An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

quantity? Quantity - The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 for the specific product.

useBy? dateTime - The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.

expiry? dateTime - The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

lotNumber? string - The identification of the batch or lot of the product.

health.fhir.r5.international500: NutritionProductNutrient

Closed record

FHIR NutritionProductNutrient datatype record.

Fields

amount? Ratio[] - The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

item? CodeableReference - The (relevant) nutrients in the product.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.r5.international500: Observation

FHIR Observation resource record.

Fields

resourceType RESOURCE_NAME_OBSERVATION(default RESOURCE_NAME_OBSERVATION) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

valueTime? time - The information determined as a result of making the observation, if the information has a simple value.

subject? Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.

identifier? Identifier[] - A unique identifier assigned to this observation.

effectivePeriod? Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

effectiveTiming? Timing - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ObservationStatus - The status of the result value.

valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.

note? Annotation[] - Comments about the observation or the results.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

valueReference? Reference - The information determined as a result of making the observation, if the information has a simple value.

valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.

valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.

valueAttachment? Attachment - The information determined as a result of making the observation, if the information has a simple value.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? ObservationComponent[] - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

valueString? string - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime? dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

category? CodeableConcept[] - A code that classifies the general type of observation being made.

effectiveInstant? instant - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

triggeredBy? ObservationTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: Observationbmi

FHIR Observationbmi resource record.

Fields

resourceType RESOURCE_NAME_OBSERVATIONBMI(default RESOURCE_NAME_OBSERVATIONBMI) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

note? Annotation[] - Comments about the observation or the results.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ObservationbmiCode - Body Mass Index (BMI).

subject Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

valueQuantity ObservationbmiValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

identifier? Identifier[] - A unique identifier assigned to this observation.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

hasMember? Reference[] - Used when reporting vital signs panel components.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? ObservationbmiComponent[] - Used when reporting systolic and diastolic blood pressure.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

referenceRange? ObservationbmiReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. ObservationbmiCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ObservationbmiStatus - The status of the result value.

triggeredBy? ObservationbmiTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: ObservationbmiCategoryCoding

Closed record

FHIR ObservationbmiCategoryCoding datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbmiCategoryVSCat

Closed record

FHIR ObservationbmiCategoryVSCat datatype record.

Fields

coding ObservationbmiCategoryCoding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbmiCode

Closed record

FHIR ObservationbmiCode datatype record.

Fields

coding? Coding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbmiCodeCodingBMICode

Closed record

FHIR ObservationbmiCodeCodingBMICode datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "39156-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbmiComponent

Closed record

FHIR ObservationbmiComponent datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - Vital Sign Value.

valueRatio? Ratio - Vital Sign Value.

valueAttachment? Attachment - Vital Sign Value.

valueString? string - Vital Sign Value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - Vital Sign Value.

valuePeriod? Period - Vital Sign Value.

valueDateTime? dateTime - Vital Sign Value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - Vital Sign Value.

valueQuantity? Quantity - Vital Sign Value.

health.fhir.r5.international500: ObservationbmiReferenceRange

Closed record

FHIR ObservationbmiReferenceRange datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? markdown - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

normalValue? CodeableConcept - The value of the normal value of the reference range.

age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r5.international500: ObservationbmiTriggeredBy

Closed record

FHIR ObservationbmiTriggeredBy datatype record.

Fields

reason? string - Provides the reason why this observation was performed as a result of the observation(s) referenced.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

observation Reference - Reference to the triggering observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ObservationbmiTriggeredByType - The type of trigger. Reflex | Repeat | Re-run.

health.fhir.r5.international500: ObservationbmiValue

Closed record

FHIR ObservationbmiValue datatype record.

Fields

comparator? ObservationbmiValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unit string - A human-readable form of the unit.

code code(default "kg/m2") - Coded responses from the common UCUM units for vital signs value set.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r5.international500: Observationbodyheight

FHIR Observationbodyheight resource record.

Fields

resourceType RESOURCE_NAME_OBSERVATIONBODYHEIGHT(default RESOURCE_NAME_OBSERVATIONBODYHEIGHT) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

valueTime? time - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

subject Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueRatio? Ratio - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger? integer - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueQuantity? ObservationbodyheightValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

identifier? Identifier[] - A unique identifier assigned to this observation.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

referenceRange? ObservationbodyheightReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valuePeriod? Period - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

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.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ObservationbodyheightStatus - The status of the result value.

valueBoolean? boolean - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

note? Annotation[] - Comments about the observation or the results.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ObservationbodyheightCode - Body Height.

valueReference? Reference - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueRange? Range - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueCodeableConcept? CodeableConcept - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueAttachment? Attachment - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

hasMember? Reference[] - Used when reporting vital signs panel components.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? ObservationbodyheightComponent[] - Used when reporting systolic and diastolic blood pressure.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

valueString? string - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. ObservationbodyheightCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

triggeredBy? ObservationbodyheightTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: ObservationbodyheightCategoryCoding

Closed record

FHIR ObservationbodyheightCategoryCoding datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbodyheightCategoryVSCat

Closed record

FHIR ObservationbodyheightCategoryVSCat datatype record.

Fields

coding ObservationbodyheightCategoryCoding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbodyheightCode

Closed record

FHIR ObservationbodyheightCode datatype record.

Fields

coding? Coding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbodyheightCodeCodingBodyHeightCode

Closed record

FHIR ObservationbodyheightCodeCodingBodyHeightCode datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "8302-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbodyheightComponent

Closed record

FHIR ObservationbodyheightComponent datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - Vital Sign Value.

valueRatio? Ratio - Vital Sign Value.

valueAttachment? Attachment - Vital Sign Value.

valueString? string - Vital Sign Value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - Vital Sign Value.

valuePeriod? Period - Vital Sign Value.

valueDateTime? dateTime - Vital Sign Value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - Vital Sign Value.

valueQuantity? Quantity - Vital Sign Value.

health.fhir.r5.international500: ObservationbodyheightReferenceRange

Closed record

FHIR ObservationbodyheightReferenceRange datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? markdown - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

normalValue? CodeableConcept - The value of the normal value of the reference range.

age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r5.international500: ObservationbodyheightTriggeredBy

Closed record

FHIR ObservationbodyheightTriggeredBy datatype record.

Fields

reason? string - Provides the reason why this observation was performed as a result of the observation(s) referenced.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

observation Reference - Reference to the triggering observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ObservationbodyheightTriggeredByType - The type of trigger. Reflex | Repeat | Re-run.

health.fhir.r5.international500: ObservationbodyheightValue

Closed record

FHIR ObservationbodyheightValue datatype record.

Fields

comparator? ObservationbodyheightValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unit string - A human-readable form of the unit.

code code - Coded responses from the common UCUM units for vital signs value set.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r5.international500: Observationbodytemp

FHIR Observationbodytemp resource record.

Fields

resourceType RESOURCE_NAME_OBSERVATIONBODYTEMP(default RESOURCE_NAME_OBSERVATIONBODYTEMP) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

valueTime? time - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

subject Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueRatio? Ratio - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger? integer - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueQuantity? ObservationbodytempValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

identifier? Identifier[] - A unique identifier assigned to this observation.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

referenceRange? ObservationbodytempReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valuePeriod? Period - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

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.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ObservationbodytempStatus - The status of the result value.

valueBoolean? boolean - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

note? Annotation[] - Comments about the observation or the results.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ObservationbodytempCode - Body Temperature.

valueReference? Reference - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueRange? Range - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueCodeableConcept? CodeableConcept - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueAttachment? Attachment - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

hasMember? Reference[] - Used when reporting vital signs panel components.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? ObservationbodytempComponent[] - Used when reporting systolic and diastolic blood pressure.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

valueString? string - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. ObservationbodytempCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

triggeredBy? ObservationbodytempTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: ObservationbodytempCategoryCoding

Closed record

FHIR ObservationbodytempCategoryCoding datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbodytempCategoryVSCat

Closed record

FHIR ObservationbodytempCategoryVSCat datatype record.

Fields

coding ObservationbodytempCategoryCoding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbodytempCode

Closed record

FHIR ObservationbodytempCode datatype record.

Fields

coding? Coding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbodytempCodeCodingBodyTempCode

Closed record

FHIR ObservationbodytempCodeCodingBodyTempCode datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "8310-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbodytempComponent

Closed record

FHIR ObservationbodytempComponent datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - Vital Sign Value.

valueRatio? Ratio - Vital Sign Value.

valueAttachment? Attachment - Vital Sign Value.

valueString? string - Vital Sign Value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - Vital Sign Value.

valuePeriod? Period - Vital Sign Value.

valueDateTime? dateTime - Vital Sign Value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - Vital Sign Value.

valueQuantity? Quantity - Vital Sign Value.

health.fhir.r5.international500: ObservationbodytempReferenceRange

Closed record

FHIR ObservationbodytempReferenceRange datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? markdown - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

normalValue? CodeableConcept - The value of the normal value of the reference range.

age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r5.international500: ObservationbodytempTriggeredBy

Closed record

FHIR ObservationbodytempTriggeredBy datatype record.

Fields

reason? string - Provides the reason why this observation was performed as a result of the observation(s) referenced.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

observation Reference - Reference to the triggering observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ObservationbodytempTriggeredByType - The type of trigger. Reflex | Repeat | Re-run.

health.fhir.r5.international500: ObservationbodytempValue

Closed record

FHIR ObservationbodytempValue datatype record.

Fields

comparator? ObservationbodytempValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unit string - A human-readable form of the unit.

code code - Coded responses from the common UCUM units for vital signs value set.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r5.international500: Observationbodyweight

FHIR Observationbodyweight resource record.

Fields

resourceType RESOURCE_NAME_OBSERVATIONBODYWEIGHT(default RESOURCE_NAME_OBSERVATIONBODYWEIGHT) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

valueTime? time - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

subject Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueRatio? Ratio - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger? integer - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueQuantity? ObservationbodyweightValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

identifier? Identifier[] - A unique identifier assigned to this observation.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

referenceRange? ObservationbodyweightReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valuePeriod? Period - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

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.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ObservationbodyweightStatus - The status of the result value.

valueBoolean? boolean - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

note? Annotation[] - Comments about the observation or the results.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ObservationbodyweightCode - Body Weight.

valueReference? Reference - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueRange? Range - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueCodeableConcept? CodeableConcept - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueAttachment? Attachment - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

hasMember? Reference[] - Used when reporting vital signs panel components.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component? ObservationbodyweightComponent[] - Used when reporting systolic and diastolic blood pressure.

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

valueString? string - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. ObservationbodyweightCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

triggeredBy? ObservationbodyweightTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: ObservationbodyweightCategoryCoding

Closed record

FHIR ObservationbodyweightCategoryCoding datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbodyweightCategoryVSCat

Closed record

FHIR ObservationbodyweightCategoryVSCat datatype record.

Fields

coding ObservationbodyweightCategoryCoding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbodyweightCode

Closed record

FHIR ObservationbodyweightCode datatype record.

Fields

coding? Coding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbodyweightCodeCodingBodyWeightCode

Closed record

FHIR ObservationbodyweightCodeCodingBodyWeightCode datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "29463-7") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbodyweightComponent

Closed record

FHIR ObservationbodyweightComponent datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - Vital Sign Value.

valueRatio? Ratio - Vital Sign Value.

valueAttachment? Attachment - Vital Sign Value.

valueString? string - Vital Sign Value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - Vital Sign Value.

valuePeriod? Period - Vital Sign Value.

valueDateTime? dateTime - Vital Sign Value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - Vital Sign Value.

valueQuantity? Quantity - Vital Sign Value.

health.fhir.r5.international500: ObservationbodyweightReferenceRange

Closed record

FHIR ObservationbodyweightReferenceRange datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? markdown - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

normalValue? CodeableConcept - The value of the normal value of the reference range.

age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r5.international500: ObservationbodyweightTriggeredBy

Closed record

FHIR ObservationbodyweightTriggeredBy datatype record.

Fields

reason? string - Provides the reason why this observation was performed as a result of the observation(s) referenced.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

observation Reference - Reference to the triggering observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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 ObservationbodyweightTriggeredByType - The type of trigger. Reflex | Repeat | Re-run.

health.fhir.r5.international500: ObservationbodyweightValue

Closed record

FHIR ObservationbodyweightValue datatype record.

Fields

comparator? ObservationbodyweightValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

unit string - A human-readable form of the unit.

code code - Coded responses from the common UCUM units for vital signs value set.

system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.

health.fhir.r5.international500: Observationbp

FHIR Observationbp resource record.

Fields

resourceType RESOURCE_NAME_OBSERVATIONBP(default RESOURCE_NAME_OBSERVATIONBP) - The type of the resource describes

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.

instantiatesReference? Reference - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

valueTime? time - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

subject Reference - The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language? code - The base language in which the resource is written.

valueRatio? Ratio - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger? integer - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueQuantity? Quantity - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

identifier? Identifier[] - A unique identifier assigned to this observation.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method? CodeableConcept - Indicates the mechanism used to perform the observation.

instantiatesCanonical? canonical - The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.

referenceRange? ObservationbpReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueSampledData? SampledData - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valuePeriod? Period - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

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.

bodyStructure? Reference - Indicates the body structure on the subject's body where the observation was made (i.e. the target site).

device? Reference - A reference to the device that generates the measurements or the device settings for the device.

status ObservationbpStatus - The status of the result value.

valueBoolean? boolean - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

note? Annotation[] - Comments about the observation or the results.

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 managable, there is a strict set of governance applied to the definition and use of extensions. Though 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 ObservationbpCode - Blood Pressure.

valueReference? Reference - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueRange? Range - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueCodeableConcept? CodeableConcept - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueAttachment? Attachment - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

specimen? Reference - The specimen that was used when this observation was made.

derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime? dateTime - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

performer? Reference[] - Who was responsible for asserting the observed value as 'true'.

hasMember? Reference[] - Used when reporting vital signs panel components.

encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component ObservationbpComponent[] - Used when reporting systolic and diastolic blood pressure.
- component Slicings
1. ObservationbpComponentDiastolicBP: Used when reporting systolic and diastolic blood pressure.
- min = 1
- max = 1

contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

valueString? string - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

category CodeableConcept[] - A code that classifies the general type of observation being made.
- category Slicings
1. ObservationbpCategoryVSCat: Classification of type of observation
- min = 1
- max = 1

triggeredBy? ObservationbpTriggeredBy[] - Identifies the observation(s) that triggered the performance of this observation.

Element... - Rest field

health.fhir.r5.international500: ObservationbpCategoryCoding

Closed record

FHIR ObservationbpCategoryCoding datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbpCategoryVSCat

Closed record

FHIR ObservationbpCategoryVSCat datatype record.

Fields

coding ObservationbpCategoryCoding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbpCode

Closed record

FHIR ObservationbpCode datatype record.

Fields

coding? Coding[] - A reference to a code defined by a terminology system.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbpCodeCodingBPCode

Closed record

FHIR ObservationbpCodeCodingBPCode datatype record.

Fields

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

code code(default "85354-9") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.

userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

display? string - A representation of the meaning of the code in the system, following the rules of the system.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

health.fhir.r5.international500: ObservationbpComponent

Closed record

FHIR ObservationbpComponent datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - Vital Sign Value.

valueRatio? Ratio - Vital Sign Value.

valueAttachment? Attachment - Vital Sign Value.

valueString? string - Vital Sign Value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - Vital Sign Value.

valuePeriod? Period - Vital Sign Value.

valueDateTime? dateTime - Vital Sign Value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - Vital Sign Value.

valueQuantity? Quantity - Vital Sign Value.

health.fhir.r5.international500: ObservationbpComponentCode

Closed record

FHIR ObservationbpComponentCode datatype record.

Fields

coding? Coding[] - Diastolic Blood Pressure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbpComponentCodeOne

Closed record

FHIR ObservationbpComponentCodeOne datatype record.

Fields

coding? Coding[] - Systolic Blood Pressure.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

health.fhir.r5.international500: ObservationbpComponentDiastolicBP

Closed record

FHIR ObservationbpComponentDiastolicBP datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code ObservationbpComponentCode - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

valueCodeableConcept? CodeableConcept - Vital Sign Value.

valueRatio? Ratio - Vital Sign Value.

valueAttachment? Attachment - Vital Sign Value.

valueString? string - Vital Sign Value.

interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData? SampledData - Vital Sign Value.

valuePeriod? Period - Vital Sign Value.

valueDateTime? dateTime - Vital Sign Value.

id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger? integer - Vital Sign Value.

valueQuantity? Quantity - Vital Sign Value.

health.fhir.r5.international500: ObservationbpComponentSystolicBP

Closed record

FHIR ObservationbpComponentSystolicBP datatype record.

Fields

valueBoolean? boolean - Vital Sign Value.

dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

valueTime? time - Vital Sign Value.

code ObservationbpComponentCodeOne - Describes what was observed. Sometimes this is called the observation 'code'.

valueReference? Reference - Vital Sign Value.

valueRange? Range - Vital Sign Value.

modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Appli

functions

constants

enums

variables

records

ballerinax/health.fhir.r5.international500 Ballerina library

FHIR R5 health_fhir_r5_international500 package

Package Overview

Capabilities and features

Supported FHIR resource types

Functions

initialize

Constants

health.fhir.r5.international500: PROFILE_BASE_ACCOUNT

health.fhir.r5.international500: PROFILE_BASE_ACTIVITYDEFINITION

health.fhir.r5.international500: PROFILE_BASE_ACTORDEFINITION

health.fhir.r5.international500: PROFILE_BASE_ACTUALGROUP

health.fhir.r5.international500: PROFILE_BASE_ADMINISTRABLEPRODUCTDEFINITION

health.fhir.r5.international500: PROFILE_BASE_ADVERSEEVENT

health.fhir.r5.international500: PROFILE_BASE_ALLERGYINTOLERANCE

health.fhir.r5.international500: PROFILE_BASE_APPOINTMENT

health.fhir.r5.international500: PROFILE_BASE_APPOINTMENTRESPONSE

health.fhir.r5.international500: PROFILE_BASE_ARTIFACTASSESSMENT

health.fhir.r5.international500: PROFILE_BASE_AUDITEVENT

health.fhir.r5.international500: PROFILE_BASE_BASIC

health.fhir.r5.international500: PROFILE_BASE_BINARY

health.fhir.r5.international500: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCT

health.fhir.r5.international500: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCTDISPENSE

health.fhir.r5.international500: PROFILE_BASE_BODYSTRUCTURE

health.fhir.r5.international500: PROFILE_BASE_CANONICALRESOURCE

health.fhir.r5.international500: PROFILE_BASE_CAPABILITYSTATEMENT

health.fhir.r5.international500: PROFILE_BASE_CAREPLAN

health.fhir.r5.international500: PROFILE_BASE_CARETEAM

health.fhir.r5.international500: PROFILE_BASE_CDSHOOKSGUIDANCERESPONSE

health.fhir.r5.international500: PROFILE_BASE_CDSHOOKSREQUESTORCHESTRATION

health.fhir.r5.international500: PROFILE_BASE_CDSHOOKSSERVICEPLANDEFINITION

health.fhir.r5.international500: PROFILE_BASE_CHARGEITEM

health.fhir.r5.international500: PROFILE_BASE_CHARGEITEMDEFINITION

health.fhir.r5.international500: PROFILE_BASE_CITATION

health.fhir.r5.international500: PROFILE_BASE_CLAIM

health.fhir.r5.international500: PROFILE_BASE_CLAIMRESPONSE

health.fhir.r5.international500: PROFILE_BASE_CLINICALDOCUMENT

health.fhir.r5.international500: PROFILE_BASE_CLINICALIMPRESSION

health.fhir.r5.international500: PROFILE_BASE_CLINICALUSEDEFINITION

health.fhir.r5.international500: PROFILE_BASE_COMMUNICATION

health.fhir.r5.international500: PROFILE_BASE_COMMUNICATIONREQUEST

health.fhir.r5.international500: PROFILE_BASE_COMPARTMENTDEFINITION

health.fhir.r5.international500: PROFILE_BASE_COMPOSITION

health.fhir.r5.international500: PROFILE_BASE_COMPUTABLEPLANDEFINITION

health.fhir.r5.international500: PROFILE_BASE_CONCEPTMAP

health.fhir.r5.international500: PROFILE_BASE_CONDITION

health.fhir.r5.international500: PROFILE_BASE_CONDITIONDEFINITION

health.fhir.r5.international500: PROFILE_BASE_CONSENT

health.fhir.r5.international500: PROFILE_BASE_CONTRACT

health.fhir.r5.international500: PROFILE_BASE_COVERAGE

health.fhir.r5.international500: PROFILE_BASE_COVERAGEELIGIBILITYREQUEST

health.fhir.r5.international500: PROFILE_BASE_COVERAGEELIGIBILITYRESPONSE

health.fhir.r5.international500: PROFILE_BASE_CQLLIBRARY

health.fhir.r5.international500: PROFILE_BASE_DETECTEDISSUE

health.fhir.r5.international500: PROFILE_BASE_DEVICE

health.fhir.r5.international500: PROFILE_BASE_DEVICEASSOCIATION

health.fhir.r5.international500: PROFILE_BASE_DEVICEDEFINITION

health.fhir.r5.international500: PROFILE_BASE_DEVICEDISPENSE

health.fhir.r5.international500: PROFILE_BASE_DEVICEMETRIC

health.fhir.r5.international500: PROFILE_BASE_DEVICEMETRICOBSERVATIONPROFILE

health.fhir.r5.international500: PROFILE_BASE_DEVICEREQUEST

health.fhir.r5.international500: PROFILE_BASE_DEVICEUSAGE

health.fhir.r5.international500: PROFILE_BASE_DIAGNOSTICREPORT

health.fhir.r5.international500: PROFILE_BASE_DOCUMENTREFERENCE

health.fhir.r5.international500: PROFILE_BASE_DOCUMENTSECTIONLIBRARY

health.fhir.r5.international500: PROFILE_BASE_DOCUMENTSTRUCTURE

health.fhir.r5.international500: PROFILE_BASE_EBMRECOMMENDATION

health.fhir.r5.international500: PROFILE_BASE_ELMLIBRARY

health.fhir.r5.international500: PROFILE_BASE_ENCOUNTER

health.fhir.r5.international500: PROFILE_BASE_ENCOUNTERHISTORY

health.fhir.r5.international500: PROFILE_BASE_ENDPOINT

health.fhir.r5.international500: PROFILE_BASE_ENROLLMENTREQUEST

health.fhir.r5.international500: PROFILE_BASE_ENROLLMENTRESPONSE

health.fhir.r5.international500: PROFILE_BASE_EPISODEOFCARE

health.fhir.r5.international500: PROFILE_BASE_EVENTDEFINITION