Skip to content

Instantly share code, notes, and snippets.

@kalyanmysore

kalyanmysore/gist:159b54c42a0b6890db181bce5a2ac01b

Created August 27, 2024 23:04
Show Gist options
  • Save kalyanmysore/159b54c42a0b6890db181bce5a2ac01b to your computer and use it in GitHub Desktop.
Save kalyanmysore/159b54c42a0b6890db181bce5a2ac01b to your computer and use it in GitHub Desktop.
Download ZIP
Raw
gistfile1.txt
This file has been truncated, but you can view the full file.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/5.0",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"discriminator": {
"propertyName": "resourceType",
"mapping": {
"Account": "#/definitions/Account",
"ActivityDefinition": "#/definitions/ActivityDefinition",
"ActorDefinition": "#/definitions/ActorDefinition",
"AdministrableProductDefinition": "#/definitions/AdministrableProductDefinition",
"AdverseEvent": "#/definitions/AdverseEvent",
"AllergyIntolerance": "#/definitions/AllergyIntolerance",
"Appointment": "#/definitions/Appointment",
"AppointmentResponse": "#/definitions/AppointmentResponse",
"ArtifactAssessment": "#/definitions/ArtifactAssessment",
"AuditEvent": "#/definitions/AuditEvent",
"Basic": "#/definitions/Basic",
"Binary": "#/definitions/Binary",
"BiologicallyDerivedProduct": "#/definitions/BiologicallyDerivedProduct",
"BiologicallyDerivedProductDispense": "#/definitions/BiologicallyDerivedProductDispense",
"BodyStructure": "#/definitions/BodyStructure",
"Bundle": "#/definitions/Bundle",
"CapabilityStatement": "#/definitions/CapabilityStatement",
"CarePlan": "#/definitions/CarePlan",
"CareTeam": "#/definitions/CareTeam",
"ChargeItem": "#/definitions/ChargeItem",
"ChargeItemDefinition": "#/definitions/ChargeItemDefinition",
"Citation": "#/definitions/Citation",
"Claim": "#/definitions/Claim",
"ClaimResponse": "#/definitions/ClaimResponse",
"ClinicalImpression": "#/definitions/ClinicalImpression",
"ClinicalUseDefinition": "#/definitions/ClinicalUseDefinition",
"CodeSystem": "#/definitions/CodeSystem",
"Communication": "#/definitions/Communication",
"CommunicationRequest": "#/definitions/CommunicationRequest",
"CompartmentDefinition": "#/definitions/CompartmentDefinition",
"Composition": "#/definitions/Composition",
"ConceptMap": "#/definitions/ConceptMap",
"Condition": "#/definitions/Condition",
"ConditionDefinition": "#/definitions/ConditionDefinition",
"Consent": "#/definitions/Consent",
"Contract": "#/definitions/Contract",
"Coverage": "#/definitions/Coverage",
"CoverageEligibilityRequest": "#/definitions/CoverageEligibilityRequest",
"CoverageEligibilityResponse": "#/definitions/CoverageEligibilityResponse",
"DetectedIssue": "#/definitions/DetectedIssue",
"Device": "#/definitions/Device",
"DeviceAssociation": "#/definitions/DeviceAssociation",
"DeviceDefinition": "#/definitions/DeviceDefinition",
"DeviceDispense": "#/definitions/DeviceDispense",
"DeviceMetric": "#/definitions/DeviceMetric",
"DeviceRequest": "#/definitions/DeviceRequest",
"DeviceUsage": "#/definitions/DeviceUsage",
"DiagnosticReport": "#/definitions/DiagnosticReport",
"DocumentReference": "#/definitions/DocumentReference",
"Encounter": "#/definitions/Encounter",
"EncounterHistory": "#/definitions/EncounterHistory",
"Endpoint": "#/definitions/Endpoint",
"EnrollmentRequest": "#/definitions/EnrollmentRequest",
"EnrollmentResponse": "#/definitions/EnrollmentResponse",
"EpisodeOfCare": "#/definitions/EpisodeOfCare",
"EventDefinition": "#/definitions/EventDefinition",
"Evidence": "#/definitions/Evidence",
"EvidenceReport": "#/definitions/EvidenceReport",
"EvidenceVariable": "#/definitions/EvidenceVariable",
"ExampleScenario": "#/definitions/ExampleScenario",
"ExplanationOfBenefit": "#/definitions/ExplanationOfBenefit",
"FamilyMemberHistory": "#/definitions/FamilyMemberHistory",
"Flag": "#/definitions/Flag",
"FormularyItem": "#/definitions/FormularyItem",
"GenomicStudy": "#/definitions/GenomicStudy",
"Goal": "#/definitions/Goal",
"GraphDefinition": "#/definitions/GraphDefinition",
"Group": "#/definitions/Group",
"GuidanceResponse": "#/definitions/GuidanceResponse",
"HealthcareService": "#/definitions/HealthcareService",
"ImagingSelection": "#/definitions/ImagingSelection",
"ImagingStudy": "#/definitions/ImagingStudy",
"Immunization": "#/definitions/Immunization",
"ImmunizationEvaluation": "#/definitions/ImmunizationEvaluation",
"ImmunizationRecommendation": "#/definitions/ImmunizationRecommendation",
"ImplementationGuide": "#/definitions/ImplementationGuide",
"Ingredient": "#/definitions/Ingredient",
"InsurancePlan": "#/definitions/InsurancePlan",
"InventoryItem": "#/definitions/InventoryItem",
"InventoryReport": "#/definitions/InventoryReport",
"Invoice": "#/definitions/Invoice",
"Library": "#/definitions/Library",
"Linkage": "#/definitions/Linkage",
"List": "#/definitions/List",
"Location": "#/definitions/Location",
"ManufacturedItemDefinition": "#/definitions/ManufacturedItemDefinition",
"Measure": "#/definitions/Measure",
"MeasureReport": "#/definitions/MeasureReport",
"Medication": "#/definitions/Medication",
"MedicationAdministration": "#/definitions/MedicationAdministration",
"MedicationDispense": "#/definitions/MedicationDispense",
"MedicationKnowledge": "#/definitions/MedicationKnowledge",
"MedicationRequest": "#/definitions/MedicationRequest",
"MedicationStatement": "#/definitions/MedicationStatement",
"MedicinalProductDefinition": "#/definitions/MedicinalProductDefinition",
"MessageDefinition": "#/definitions/MessageDefinition",
"MessageHeader": "#/definitions/MessageHeader",
"MolecularSequence": "#/definitions/MolecularSequence",
"NamingSystem": "#/definitions/NamingSystem",
"NutritionIntake": "#/definitions/NutritionIntake",
"NutritionOrder": "#/definitions/NutritionOrder",
"NutritionProduct": "#/definitions/NutritionProduct",
"Observation": "#/definitions/Observation",
"ObservationDefinition": "#/definitions/ObservationDefinition",
"OperationDefinition": "#/definitions/OperationDefinition",
"OperationOutcome": "#/definitions/OperationOutcome",
"Organization": "#/definitions/Organization",
"OrganizationAffiliation": "#/definitions/OrganizationAffiliation",
"PackagedProductDefinition": "#/definitions/PackagedProductDefinition",
"Parameters": "#/definitions/Parameters",
"Patient": "#/definitions/Patient",
"PaymentNotice": "#/definitions/PaymentNotice",
"PaymentReconciliation": "#/definitions/PaymentReconciliation",
"Permission": "#/definitions/Permission",
"Person": "#/definitions/Person",
"PlanDefinition": "#/definitions/PlanDefinition",
"Practitioner": "#/definitions/Practitioner",
"PractitionerRole": "#/definitions/PractitionerRole",
"Procedure": "#/definitions/Procedure",
"Provenance": "#/definitions/Provenance",
"Questionnaire": "#/definitions/Questionnaire",
"QuestionnaireResponse": "#/definitions/QuestionnaireResponse",
"RegulatedAuthorization": "#/definitions/RegulatedAuthorization",
"RelatedPerson": "#/definitions/RelatedPerson",
"RequestOrchestration": "#/definitions/RequestOrchestration",
"Requirements": "#/definitions/Requirements",
"ResearchStudy": "#/definitions/ResearchStudy",
"ResearchSubject": "#/definitions/ResearchSubject",
"RiskAssessment": "#/definitions/RiskAssessment",
"Schedule": "#/definitions/Schedule",
"SearchParameter": "#/definitions/SearchParameter",
"ServiceRequest": "#/definitions/ServiceRequest",
"Slot": "#/definitions/Slot",
"Specimen": "#/definitions/Specimen",
"SpecimenDefinition": "#/definitions/SpecimenDefinition",
"StructureDefinition": "#/definitions/StructureDefinition",
"StructureMap": "#/definitions/StructureMap",
"Subscription": "#/definitions/Subscription",
"SubscriptionStatus": "#/definitions/SubscriptionStatus",
"SubscriptionTopic": "#/definitions/SubscriptionTopic",
"Substance": "#/definitions/Substance",
"SubstanceDefinition": "#/definitions/SubstanceDefinition",
"SubstanceNucleicAcid": "#/definitions/SubstanceNucleicAcid",
"SubstancePolymer": "#/definitions/SubstancePolymer",
"SubstanceProtein": "#/definitions/SubstanceProtein",
"SubstanceReferenceInformation": "#/definitions/SubstanceReferenceInformation",
"SubstanceSourceMaterial": "#/definitions/SubstanceSourceMaterial",
"SupplyDelivery": "#/definitions/SupplyDelivery",
"SupplyRequest": "#/definitions/SupplyRequest",
"Task": "#/definitions/Task",
"TerminologyCapabilities": "#/definitions/TerminologyCapabilities",
"TestPlan": "#/definitions/TestPlan",
"TestReport": "#/definitions/TestReport",
"TestScript": "#/definitions/TestScript",
"Transport": "#/definitions/Transport",
"ValueSet": "#/definitions/ValueSet",
"VerificationResult": "#/definitions/VerificationResult",
"VisionPrescription": "#/definitions/VisionPrescription"
}
},
"oneOf": [
{
"$ref": "#/definitions/Account"
},
{
"$ref": "#/definitions/ActivityDefinition"
},
{
"$ref": "#/definitions/ActorDefinition"
},
{
"$ref": "#/definitions/AdministrableProductDefinition"
},
{
"$ref": "#/definitions/AdverseEvent"
},
{
"$ref": "#/definitions/AllergyIntolerance"
},
{
"$ref": "#/definitions/Appointment"
},
{
"$ref": "#/definitions/AppointmentResponse"
},
{
"$ref": "#/definitions/ArtifactAssessment"
},
{
"$ref": "#/definitions/AuditEvent"
},
{
"$ref": "#/definitions/Basic"
},
{
"$ref": "#/definitions/Binary"
},
{
"$ref": "#/definitions/BiologicallyDerivedProduct"
},
{
"$ref": "#/definitions/BiologicallyDerivedProductDispense"
},
{
"$ref": "#/definitions/BodyStructure"
},
{
"$ref": "#/definitions/Bundle"
},
{
"$ref": "#/definitions/CapabilityStatement"
},
{
"$ref": "#/definitions/CarePlan"
},
{
"$ref": "#/definitions/CareTeam"
},
{
"$ref": "#/definitions/ChargeItem"
},
{
"$ref": "#/definitions/ChargeItemDefinition"
},
{
"$ref": "#/definitions/Citation"
},
{
"$ref": "#/definitions/Claim"
},
{
"$ref": "#/definitions/ClaimResponse"
},
{
"$ref": "#/definitions/ClinicalImpression"
},
{
"$ref": "#/definitions/ClinicalUseDefinition"
},
{
"$ref": "#/definitions/CodeSystem"
},
{
"$ref": "#/definitions/Communication"
},
{
"$ref": "#/definitions/CommunicationRequest"
},
{
"$ref": "#/definitions/CompartmentDefinition"
},
{
"$ref": "#/definitions/Composition"
},
{
"$ref": "#/definitions/ConceptMap"
},
{
"$ref": "#/definitions/Condition"
},
{
"$ref": "#/definitions/ConditionDefinition"
},
{
"$ref": "#/definitions/Consent"
},
{
"$ref": "#/definitions/Contract"
},
{
"$ref": "#/definitions/Coverage"
},
{
"$ref": "#/definitions/CoverageEligibilityRequest"
},
{
"$ref": "#/definitions/CoverageEligibilityResponse"
},
{
"$ref": "#/definitions/DetectedIssue"
},
{
"$ref": "#/definitions/Device"
},
{
"$ref": "#/definitions/DeviceAssociation"
},
{
"$ref": "#/definitions/DeviceDefinition"
},
{
"$ref": "#/definitions/DeviceDispense"
},
{
"$ref": "#/definitions/DeviceMetric"
},
{
"$ref": "#/definitions/DeviceRequest"
},
{
"$ref": "#/definitions/DeviceUsage"
},
{
"$ref": "#/definitions/DiagnosticReport"
},
{
"$ref": "#/definitions/DocumentReference"
},
{
"$ref": "#/definitions/Encounter"
},
{
"$ref": "#/definitions/EncounterHistory"
},
{
"$ref": "#/definitions/Endpoint"
},
{
"$ref": "#/definitions/EnrollmentRequest"
},
{
"$ref": "#/definitions/EnrollmentResponse"
},
{
"$ref": "#/definitions/EpisodeOfCare"
},
{
"$ref": "#/definitions/EventDefinition"
},
{
"$ref": "#/definitions/Evidence"
},
{
"$ref": "#/definitions/EvidenceReport"
},
{
"$ref": "#/definitions/EvidenceVariable"
},
{
"$ref": "#/definitions/ExampleScenario"
},
{
"$ref": "#/definitions/ExplanationOfBenefit"
},
{
"$ref": "#/definitions/FamilyMemberHistory"
},
{
"$ref": "#/definitions/Flag"
},
{
"$ref": "#/definitions/FormularyItem"
},
{
"$ref": "#/definitions/GenomicStudy"
},
{
"$ref": "#/definitions/Goal"
},
{
"$ref": "#/definitions/GraphDefinition"
},
{
"$ref": "#/definitions/Group"
},
{
"$ref": "#/definitions/GuidanceResponse"
},
{
"$ref": "#/definitions/HealthcareService"
},
{
"$ref": "#/definitions/ImagingSelection"
},
{
"$ref": "#/definitions/ImagingStudy"
},
{
"$ref": "#/definitions/Immunization"
},
{
"$ref": "#/definitions/ImmunizationEvaluation"
},
{
"$ref": "#/definitions/ImmunizationRecommendation"
},
{
"$ref": "#/definitions/ImplementationGuide"
},
{
"$ref": "#/definitions/Ingredient"
},
{
"$ref": "#/definitions/InsurancePlan"
},
{
"$ref": "#/definitions/InventoryItem"
},
{
"$ref": "#/definitions/InventoryReport"
},
{
"$ref": "#/definitions/Invoice"
},
{
"$ref": "#/definitions/Library"
},
{
"$ref": "#/definitions/Linkage"
},
{
"$ref": "#/definitions/List"
},
{
"$ref": "#/definitions/Location"
},
{
"$ref": "#/definitions/ManufacturedItemDefinition"
},
{
"$ref": "#/definitions/Measure"
},
{
"$ref": "#/definitions/MeasureReport"
},
{
"$ref": "#/definitions/Medication"
},
{
"$ref": "#/definitions/MedicationAdministration"
},
{
"$ref": "#/definitions/MedicationDispense"
},
{
"$ref": "#/definitions/MedicationKnowledge"
},
{
"$ref": "#/definitions/MedicationRequest"
},
{
"$ref": "#/definitions/MedicationStatement"
},
{
"$ref": "#/definitions/MedicinalProductDefinition"
},
{
"$ref": "#/definitions/MessageDefinition"
},
{
"$ref": "#/definitions/MessageHeader"
},
{
"$ref": "#/definitions/MolecularSequence"
},
{
"$ref": "#/definitions/NamingSystem"
},
{
"$ref": "#/definitions/NutritionIntake"
},
{
"$ref": "#/definitions/NutritionOrder"
},
{
"$ref": "#/definitions/NutritionProduct"
},
{
"$ref": "#/definitions/Observation"
},
{
"$ref": "#/definitions/ObservationDefinition"
},
{
"$ref": "#/definitions/OperationDefinition"
},
{
"$ref": "#/definitions/OperationOutcome"
},
{
"$ref": "#/definitions/Organization"
},
{
"$ref": "#/definitions/OrganizationAffiliation"
},
{
"$ref": "#/definitions/PackagedProductDefinition"
},
{
"$ref": "#/definitions/Parameters"
},
{
"$ref": "#/definitions/Patient"
},
{
"$ref": "#/definitions/PaymentNotice"
},
{
"$ref": "#/definitions/PaymentReconciliation"
},
{
"$ref": "#/definitions/Permission"
},
{
"$ref": "#/definitions/Person"
},
{
"$ref": "#/definitions/PlanDefinition"
},
{
"$ref": "#/definitions/Practitioner"
},
{
"$ref": "#/definitions/PractitionerRole"
},
{
"$ref": "#/definitions/Procedure"
},
{
"$ref": "#/definitions/Provenance"
},
{
"$ref": "#/definitions/Questionnaire"
},
{
"$ref": "#/definitions/QuestionnaireResponse"
},
{
"$ref": "#/definitions/RegulatedAuthorization"
},
{
"$ref": "#/definitions/RelatedPerson"
},
{
"$ref": "#/definitions/RequestOrchestration"
},
{
"$ref": "#/definitions/Requirements"
},
{
"$ref": "#/definitions/ResearchStudy"
},
{
"$ref": "#/definitions/ResearchSubject"
},
{
"$ref": "#/definitions/RiskAssessment"
},
{
"$ref": "#/definitions/Schedule"
},
{
"$ref": "#/definitions/SearchParameter"
},
{
"$ref": "#/definitions/ServiceRequest"
},
{
"$ref": "#/definitions/Slot"
},
{
"$ref": "#/definitions/Specimen"
},
{
"$ref": "#/definitions/SpecimenDefinition"
},
{
"$ref": "#/definitions/StructureDefinition"
},
{
"$ref": "#/definitions/StructureMap"
},
{
"$ref": "#/definitions/Subscription"
},
{
"$ref": "#/definitions/SubscriptionStatus"
},
{
"$ref": "#/definitions/SubscriptionTopic"
},
{
"$ref": "#/definitions/Substance"
},
{
"$ref": "#/definitions/SubstanceDefinition"
},
{
"$ref": "#/definitions/SubstanceNucleicAcid"
},
{
"$ref": "#/definitions/SubstancePolymer"
},
{
"$ref": "#/definitions/SubstanceProtein"
},
{
"$ref": "#/definitions/SubstanceReferenceInformation"
},
{
"$ref": "#/definitions/SubstanceSourceMaterial"
},
{
"$ref": "#/definitions/SupplyDelivery"
},
{
"$ref": "#/definitions/SupplyRequest"
},
{
"$ref": "#/definitions/Task"
},
{
"$ref": "#/definitions/TerminologyCapabilities"
},
{
"$ref": "#/definitions/TestPlan"
},
{
"$ref": "#/definitions/TestReport"
},
{
"$ref": "#/definitions/TestScript"
},
{
"$ref": "#/definitions/Transport"
},
{
"$ref": "#/definitions/ValueSet"
},
{
"$ref": "#/definitions/VerificationResult"
},
{
"$ref": "#/definitions/VisionPrescription"
}
],
"definitions": {
"ResourceList": {
"oneOf": [
{
"$ref": "#/definitions/Account"
},
{
"$ref": "#/definitions/ActivityDefinition"
},
{
"$ref": "#/definitions/ActorDefinition"
},
{
"$ref": "#/definitions/AdministrableProductDefinition"
},
{
"$ref": "#/definitions/AdverseEvent"
},
{
"$ref": "#/definitions/AllergyIntolerance"
},
{
"$ref": "#/definitions/Appointment"
},
{
"$ref": "#/definitions/AppointmentResponse"
},
{
"$ref": "#/definitions/ArtifactAssessment"
},
{
"$ref": "#/definitions/AuditEvent"
},
{
"$ref": "#/definitions/Basic"
},
{
"$ref": "#/definitions/Binary"
},
{
"$ref": "#/definitions/BiologicallyDerivedProduct"
},
{
"$ref": "#/definitions/BiologicallyDerivedProductDispense"
},
{
"$ref": "#/definitions/BodyStructure"
},
{
"$ref": "#/definitions/Bundle"
},
{
"$ref": "#/definitions/CapabilityStatement"
},
{
"$ref": "#/definitions/CarePlan"
},
{
"$ref": "#/definitions/CareTeam"
},
{
"$ref": "#/definitions/ChargeItem"
},
{
"$ref": "#/definitions/ChargeItemDefinition"
},
{
"$ref": "#/definitions/Citation"
},
{
"$ref": "#/definitions/Claim"
},
{
"$ref": "#/definitions/ClaimResponse"
},
{
"$ref": "#/definitions/ClinicalImpression"
},
{
"$ref": "#/definitions/ClinicalUseDefinition"
},
{
"$ref": "#/definitions/CodeSystem"
},
{
"$ref": "#/definitions/Communication"
},
{
"$ref": "#/definitions/CommunicationRequest"
},
{
"$ref": "#/definitions/CompartmentDefinition"
},
{
"$ref": "#/definitions/Composition"
},
{
"$ref": "#/definitions/ConceptMap"
},
{
"$ref": "#/definitions/Condition"
},
{
"$ref": "#/definitions/ConditionDefinition"
},
{
"$ref": "#/definitions/Consent"
},
{
"$ref": "#/definitions/Contract"
},
{
"$ref": "#/definitions/Coverage"
},
{
"$ref": "#/definitions/CoverageEligibilityRequest"
},
{
"$ref": "#/definitions/CoverageEligibilityResponse"
},
{
"$ref": "#/definitions/DetectedIssue"
},
{
"$ref": "#/definitions/Device"
},
{
"$ref": "#/definitions/DeviceAssociation"
},
{
"$ref": "#/definitions/DeviceDefinition"
},
{
"$ref": "#/definitions/DeviceDispense"
},
{
"$ref": "#/definitions/DeviceMetric"
},
{
"$ref": "#/definitions/DeviceRequest"
},
{
"$ref": "#/definitions/DeviceUsage"
},
{
"$ref": "#/definitions/DiagnosticReport"
},
{
"$ref": "#/definitions/DocumentReference"
},
{
"$ref": "#/definitions/Encounter"
},
{
"$ref": "#/definitions/EncounterHistory"
},
{
"$ref": "#/definitions/Endpoint"
},
{
"$ref": "#/definitions/EnrollmentRequest"
},
{
"$ref": "#/definitions/EnrollmentResponse"
},
{
"$ref": "#/definitions/EpisodeOfCare"
},
{
"$ref": "#/definitions/EventDefinition"
},
{
"$ref": "#/definitions/Evidence"
},
{
"$ref": "#/definitions/EvidenceReport"
},
{
"$ref": "#/definitions/EvidenceVariable"
},
{
"$ref": "#/definitions/ExampleScenario"
},
{
"$ref": "#/definitions/ExplanationOfBenefit"
},
{
"$ref": "#/definitions/FamilyMemberHistory"
},
{
"$ref": "#/definitions/Flag"
},
{
"$ref": "#/definitions/FormularyItem"
},
{
"$ref": "#/definitions/GenomicStudy"
},
{
"$ref": "#/definitions/Goal"
},
{
"$ref": "#/definitions/GraphDefinition"
},
{
"$ref": "#/definitions/Group"
},
{
"$ref": "#/definitions/GuidanceResponse"
},
{
"$ref": "#/definitions/HealthcareService"
},
{
"$ref": "#/definitions/ImagingSelection"
},
{
"$ref": "#/definitions/ImagingStudy"
},
{
"$ref": "#/definitions/Immunization"
},
{
"$ref": "#/definitions/ImmunizationEvaluation"
},
{
"$ref": "#/definitions/ImmunizationRecommendation"
},
{
"$ref": "#/definitions/ImplementationGuide"
},
{
"$ref": "#/definitions/Ingredient"
},
{
"$ref": "#/definitions/InsurancePlan"
},
{
"$ref": "#/definitions/InventoryItem"
},
{
"$ref": "#/definitions/InventoryReport"
},
{
"$ref": "#/definitions/Invoice"
},
{
"$ref": "#/definitions/Library"
},
{
"$ref": "#/definitions/Linkage"
},
{
"$ref": "#/definitions/List"
},
{
"$ref": "#/definitions/Location"
},
{
"$ref": "#/definitions/ManufacturedItemDefinition"
},
{
"$ref": "#/definitions/Measure"
},
{
"$ref": "#/definitions/MeasureReport"
},
{
"$ref": "#/definitions/Medication"
},
{
"$ref": "#/definitions/MedicationAdministration"
},
{
"$ref": "#/definitions/MedicationDispense"
},
{
"$ref": "#/definitions/MedicationKnowledge"
},
{
"$ref": "#/definitions/MedicationRequest"
},
{
"$ref": "#/definitions/MedicationStatement"
},
{
"$ref": "#/definitions/MedicinalProductDefinition"
},
{
"$ref": "#/definitions/MessageDefinition"
},
{
"$ref": "#/definitions/MessageHeader"
},
{
"$ref": "#/definitions/MolecularSequence"
},
{
"$ref": "#/definitions/NamingSystem"
},
{
"$ref": "#/definitions/NutritionIntake"
},
{
"$ref": "#/definitions/NutritionOrder"
},
{
"$ref": "#/definitions/NutritionProduct"
},
{
"$ref": "#/definitions/Observation"
},
{
"$ref": "#/definitions/ObservationDefinition"
},
{
"$ref": "#/definitions/OperationDefinition"
},
{
"$ref": "#/definitions/OperationOutcome"
},
{
"$ref": "#/definitions/Organization"
},
{
"$ref": "#/definitions/OrganizationAffiliation"
},
{
"$ref": "#/definitions/PackagedProductDefinition"
},
{
"$ref": "#/definitions/Parameters"
},
{
"$ref": "#/definitions/Patient"
},
{
"$ref": "#/definitions/PaymentNotice"
},
{
"$ref": "#/definitions/PaymentReconciliation"
},
{
"$ref": "#/definitions/Permission"
},
{
"$ref": "#/definitions/Person"
},
{
"$ref": "#/definitions/PlanDefinition"
},
{
"$ref": "#/definitions/Practitioner"
},
{
"$ref": "#/definitions/PractitionerRole"
},
{
"$ref": "#/definitions/Procedure"
},
{
"$ref": "#/definitions/Provenance"
},
{
"$ref": "#/definitions/Questionnaire"
},
{
"$ref": "#/definitions/QuestionnaireResponse"
},
{
"$ref": "#/definitions/RegulatedAuthorization"
},
{
"$ref": "#/definitions/RelatedPerson"
},
{
"$ref": "#/definitions/RequestOrchestration"
},
{
"$ref": "#/definitions/Requirements"
},
{
"$ref": "#/definitions/ResearchStudy"
},
{
"$ref": "#/definitions/ResearchSubject"
},
{
"$ref": "#/definitions/RiskAssessment"
},
{
"$ref": "#/definitions/Schedule"
},
{
"$ref": "#/definitions/SearchParameter"
},
{
"$ref": "#/definitions/ServiceRequest"
},
{
"$ref": "#/definitions/Slot"
},
{
"$ref": "#/definitions/Specimen"
},
{
"$ref": "#/definitions/SpecimenDefinition"
},
{
"$ref": "#/definitions/StructureDefinition"
},
{
"$ref": "#/definitions/StructureMap"
},
{
"$ref": "#/definitions/Subscription"
},
{
"$ref": "#/definitions/SubscriptionStatus"
},
{
"$ref": "#/definitions/SubscriptionTopic"
},
{
"$ref": "#/definitions/Substance"
},
{
"$ref": "#/definitions/SubstanceDefinition"
},
{
"$ref": "#/definitions/SubstanceNucleicAcid"
},
{
"$ref": "#/definitions/SubstancePolymer"
},
{
"$ref": "#/definitions/SubstanceProtein"
},
{
"$ref": "#/definitions/SubstanceReferenceInformation"
},
{
"$ref": "#/definitions/SubstanceSourceMaterial"
},
{
"$ref": "#/definitions/SupplyDelivery"
},
{
"$ref": "#/definitions/SupplyRequest"
},
{
"$ref": "#/definitions/Task"
},
{
"$ref": "#/definitions/TerminologyCapabilities"
},
{
"$ref": "#/definitions/TestPlan"
},
{
"$ref": "#/definitions/TestReport"
},
{
"$ref": "#/definitions/TestScript"
},
{
"$ref": "#/definitions/Transport"
},
{
"$ref": "#/definitions/ValueSet"
},
{
"$ref": "#/definitions/VerificationResult"
},
{
"$ref": "#/definitions/VisionPrescription"
}
]
},
"base64Binary": {
"type": "string",
"description": "A stream of bytes"
},
"boolean": {
"pattern": "^true|false$",
"type": "boolean",
"description": "Value of \"true\" or \"false\""
},
"canonical": {
"pattern": "^\\S*$",
"type": "string",
"description": "A URI that is a reference to a canonical URL on a FHIR resource"
},
"code": {
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string",
"description": "A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents"
},
"date": {
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string",
"description": "A date or partial date (e.g. just year or year + month). There is no UTC offset. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates."
},
"dateTime": {
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string",
"description": "A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates."
},
"decimal": {
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number",
"description": "A rational number with implicit precision"
},
"id": {
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string",
"description": "Any combination of letters, numerals, \"-\" and \".\", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive."
},
"instant": {
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string",
"description": "An instant in time - known at least to the second"
},
"integer": {
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number",
"description": "A whole number"
},
"integer64": {
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string",
"description": "A very large whole number"
},
"markdown": {
"pattern": "^^[\\s\\S]+$$",
"type": "string",
"description": "A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine"
},
"oid": {
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string",
"description": "An OID represented as a URI"
},
"positiveInt": {
"pattern": "^[1-9][0-9]*$",
"type": "number",
"description": "An integer with a value that is positive (e.g. \u003e0)"
},
"string": {
"pattern": "^^[\\s\\S]+$$",
"type": "string",
"description": "A sequence of Unicode characters"
},
"time": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string",
"description": "A time during the day, with no date specified"
},
"unsignedInt": {
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number",
"description": "An integer with a value that is not negative (e.g. \u003e\u003d 0)"
},
"uri": {
"pattern": "^\\S*$",
"type": "string",
"description": "String of characters used to identify a name or a resource"
},
"url": {
"pattern": "^\\S*$",
"type": "string",
"description": "A URI that is a literal reference"
},
"uuid": {
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string",
"description": "A UUID, represented as a URI"
},
"xhtml": {
"description": "xhtml - escaped html (see specfication)"
},
"Base": {
"description": "Base definition for all types defined in FHIR type system.",
"properties": {},
"type": "object",
"additionalProperties": false
},
"Element": {
"description": "Base definition for all elements in a resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DataType": {
"description": "The base class for all re-useable types defined as part of the FHIR Specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"PrimitiveType": {
"description": "The base type for all re-useable types defined that have a simple property.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"BackboneType": {
"description": "Base definition for the few data types that are allowed to carry modifier extensions.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Extension": {
"description": "Optional Extension Element - found in all resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "Source of the definition for the extension code - a logical name or a URL.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"valueBase64Binary": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
"type": "string"
},
"_valueBase64Binary": {
"description": "Extensions for valueBase64Binary",
"$ref": "#/definitions/Element"
},
"valueBoolean": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "#/definitions/Element"
},
"valueCanonical": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^\\S*$",
"type": "string"
},
"_valueCanonical": {
"description": "Extensions for valueCanonical",
"$ref": "#/definitions/Element"
},
"valueCode": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "#/definitions/Element"
},
"valueDate": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_valueDate": {
"description": "Extensions for valueDate",
"$ref": "#/definitions/Element"
},
"valueDateTime": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "#/definitions/Element"
},
"valueDecimal": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "#/definitions/Element"
},
"valueId": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_valueId": {
"description": "Extensions for valueId",
"$ref": "#/definitions/Element"
},
"valueInstant": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_valueInstant": {
"description": "Extensions for valueInstant",
"$ref": "#/definitions/Element"
},
"valueInteger": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "#/definitions/Element"
},
"valueInteger64": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_valueInteger64": {
"description": "Extensions for valueInteger64",
"$ref": "#/definitions/Element"
},
"valueMarkdown": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueMarkdown": {
"description": "Extensions for valueMarkdown",
"$ref": "#/definitions/Element"
},
"valueOid": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string"
},
"_valueOid": {
"description": "Extensions for valueOid",
"$ref": "#/definitions/Element"
},
"valuePositiveInt": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_valuePositiveInt": {
"description": "Extensions for valuePositiveInt",
"$ref": "#/definitions/Element"
},
"valueString": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "#/definitions/Element"
},
"valueTime": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "#/definitions/Element"
},
"valueUnsignedInt": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_valueUnsignedInt": {
"description": "Extensions for valueUnsignedInt",
"$ref": "#/definitions/Element"
},
"valueUri": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "#/definitions/Element"
},
"valueUrl": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUrl": {
"description": "Extensions for valueUrl",
"$ref": "#/definitions/Element"
},
"valueUuid": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
"_valueUuid": {
"description": "Extensions for valueUuid",
"$ref": "#/definitions/Element"
},
"valueAddress": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Address"
},
"valueAge": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Age"
},
"valueAnnotation": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Annotation"
},
"valueAttachment": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Attachment"
},
"valueCodeableConcept": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/CodeableConcept"
},
"valueCodeableReference": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/CodeableReference"
},
"valueCoding": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Coding"
},
"valueContactPoint": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/ContactPoint"
},
"valueCount": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Count"
},
"valueDistance": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Distance"
},
"valueDuration": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Duration"
},
"valueHumanName": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/HumanName"
},
"valueIdentifier": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Identifier"
},
"valueMoney": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Money"
},
"valuePeriod": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Period"
},
"valueQuantity": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Quantity"
},
"valueRange": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Range"
},
"valueRatio": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Ratio"
},
"valueRatioRange": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/RatioRange"
},
"valueReference": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Reference"
},
"valueSampledData": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/SampledData"
},
"valueSignature": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Signature"
},
"valueTiming": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Timing"
},
"valueContactDetail": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/ContactDetail"
},
"valueDataRequirement": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/DataRequirement"
},
"valueExpression": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Expression"
},
"valueParameterDefinition": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/ParameterDefinition"
},
"valueRelatedArtifact": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/RelatedArtifact"
},
"valueTriggerDefinition": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/TriggerDefinition"
},
"valueUsageContext": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/UsageContext"
},
"valueAvailability": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Availability"
},
"valueExtendedContactDetail": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/ExtendedContactDetail"
},
"valueDosage": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Dosage"
},
"valueMeta": {
"description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"$ref": "#/definitions/Meta"
}
},
"type": "object",
"additionalProperties": false
},
"Narrative": {
"description": "A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"status": {
"description": "The status of the narrative - whether it\u0027s entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.",
"enum": [
"generated",
"extensions",
"additional",
"empty"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"div": {
"description": "The actual narrative content, a stripped down version of XHTML.",
"$ref": "#/definitions/xhtml"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"div"
]
},
"Annotation": {
"description": "A text note which also contains information about who made the statement and when.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"authorReference": {
"description": "The individual responsible for making the annotation.",
"$ref": "#/definitions/Reference"
},
"authorString": {
"description": "The individual responsible for making the annotation.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_authorString": {
"description": "Extensions for authorString",
"$ref": "#/definitions/Element"
},
"time": {
"description": "Indicates when this particular annotation was made.",
"$ref": "#/definitions/dateTime"
},
"_time": {
"description": "Extensions for time",
"$ref": "#/definitions/Element"
},
"text": {
"description": "The text of the annotation in markdown format.",
"$ref": "#/definitions/markdown"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Attachment": {
"description": "For referring to data content defined in other formats.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"contentType": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_contentType": {
"description": "Extensions for contentType",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The human language of the content. The value can be any valid value according to BCP 47.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"data": {
"description": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"$ref": "#/definitions/base64Binary"
},
"_data": {
"description": "Extensions for data",
"$ref": "#/definitions/Element"
},
"url": {
"description": "A location where the data can be accessed.",
"$ref": "#/definitions/url"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"size": {
"description": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"$ref": "#/definitions/integer64"
},
"_size": {
"description": "Extensions for size",
"$ref": "#/definitions/Element"
},
"hash": {
"description": "The calculated hash of the data using SHA-1. Represented using base64.",
"$ref": "#/definitions/base64Binary"
},
"_hash": {
"description": "Extensions for hash",
"$ref": "#/definitions/Element"
},
"title": {
"description": "A label or set of text to display in place of the data.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"creation": {
"description": "The date that the attachment was first created.",
"$ref": "#/definitions/dateTime"
},
"_creation": {
"description": "Extensions for creation",
"$ref": "#/definitions/Element"
},
"height": {
"description": "Height of the image in pixels (photo/video).",
"$ref": "#/definitions/positiveInt"
},
"_height": {
"description": "Extensions for height",
"$ref": "#/definitions/Element"
},
"width": {
"description": "Width of the image in pixels (photo/video).",
"$ref": "#/definitions/positiveInt"
},
"_width": {
"description": "Extensions for width",
"$ref": "#/definitions/Element"
},
"frames": {
"description": "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.",
"$ref": "#/definitions/positiveInt"
},
"_frames": {
"description": "Extensions for frames",
"$ref": "#/definitions/Element"
},
"duration": {
"description": "The duration of the recording in seconds - for audio and video.",
"$ref": "#/definitions/decimal"
},
"_duration": {
"description": "Extensions for duration",
"$ref": "#/definitions/Element"
},
"pages": {
"description": "The number of pages when printed.",
"$ref": "#/definitions/positiveInt"
},
"_pages": {
"description": "Extensions for pages",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Identifier": {
"description": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"use": {
"description": "The purpose of this identifier.",
"enum": [
"usual",
"official",
"temp",
"secondary",
"old"
]
},
"_use": {
"description": "Extensions for use",
"$ref": "#/definitions/Element"
},
"type": {
"description": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"$ref": "#/definitions/CodeableConcept"
},
"system": {
"description": "Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"value": {
"description": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"period": {
"description": "Time period during which identifier is/was valid for use.",
"$ref": "#/definitions/Period"
},
"assigner": {
"description": "Organization that issued/manages the identifier.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"CodeableConcept": {
"description": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"coding": {
"description": "A reference to a code defined by a terminology system.",
"items": {
"$ref": "#/definitions/Coding"
},
"type": "array"
},
"text": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"CodeableReference": {
"description": "A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"concept": {
"description": "A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.",
"$ref": "#/definitions/CodeableConcept"
},
"reference": {
"description": "A reference to a resource the provides exact details about the information being referenced.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"Coding": {
"description": "A reference to a code defined by a terminology system.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"system": {
"description": "The identification of the code system that defines the meaning of the symbol in the code.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"code": {
"description": "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).",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
},
"display": {
"description": "A representation of the meaning of the code in the system, following the rules of the system.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "#/definitions/Element"
},
"userSelected": {
"description": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"$ref": "#/definitions/boolean"
},
"_userSelected": {
"description": "Extensions for userSelected",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Quantity": {
"description": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"comparator": {
"description": "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 \"\u003c\" , then the real value is \u003c stated value.",
"enum": [
"\u003c",
"\u003c\u003d",
"\u003e\u003d",
"\u003e",
"ad"
]
},
"_comparator": {
"description": "Extensions for comparator",
"$ref": "#/definitions/Element"
},
"unit": {
"description": "A human-readable form of the unit.",
"$ref": "#/definitions/string"
},
"_unit": {
"description": "Extensions for unit",
"$ref": "#/definitions/Element"
},
"system": {
"description": "The identification of the system that provides the coded form of the unit.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A computer processable form of the unit in some unit representation system.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Duration": {
"description": "A length of time.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"comparator": {
"description": "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 \"\u003c\" , then the real value is \u003c stated value.",
"enum": [
"\u003c",
"\u003c\u003d",
"\u003e\u003d",
"\u003e",
"ad"
]
},
"_comparator": {
"description": "Extensions for comparator",
"$ref": "#/definitions/Element"
},
"unit": {
"description": "A human-readable form of the unit.",
"$ref": "#/definitions/string"
},
"_unit": {
"description": "Extensions for unit",
"$ref": "#/definitions/Element"
},
"system": {
"description": "The identification of the system that provides the coded form of the unit.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A computer processable form of the unit in some unit representation system.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Distance": {
"description": "A length - a value with a unit that is a physical distance.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"comparator": {
"description": "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 \"\u003c\" , then the real value is \u003c stated value.",
"enum": [
"\u003c",
"\u003c\u003d",
"\u003e\u003d",
"\u003e",
"ad"
]
},
"_comparator": {
"description": "Extensions for comparator",
"$ref": "#/definitions/Element"
},
"unit": {
"description": "A human-readable form of the unit.",
"$ref": "#/definitions/string"
},
"_unit": {
"description": "Extensions for unit",
"$ref": "#/definitions/Element"
},
"system": {
"description": "The identification of the system that provides the coded form of the unit.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A computer processable form of the unit in some unit representation system.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Count": {
"description": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"comparator": {
"description": "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 \"\u003c\" , then the real value is \u003c stated value.",
"enum": [
"\u003c",
"\u003c\u003d",
"\u003e\u003d",
"\u003e",
"ad"
]
},
"_comparator": {
"description": "Extensions for comparator",
"$ref": "#/definitions/Element"
},
"unit": {
"description": "A human-readable form of the unit.",
"$ref": "#/definitions/string"
},
"_unit": {
"description": "Extensions for unit",
"$ref": "#/definitions/Element"
},
"system": {
"description": "The identification of the system that provides the coded form of the unit.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A computer processable form of the unit in some unit representation system.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Money": {
"description": "An amount of economic utility in some recognized currency.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "Numerical value (with implicit precision).",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"currency": {
"description": "ISO 4217 Currency Code.",
"$ref": "#/definitions/code"
},
"_currency": {
"description": "Extensions for currency",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Age": {
"description": "A duration of time during which an organism (or a process) has existed.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"comparator": {
"description": "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 \"\u003c\" , then the real value is \u003c stated value.",
"enum": [
"\u003c",
"\u003c\u003d",
"\u003e\u003d",
"\u003e",
"ad"
]
},
"_comparator": {
"description": "Extensions for comparator",
"$ref": "#/definitions/Element"
},
"unit": {
"description": "A human-readable form of the unit.",
"$ref": "#/definitions/string"
},
"_unit": {
"description": "Extensions for unit",
"$ref": "#/definitions/Element"
},
"system": {
"description": "The identification of the system that provides the coded form of the unit.",
"$ref": "#/definitions/uri"
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A computer processable form of the unit in some unit representation system.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Range": {
"description": "A set of ordered Quantities defined by a low and high limit.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"low": {
"description": "The low limit. The boundary is inclusive.",
"$ref": "#/definitions/Quantity"
},
"high": {
"description": "The high limit. The boundary is inclusive.",
"$ref": "#/definitions/Quantity"
}
},
"type": "object",
"additionalProperties": false
},
"Period": {
"description": "A time period defined by a start and end date and optionally time.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"start": {
"description": "The start of the period. The boundary is inclusive.",
"$ref": "#/definitions/dateTime"
},
"_start": {
"description": "Extensions for start",
"$ref": "#/definitions/Element"
},
"end": {
"description": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"$ref": "#/definitions/dateTime"
},
"_end": {
"description": "Extensions for end",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Ratio": {
"description": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"numerator": {
"description": "The value of the numerator.",
"$ref": "#/definitions/Quantity"
},
"denominator": {
"description": "The value of the denominator.",
"$ref": "#/definitions/Quantity"
}
},
"type": "object",
"additionalProperties": false
},
"RatioRange": {
"description": "A range of ratios expressed as a low and high numerator and a denominator.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"lowNumerator": {
"description": "The value of the low limit numerator.",
"$ref": "#/definitions/Quantity"
},
"highNumerator": {
"description": "The value of the high limit numerator.",
"$ref": "#/definitions/Quantity"
},
"denominator": {
"description": "The value of the denominator.",
"$ref": "#/definitions/Quantity"
}
},
"type": "object",
"additionalProperties": false
},
"Reference": {
"description": "A reference from one resource to another.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"reference": {
"description": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with \u0027#\u0027) refer to contained resources.",
"$ref": "#/definitions/string"
},
"_reference": {
"description": "Extensions for reference",
"$ref": "#/definitions/Element"
},
"type": {
"description": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"$ref": "#/definitions/uri"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"$ref": "#/definitions/Identifier"
},
"display": {
"description": "Plain text narrative that identifies the resource in addition to the resource reference.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"SampledData": {
"description": "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"origin": {
"description": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.",
"$ref": "#/definitions/Quantity"
},
"interval": {
"description": "Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.",
"$ref": "#/definitions/decimal"
},
"_interval": {
"description": "Extensions for interval",
"$ref": "#/definitions/Element"
},
"intervalUnit": {
"description": "The measurement unit in which the sample interval is expressed.",
"$ref": "#/definitions/code"
},
"_intervalUnit": {
"description": "Extensions for intervalUnit",
"$ref": "#/definitions/Element"
},
"factor": {
"description": "A correction factor that is applied to the sampled data points before they are added to the origin.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "#/definitions/Element"
},
"lowerLimit": {
"description": "The lower limit of detection of the measured points. This is needed if any of the data points have the value \"L\" (lower than detection limit).",
"$ref": "#/definitions/decimal"
},
"_lowerLimit": {
"description": "Extensions for lowerLimit",
"$ref": "#/definitions/Element"
},
"upperLimit": {
"description": "The upper limit of detection of the measured points. This is needed if any of the data points have the value \"U\" (higher than detection limit).",
"$ref": "#/definitions/decimal"
},
"_upperLimit": {
"description": "Extensions for upperLimit",
"$ref": "#/definitions/Element"
},
"dimensions": {
"description": "The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.",
"$ref": "#/definitions/positiveInt"
},
"_dimensions": {
"description": "Extensions for dimensions",
"$ref": "#/definitions/Element"
},
"codeMap": {
"description": "Reference to ConceptMap that defines the codes used in the data.",
"$ref": "#/definitions/canonical"
},
"offsets": {
"description": "A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.",
"$ref": "#/definitions/string"
},
"_offsets": {
"description": "Extensions for offsets",
"$ref": "#/definitions/Element"
},
"data": {
"description": "A series of data points which are decimal values or codes separated by a single space (character u20). The special codes \"E\" (error), \"L\" (below detection limit) and \"U\" (above detection limit) are also defined for used in place of decimal values.",
"$ref": "#/definitions/string"
},
"_data": {
"description": "Extensions for data",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"origin"
]
},
"Signature": {
"description": "A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.",
"items": {
"$ref": "#/definitions/Coding"
},
"type": "array"
},
"when": {
"description": "When the digital signature was signed.",
"$ref": "#/definitions/instant"
},
"_when": {
"description": "Extensions for when",
"$ref": "#/definitions/Element"
},
"who": {
"description": "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).",
"$ref": "#/definitions/Reference"
},
"onBehalfOf": {
"description": "A reference to an application-usable description of the identity that is represented by the signature.",
"$ref": "#/definitions/Reference"
},
"targetFormat": {
"description": "A mime type that indicates the technical format of the target resources signed by the signature.",
"$ref": "#/definitions/code"
},
"_targetFormat": {
"description": "Extensions for targetFormat",
"$ref": "#/definitions/Element"
},
"sigFormat": {
"description": "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.",
"$ref": "#/definitions/code"
},
"_sigFormat": {
"description": "Extensions for sigFormat",
"$ref": "#/definitions/Element"
},
"data": {
"description": "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.",
"$ref": "#/definitions/base64Binary"
},
"_data": {
"description": "Extensions for data",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"HumanName": {
"description": "A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"use": {
"description": "Identifies the purpose for this name.",
"enum": [
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
]
},
"_use": {
"description": "Extensions for use",
"$ref": "#/definitions/Element"
},
"text": {
"description": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
},
"family": {
"description": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"$ref": "#/definitions/string"
},
"_family": {
"description": "Extensions for family",
"$ref": "#/definitions/Element"
},
"given": {
"description": "Given name.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_given": {
"description": "Extensions for given",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"prefix": {
"description": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_prefix": {
"description": "Extensions for prefix",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"suffix": {
"description": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_suffix": {
"description": "Extensions for suffix",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"period": {
"description": "Indicates the period of time when this name was valid for the named person.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false
},
"Address": {
"description": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.\nThe ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"use": {
"description": "The purpose of this address.",
"enum": [
"home",
"work",
"temp",
"old",
"billing"
]
},
"_use": {
"description": "Extensions for use",
"$ref": "#/definitions/Element"
},
"type": {
"description": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"enum": [
"postal",
"physical",
"both"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"text": {
"description": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
},
"line": {
"description": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_line": {
"description": "Extensions for line",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"city": {
"description": "The name of the city, town, suburb, village or other community or delivery center.",
"$ref": "#/definitions/string"
},
"_city": {
"description": "Extensions for city",
"$ref": "#/definitions/Element"
},
"district": {
"description": "The name of the administrative area (county).",
"$ref": "#/definitions/string"
},
"_district": {
"description": "Extensions for district",
"$ref": "#/definitions/Element"
},
"state": {
"description": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"$ref": "#/definitions/string"
},
"_state": {
"description": "Extensions for state",
"$ref": "#/definitions/Element"
},
"postalCode": {
"description": "A postal code designating a region defined by the postal service.",
"$ref": "#/definitions/string"
},
"_postalCode": {
"description": "Extensions for postalCode",
"$ref": "#/definitions/Element"
},
"country": {
"description": "Country - a nation as commonly understood or generally accepted.",
"$ref": "#/definitions/string"
},
"_country": {
"description": "Extensions for country",
"$ref": "#/definitions/Element"
},
"period": {
"description": "Time period when address was/is in use.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false
},
"ContactPoint": {
"description": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"system": {
"description": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"enum": [
"phone",
"fax",
"email",
"pager",
"url",
"sms",
"other"
]
},
"_system": {
"description": "Extensions for system",
"$ref": "#/definitions/Element"
},
"value": {
"description": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"use": {
"description": "Identifies the purpose for the contact point.",
"enum": [
"home",
"work",
"temp",
"old",
"mobile"
]
},
"_use": {
"description": "Extensions for use",
"$ref": "#/definitions/Element"
},
"rank": {
"description": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"$ref": "#/definitions/positiveInt"
},
"_rank": {
"description": "Extensions for rank",
"$ref": "#/definitions/Element"
},
"period": {
"description": "Time period when the contact point was/is in use.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false
},
"Timing": {
"description": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"event": {
"description": "Identifies specific times when the event occurs.",
"items": {
"$ref": "#/definitions/dateTime"
},
"type": "array"
},
"_event": {
"description": "Extensions for event",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"repeat": {
"description": "A set of rules that describe when the event is scheduled.",
"$ref": "#/definitions/Timing_Repeat"
},
"code": {
"description": "A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"Timing_Repeat": {
"description": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"boundsDuration": {
"description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.",
"$ref": "#/definitions/Duration"
},
"boundsRange": {
"description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.",
"$ref": "#/definitions/Range"
},
"boundsPeriod": {
"description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.",
"$ref": "#/definitions/Period"
},
"count": {
"description": "A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.",
"$ref": "#/definitions/positiveInt"
},
"_count": {
"description": "Extensions for count",
"$ref": "#/definitions/Element"
},
"countMax": {
"description": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.",
"$ref": "#/definitions/positiveInt"
},
"_countMax": {
"description": "Extensions for countMax",
"$ref": "#/definitions/Element"
},
"duration": {
"description": "How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.",
"$ref": "#/definitions/decimal"
},
"_duration": {
"description": "Extensions for duration",
"$ref": "#/definitions/Element"
},
"durationMax": {
"description": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.",
"$ref": "#/definitions/decimal"
},
"_durationMax": {
"description": "Extensions for durationMax",
"$ref": "#/definitions/Element"
},
"durationUnit": {
"description": "The units of time for the duration, in UCUM units\nNormal practice is to use the \u0027mo\u0027 code as a calendar month when calculating the next occurrence.",
"enum": [
"s",
"min",
"h",
"d",
"wk",
"mo",
"a"
]
},
"_durationUnit": {
"description": "Extensions for durationUnit",
"$ref": "#/definitions/Element"
},
"frequency": {
"description": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.",
"$ref": "#/definitions/positiveInt"
},
"_frequency": {
"description": "Extensions for frequency",
"$ref": "#/definitions/Element"
},
"frequencyMax": {
"description": "If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.",
"$ref": "#/definitions/positiveInt"
},
"_frequencyMax": {
"description": "Extensions for frequencyMax",
"$ref": "#/definitions/Element"
},
"period": {
"description": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.",
"$ref": "#/definitions/decimal"
},
"_period": {
"description": "Extensions for period",
"$ref": "#/definitions/Element"
},
"periodMax": {
"description": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3-5 days.",
"$ref": "#/definitions/decimal"
},
"_periodMax": {
"description": "Extensions for periodMax",
"$ref": "#/definitions/Element"
},
"periodUnit": {
"description": "The units of time for the period in UCUM units\nNormal practice is to use the \u0027mo\u0027 code as a calendar month when calculating the next occurrence.",
"enum": [
"s",
"min",
"h",
"d",
"wk",
"mo",
"a"
]
},
"_periodUnit": {
"description": "Extensions for periodUnit",
"$ref": "#/definitions/Element"
},
"dayOfWeek": {
"description": "If one or more days of week is provided, then the action happens only on the specified day(s).",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_dayOfWeek": {
"description": "Extensions for dayOfWeek",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"timeOfDay": {
"description": "Specified time of day for action to take place.",
"items": {
"$ref": "#/definitions/time"
},
"type": "array"
},
"_timeOfDay": {
"description": "Extensions for timeOfDay",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"when": {
"description": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.",
"items": {
"enum": [
"MORN",
"MORN.early",
"MORN.late",
"NOON",
"AFT",
"AFT.early",
"AFT.late",
"EVE",
"EVE.early",
"EVE.late",
"NIGHT",
"PHS",
"IMD",
"HS",
"WAKE",
"C",
"CM",
"CD",
"CV",
"AC",
"ACM",
"ACD",
"ACV",
"PC",
"PCM",
"PCD",
"PCV"
]
},
"type": "array"
},
"_when": {
"description": "Extensions for when",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"offset": {
"description": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.",
"$ref": "#/definitions/unsignedInt"
},
"_offset": {
"description": "Extensions for offset",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Meta": {
"description": "The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"versionId": {
"description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"$ref": "#/definitions/id"
},
"_versionId": {
"description": "Extensions for versionId",
"$ref": "#/definitions/Element"
},
"lastUpdated": {
"description": "When the resource last changed - e.g. when the version changed.",
"$ref": "#/definitions/instant"
},
"_lastUpdated": {
"description": "Extensions for lastUpdated",
"$ref": "#/definitions/Element"
},
"source": {
"description": "A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"$ref": "#/definitions/uri"
},
"_source": {
"description": "Extensions for source",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"security": {
"description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"items": {
"$ref": "#/definitions/Coding"
},
"type": "array"
},
"tag": {
"description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"items": {
"$ref": "#/definitions/Coding"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ContactDetail": {
"description": "Specifies contact information for a person or organization.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of an individual to contact.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"telecom": {
"description": "The contact details for the individual (if a name was provided) or the organization.",
"items": {
"$ref": "#/definitions/ContactPoint"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExtendedContactDetail": {
"description": "Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"purpose": {
"description": "The purpose/type of contact.",
"$ref": "#/definitions/CodeableConcept"
},
"name": {
"description": "The name of an individual to contact, some types of contact detail are usually blank.",
"items": {
"$ref": "#/definitions/HumanName"
},
"type": "array"
},
"telecom": {
"description": "The contact details application for the purpose defined.",
"items": {
"$ref": "#/definitions/ContactPoint"
},
"type": "array"
},
"address": {
"description": "Address for the contact.",
"$ref": "#/definitions/Address"
},
"organization": {
"description": "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.",
"$ref": "#/definitions/Reference"
},
"period": {
"description": "Period that this contact was valid for usage.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false
},
"VirtualServiceDetail": {
"description": "Virtual Service Contact Details.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"channelType": {
"description": "The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp).",
"$ref": "#/definitions/Coding"
},
"addressUrl": {
"description": "What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).",
"pattern": "^\\S*$",
"type": "string"
},
"_addressUrl": {
"description": "Extensions for addressUrl",
"$ref": "#/definitions/Element"
},
"addressString": {
"description": "What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_addressString": {
"description": "Extensions for addressString",
"$ref": "#/definitions/Element"
},
"addressContactPoint": {
"description": "What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).",
"$ref": "#/definitions/ContactPoint"
},
"addressExtendedContactDetail": {
"description": "What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).",
"$ref": "#/definitions/ExtendedContactDetail"
},
"additionalInfo": {
"description": "Address to see alternative connection details.",
"items": {
"$ref": "#/definitions/url"
},
"type": "array"
},
"_additionalInfo": {
"description": "Extensions for additionalInfo",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"maxParticipants": {
"description": "Maximum number of participants supported by the virtual service.",
"$ref": "#/definitions/positiveInt"
},
"_maxParticipants": {
"description": "Extensions for maxParticipants",
"$ref": "#/definitions/Element"
},
"sessionKey": {
"description": "Session Key required by the virtual service.",
"$ref": "#/definitions/string"
},
"_sessionKey": {
"description": "Extensions for sessionKey",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Availability": {
"description": "Availability data for an {item}.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"availableTime": {
"description": "Times the {item} is available.",
"items": {
"$ref": "#/definitions/Availability_AvailableTime"
},
"type": "array"
},
"notAvailableTime": {
"description": "Not available during this time due to provided reason.",
"items": {
"$ref": "#/definitions/Availability_NotAvailableTime"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Availability_AvailableTime": {
"description": "Availability data for an {item}.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"daysOfWeek": {
"description": "mon | tue | wed | thu | fri | sat | sun.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_daysOfWeek": {
"description": "Extensions for daysOfWeek",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"allDay": {
"description": "Always available? i.e. 24 hour service.",
"$ref": "#/definitions/boolean"
},
"_allDay": {
"description": "Extensions for allDay",
"$ref": "#/definitions/Element"
},
"availableStartTime": {
"description": "Opening time of day (ignored if allDay \u003d true).",
"$ref": "#/definitions/time"
},
"_availableStartTime": {
"description": "Extensions for availableStartTime",
"$ref": "#/definitions/Element"
},
"availableEndTime": {
"description": "Closing time of day (ignored if allDay \u003d true).",
"$ref": "#/definitions/time"
},
"_availableEndTime": {
"description": "Extensions for availableEndTime",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Availability_NotAvailableTime": {
"description": "Availability data for an {item}.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "Reason presented to the user explaining why time not available.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"during": {
"description": "Service not available during this period.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false
},
"MonetaryComponent": {
"description": "Availability data for an {item}.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "base | surcharge | deduction | discount | tax | informational.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"code": {
"description": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"$ref": "#/definitions/CodeableConcept"
},
"factor": {
"description": "Factor used for calculating this component.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "#/definitions/Element"
},
"amount": {
"description": "Explicit value amount to be used.",
"$ref": "#/definitions/Money"
}
},
"type": "object",
"additionalProperties": false
},
"Contributor": {
"description": "A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of contributor.",
"enum": [
"author",
"editor",
"reviewer",
"endorser"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"name": {
"description": "The name of the individual or organization responsible for the contribution.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the contributor.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DataRequirement": {
"description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "The profile of the required data, specified as the uri of the profile definition.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"subjectCodeableConcept": {
"description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.",
"$ref": "#/definitions/CodeableConcept"
},
"subjectReference": {
"description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.",
"$ref": "#/definitions/Reference"
},
"mustSupport": {
"description": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. \n\nThe value of mustSupport SHALL be a FHIRPath resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_mustSupport": {
"description": "Extensions for mustSupport",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"codeFilter": {
"description": "Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND\u0027ed, not OR\u0027ed.",
"items": {
"$ref": "#/definitions/DataRequirement_CodeFilter"
},
"type": "array"
},
"dateFilter": {
"description": "Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND\u0027ed, not OR\u0027ed.",
"items": {
"$ref": "#/definitions/DataRequirement_DateFilter"
},
"type": "array"
},
"valueFilter": {
"description": "Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND\u0027ed, not OR\u0027ed).",
"items": {
"$ref": "#/definitions/DataRequirement_ValueFilter"
},
"type": "array"
},
"limit": {
"description": "Specifies a maximum number of results that are required (uses the _count search parameter).",
"$ref": "#/definitions/positiveInt"
},
"_limit": {
"description": "Extensions for limit",
"$ref": "#/definitions/Element"
},
"sort": {
"description": "Specifies the order of the results to be returned.",
"items": {
"$ref": "#/definitions/DataRequirement_Sort"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DataRequirement_CodeFilter": {
"description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"searchParam": {
"description": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.",
"$ref": "#/definitions/string"
},
"_searchParam": {
"description": "Extensions for searchParam",
"$ref": "#/definitions/Element"
},
"valueSet": {
"description": "The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.",
"$ref": "#/definitions/canonical"
},
"code": {
"description": "The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.",
"items": {
"$ref": "#/definitions/Coding"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"DataRequirement_DateFilter": {
"description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"searchParam": {
"description": "A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.",
"$ref": "#/definitions/string"
},
"_searchParam": {
"description": "Extensions for searchParam",
"$ref": "#/definitions/Element"
},
"valueDateTime": {
"description": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "#/definitions/Element"
},
"valuePeriod": {
"description": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.",
"$ref": "#/definitions/Period"
},
"valueDuration": {
"description": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.",
"$ref": "#/definitions/Duration"
}
},
"type": "object",
"additionalProperties": false
},
"DataRequirement_ValueFilter": {
"description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"searchParam": {
"description": "A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.",
"$ref": "#/definitions/string"
},
"_searchParam": {
"description": "Extensions for searchParam",
"$ref": "#/definitions/Element"
},
"comparator": {
"description": "The comparator to be used to determine whether the value is matching.",
"$ref": "#/definitions/code"
},
"_comparator": {
"description": "Extensions for comparator",
"$ref": "#/definitions/Element"
},
"valueDateTime": {
"description": "The value of the filter.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "#/definitions/Element"
},
"valuePeriod": {
"description": "The value of the filter.",
"$ref": "#/definitions/Period"
},
"valueDuration": {
"description": "The value of the filter.",
"$ref": "#/definitions/Duration"
}
},
"type": "object",
"additionalProperties": false
},
"DataRequirement_Sort": {
"description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"direction": {
"description": "The direction of the sort, ascending or descending.",
"enum": [
"ascending",
"descending"
]
},
"_direction": {
"description": "Extensions for direction",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ParameterDefinition": {
"description": "The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of the parameter used to allow access to the value of the parameter in evaluation contexts.",
"$ref": "#/definitions/code"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"use": {
"description": "Whether the parameter is input or output for the module.",
"$ref": "#/definitions/code"
},
"_use": {
"description": "Extensions for use",
"$ref": "#/definitions/Element"
},
"min": {
"description": "The minimum number of times this parameter SHALL appear in the request or response.",
"$ref": "#/definitions/integer"
},
"_min": {
"description": "Extensions for min",
"$ref": "#/definitions/Element"
},
"max": {
"description": "The maximum number of times this element is permitted to appear in the request or response.",
"$ref": "#/definitions/string"
},
"_max": {
"description": "Extensions for max",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "A brief discussion of what the parameter is for and how it is used by the module.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"type": {
"description": "The type of the parameter.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.",
"$ref": "#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false
},
"RelatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of relationship to the related artifact.",
"enum": [
"documentation",
"justification",
"citation",
"predecessor",
"successor",
"derived-from",
"depends-on",
"composed-of",
"part-of",
"amends",
"amended-with",
"appends",
"appended-with",
"cites",
"cited-by",
"comments-on",
"comment-in",
"contains",
"contained-in",
"corrects",
"correction-in",
"replaces",
"replaced-with",
"retracts",
"retracted-by",
"signs",
"similar-to",
"supports",
"supported-with",
"transforms",
"transformed-into",
"transformed-with",
"documents",
"specification-of",
"created-with",
"cite-as"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"classifier": {
"description": "Provides additional classifiers of the related artifact.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"label": {
"description": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "#/definitions/Element"
},
"display": {
"description": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "#/definitions/Element"
},
"citation": {
"description": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"$ref": "#/definitions/markdown"
},
"_citation": {
"description": "Extensions for citation",
"$ref": "#/definitions/Element"
},
"document": {
"description": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
"$ref": "#/definitions/Attachment"
},
"resource": {
"description": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"$ref": "#/definitions/canonical"
},
"resourceReference": {
"description": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"$ref": "#/definitions/Reference"
},
"publicationStatus": {
"description": "The publication status of the artifact being referred to.",
"$ref": "#/definitions/code"
},
"_publicationStatus": {
"description": "Extensions for publicationStatus",
"$ref": "#/definitions/Element"
},
"publicationDate": {
"description": "The date of publication of the artifact being referred to.",
"$ref": "#/definitions/date"
},
"_publicationDate": {
"description": "Extensions for publicationDate",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TriggerDefinition": {
"description": "A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of triggering event.",
"enum": [
"named-event",
"periodic",
"data-changed",
"data-added",
"data-modified",
"data-removed",
"data-accessed",
"data-access-ended"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"name": {
"description": "A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A code that identifies the event.",
"$ref": "#/definitions/CodeableConcept"
},
"subscriptionTopic": {
"description": "A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.",
"$ref": "#/definitions/canonical"
},
"timingTiming": {
"description": "The timing of the event (if this is a periodic trigger).",
"$ref": "#/definitions/Timing"
},
"timingReference": {
"description": "The timing of the event (if this is a periodic trigger).",
"$ref": "#/definitions/Reference"
},
"timingDate": {
"description": "The timing of the event (if this is a periodic trigger).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_timingDate": {
"description": "Extensions for timingDate",
"$ref": "#/definitions/Element"
},
"timingDateTime": {
"description": "The timing of the event (if this is a periodic trigger).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_timingDateTime": {
"description": "Extensions for timingDateTime",
"$ref": "#/definitions/Element"
},
"data": {
"description": "The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.",
"items": {
"$ref": "#/definitions/DataRequirement"
},
"type": "array"
},
"condition": {
"description": "A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.",
"$ref": "#/definitions/Expression"
}
},
"type": "object",
"additionalProperties": false
},
"UsageContext": {
"description": "Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A code that identifies the type of context being specified by this usage context.",
"$ref": "#/definitions/Coding"
},
"valueCodeableConcept": {
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.",
"$ref": "#/definitions/CodeableConcept"
},
"valueQuantity": {
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.",
"$ref": "#/definitions/Quantity"
},
"valueRange": {
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.",
"$ref": "#/definitions/Range"
},
"valueReference": {
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"Dosage": {
"description": "Indicates how the medication is/was taken or should be taken by the patient.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "Indicates the order in which the dosage instructions should be applied or interpreted.",
"$ref": "#/definitions/integer"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "#/definitions/Element"
},
"text": {
"description": "Free text dosage instructions e.g. SIG.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
},
"additionalInstruction": {
"description": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\").",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"patientInstruction": {
"description": "Instructions in terms that are understood by the patient or consumer.",
"$ref": "#/definitions/string"
},
"_patientInstruction": {
"description": "Extensions for patientInstruction",
"$ref": "#/definitions/Element"
},
"timing": {
"description": "When medication should be administered.",
"$ref": "#/definitions/Timing"
},
"asNeeded": {
"description": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).",
"$ref": "#/definitions/boolean"
},
"_asNeeded": {
"description": "Extensions for asNeeded",
"$ref": "#/definitions/Element"
},
"asNeededFor": {
"description": "Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"site": {
"description": "Body site to administer to.",
"$ref": "#/definitions/CodeableConcept"
},
"route": {
"description": "How drug should enter body.",
"$ref": "#/definitions/CodeableConcept"
},
"method": {
"description": "Technique for administering medication.",
"$ref": "#/definitions/CodeableConcept"
},
"doseAndRate": {
"description": "Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.",
"items": {
"$ref": "#/definitions/Dosage_DoseAndRate"
},
"type": "array"
},
"maxDosePerPeriod": {
"description": "Upper limit on medication per unit of time.",
"items": {
"$ref": "#/definitions/Ratio"
},
"type": "array"
},
"maxDosePerAdministration": {
"description": "Upper limit on medication per administration.",
"$ref": "#/definitions/Quantity"
},
"maxDosePerLifetime": {
"description": "Upper limit on medication per lifetime of the patient.",
"$ref": "#/definitions/Quantity"
}
},
"type": "object",
"additionalProperties": false
},
"Dosage_DoseAndRate": {
"description": "Indicates how the medication is/was taken or should be taken by the patient.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The kind of dose or rate specified, for example, ordered or calculated.",
"$ref": "#/definitions/CodeableConcept"
},
"doseRange": {
"description": "Amount of medication per dose.",
"$ref": "#/definitions/Range"
},
"doseQuantity": {
"description": "Amount of medication per dose.",
"$ref": "#/definitions/Quantity"
},
"rateRatio": {
"description": "Amount of medication per unit of time.",
"$ref": "#/definitions/Ratio"
},
"rateRange": {
"description": "Amount of medication per unit of time.",
"$ref": "#/definitions/Range"
},
"rateQuantity": {
"description": "Amount of medication per unit of time.",
"$ref": "#/definitions/Quantity"
}
},
"type": "object",
"additionalProperties": false
},
"ProductShelfLife": {
"description": "The shelf-life and storage information for a medicinal product item or container can be described using this class.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.",
"$ref": "#/definitions/CodeableConcept"
},
"periodDuration": {
"description": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.",
"$ref": "#/definitions/Duration"
},
"periodString": {
"description": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_periodString": {
"description": "Extensions for periodString",
"$ref": "#/definitions/Element"
},
"specialPrecautionsForStorage": {
"description": "Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"MarketingStatus": {
"description": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"country": {
"description": "The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements.",
"$ref": "#/definitions/CodeableConcept"
},
"jurisdiction": {
"description": "Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.",
"$ref": "#/definitions/CodeableConcept"
},
"status": {
"description": "This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.",
"$ref": "#/definitions/CodeableConcept"
},
"dateRange": {
"description": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.",
"$ref": "#/definitions/Period"
},
"restoreDate": {
"description": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.",
"$ref": "#/definitions/dateTime"
},
"_restoreDate": {
"description": "Extensions for restoreDate",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"status"
]
},
"Expression": {
"description": "A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"name": {
"description": "A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.",
"$ref": "#/definitions/code"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The media type of the language for the expression.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"expression": {
"description": "An expression in the specified language that returns a value.",
"$ref": "#/definitions/string"
},
"_expression": {
"description": "Extensions for expression",
"$ref": "#/definitions/Element"
},
"reference": {
"description": "A URI that defines where the expression is found.",
"$ref": "#/definitions/uri"
},
"_reference": {
"description": "Extensions for reference",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource or extension.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"representation": {
"description": "Codes that define how this element is represented in instances, when the deviation varies from the normal case. No extensions are allowed on elements with a representation of \u0027xmlAttr\u0027, no matter what FHIR serialization format is used.",
"items": {
"enum": [
"xmlAttr",
"xmlText",
"typeAttr",
"cdaText",
"xhtml"
]
},
"type": "array"
},
"_representation": {
"description": "Extensions for representation",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"sliceName": {
"description": "The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.",
"$ref": "#/definitions/string"
},
"_sliceName": {
"description": "Extensions for sliceName",
"$ref": "#/definitions/Element"
},
"sliceIsConstraining": {
"description": "If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.",
"$ref": "#/definitions/boolean"
},
"_sliceIsConstraining": {
"description": "Extensions for sliceIsConstraining",
"$ref": "#/definitions/Element"
},
"label": {
"description": "A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "#/definitions/Element"
},
"code": {
"description": "A code that has the same meaning as the element in a particular terminology.",
"items": {
"$ref": "#/definitions/Coding"
},
"type": "array"
},
"slicing": {
"description": "Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).",
"$ref": "#/definitions/ElementDefinition_Slicing"
},
"short": {
"description": "A concise description of what this element means (e.g. for use in autogenerated summaries).",
"$ref": "#/definitions/string"
},
"_short": {
"description": "Extensions for short",
"$ref": "#/definitions/Element"
},
"definition": {
"description": "Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).",
"$ref": "#/definitions/markdown"
},
"_definition": {
"description": "Extensions for definition",
"$ref": "#/definitions/Element"
},
"comment": {
"description": "Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).",
"$ref": "#/definitions/markdown"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "#/definitions/Element"
},
"requirements": {
"description": "This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.",
"$ref": "#/definitions/markdown"
},
"_requirements": {
"description": "Extensions for requirements",
"$ref": "#/definitions/Element"
},
"alias": {
"description": "Identifies additional names by which this element might also be known.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_alias": {
"description": "Extensions for alias",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"min": {
"description": "The minimum number of times this element SHALL appear in the instance.",
"$ref": "#/definitions/unsignedInt"
},
"_min": {
"description": "Extensions for min",
"$ref": "#/definitions/Element"
},
"max": {
"description": "The maximum number of times this element is permitted to appear in the instance.",
"$ref": "#/definitions/string"
},
"_max": {
"description": "Extensions for max",
"$ref": "#/definitions/Element"
},
"base": {
"description": "Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.",
"$ref": "#/definitions/ElementDefinition_Base"
},
"contentReference": {
"description": "Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.",
"$ref": "#/definitions/uri"
},
"_contentReference": {
"description": "Extensions for contentReference",
"$ref": "#/definitions/Element"
},
"type": {
"description": "The data type or resource that the value of this element is permitted to be.",
"items": {
"$ref": "#/definitions/ElementDefinition_Type"
},
"type": "array"
},
"defaultValueBase64Binary": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
"type": "string"
},
"_defaultValueBase64Binary": {
"description": "Extensions for defaultValueBase64Binary",
"$ref": "#/definitions/Element"
},
"defaultValueBoolean": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^true|false$",
"type": "boolean"
},
"_defaultValueBoolean": {
"description": "Extensions for defaultValueBoolean",
"$ref": "#/definitions/Element"
},
"defaultValueCanonical": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^\\S*$",
"type": "string"
},
"_defaultValueCanonical": {
"description": "Extensions for defaultValueCanonical",
"$ref": "#/definitions/Element"
},
"defaultValueCode": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_defaultValueCode": {
"description": "Extensions for defaultValueCode",
"$ref": "#/definitions/Element"
},
"defaultValueDate": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_defaultValueDate": {
"description": "Extensions for defaultValueDate",
"$ref": "#/definitions/Element"
},
"defaultValueDateTime": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_defaultValueDateTime": {
"description": "Extensions for defaultValueDateTime",
"$ref": "#/definitions/Element"
},
"defaultValueDecimal": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_defaultValueDecimal": {
"description": "Extensions for defaultValueDecimal",
"$ref": "#/definitions/Element"
},
"defaultValueId": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_defaultValueId": {
"description": "Extensions for defaultValueId",
"$ref": "#/definitions/Element"
},
"defaultValueInstant": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_defaultValueInstant": {
"description": "Extensions for defaultValueInstant",
"$ref": "#/definitions/Element"
},
"defaultValueInteger": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_defaultValueInteger": {
"description": "Extensions for defaultValueInteger",
"$ref": "#/definitions/Element"
},
"defaultValueInteger64": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_defaultValueInteger64": {
"description": "Extensions for defaultValueInteger64",
"$ref": "#/definitions/Element"
},
"defaultValueMarkdown": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_defaultValueMarkdown": {
"description": "Extensions for defaultValueMarkdown",
"$ref": "#/definitions/Element"
},
"defaultValueOid": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string"
},
"_defaultValueOid": {
"description": "Extensions for defaultValueOid",
"$ref": "#/definitions/Element"
},
"defaultValuePositiveInt": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_defaultValuePositiveInt": {
"description": "Extensions for defaultValuePositiveInt",
"$ref": "#/definitions/Element"
},
"defaultValueString": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_defaultValueString": {
"description": "Extensions for defaultValueString",
"$ref": "#/definitions/Element"
},
"defaultValueTime": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_defaultValueTime": {
"description": "Extensions for defaultValueTime",
"$ref": "#/definitions/Element"
},
"defaultValueUnsignedInt": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_defaultValueUnsignedInt": {
"description": "Extensions for defaultValueUnsignedInt",
"$ref": "#/definitions/Element"
},
"defaultValueUri": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^\\S*$",
"type": "string"
},
"_defaultValueUri": {
"description": "Extensions for defaultValueUri",
"$ref": "#/definitions/Element"
},
"defaultValueUrl": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^\\S*$",
"type": "string"
},
"_defaultValueUrl": {
"description": "Extensions for defaultValueUrl",
"$ref": "#/definitions/Element"
},
"defaultValueUuid": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
"_defaultValueUuid": {
"description": "Extensions for defaultValueUuid",
"$ref": "#/definitions/Element"
},
"defaultValueAddress": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Address"
},
"defaultValueAge": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Age"
},
"defaultValueAnnotation": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Annotation"
},
"defaultValueAttachment": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Attachment"
},
"defaultValueCodeableConcept": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/CodeableConcept"
},
"defaultValueCodeableReference": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/CodeableReference"
},
"defaultValueCoding": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Coding"
},
"defaultValueContactPoint": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/ContactPoint"
},
"defaultValueCount": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Count"
},
"defaultValueDistance": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Distance"
},
"defaultValueDuration": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Duration"
},
"defaultValueHumanName": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/HumanName"
},
"defaultValueIdentifier": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Identifier"
},
"defaultValueMoney": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Money"
},
"defaultValuePeriod": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Period"
},
"defaultValueQuantity": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Quantity"
},
"defaultValueRange": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Range"
},
"defaultValueRatio": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Ratio"
},
"defaultValueRatioRange": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/RatioRange"
},
"defaultValueReference": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Reference"
},
"defaultValueSampledData": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/SampledData"
},
"defaultValueSignature": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Signature"
},
"defaultValueTiming": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Timing"
},
"defaultValueContactDetail": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/ContactDetail"
},
"defaultValueDataRequirement": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/DataRequirement"
},
"defaultValueExpression": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Expression"
},
"defaultValueParameterDefinition": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/ParameterDefinition"
},
"defaultValueRelatedArtifact": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/RelatedArtifact"
},
"defaultValueTriggerDefinition": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/TriggerDefinition"
},
"defaultValueUsageContext": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/UsageContext"
},
"defaultValueAvailability": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Availability"
},
"defaultValueExtendedContactDetail": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/ExtendedContactDetail"
},
"defaultValueDosage": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Dosage"
},
"defaultValueMeta": {
"description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).",
"$ref": "#/definitions/Meta"
},
"meaningWhenMissing": {
"description": "The Implicit meaning that is to be understood when this element is missing (e.g. \u0027when this element is missing, the period is ongoing\u0027).",
"$ref": "#/definitions/markdown"
},
"_meaningWhenMissing": {
"description": "Extensions for meaningWhenMissing",
"$ref": "#/definitions/Element"
},
"orderMeaning": {
"description": "If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.",
"$ref": "#/definitions/string"
},
"_orderMeaning": {
"description": "Extensions for orderMeaning",
"$ref": "#/definitions/Element"
},
"fixedBase64Binary": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
"type": "string"
},
"_fixedBase64Binary": {
"description": "Extensions for fixedBase64Binary",
"$ref": "#/definitions/Element"
},
"fixedBoolean": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^true|false$",
"type": "boolean"
},
"_fixedBoolean": {
"description": "Extensions for fixedBoolean",
"$ref": "#/definitions/Element"
},
"fixedCanonical": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^\\S*$",
"type": "string"
},
"_fixedCanonical": {
"description": "Extensions for fixedCanonical",
"$ref": "#/definitions/Element"
},
"fixedCode": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_fixedCode": {
"description": "Extensions for fixedCode",
"$ref": "#/definitions/Element"
},
"fixedDate": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_fixedDate": {
"description": "Extensions for fixedDate",
"$ref": "#/definitions/Element"
},
"fixedDateTime": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_fixedDateTime": {
"description": "Extensions for fixedDateTime",
"$ref": "#/definitions/Element"
},
"fixedDecimal": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_fixedDecimal": {
"description": "Extensions for fixedDecimal",
"$ref": "#/definitions/Element"
},
"fixedId": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_fixedId": {
"description": "Extensions for fixedId",
"$ref": "#/definitions/Element"
},
"fixedInstant": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_fixedInstant": {
"description": "Extensions for fixedInstant",
"$ref": "#/definitions/Element"
},
"fixedInteger": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_fixedInteger": {
"description": "Extensions for fixedInteger",
"$ref": "#/definitions/Element"
},
"fixedInteger64": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_fixedInteger64": {
"description": "Extensions for fixedInteger64",
"$ref": "#/definitions/Element"
},
"fixedMarkdown": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_fixedMarkdown": {
"description": "Extensions for fixedMarkdown",
"$ref": "#/definitions/Element"
},
"fixedOid": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string"
},
"_fixedOid": {
"description": "Extensions for fixedOid",
"$ref": "#/definitions/Element"
},
"fixedPositiveInt": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_fixedPositiveInt": {
"description": "Extensions for fixedPositiveInt",
"$ref": "#/definitions/Element"
},
"fixedString": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_fixedString": {
"description": "Extensions for fixedString",
"$ref": "#/definitions/Element"
},
"fixedTime": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_fixedTime": {
"description": "Extensions for fixedTime",
"$ref": "#/definitions/Element"
},
"fixedUnsignedInt": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_fixedUnsignedInt": {
"description": "Extensions for fixedUnsignedInt",
"$ref": "#/definitions/Element"
},
"fixedUri": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^\\S*$",
"type": "string"
},
"_fixedUri": {
"description": "Extensions for fixedUri",
"$ref": "#/definitions/Element"
},
"fixedUrl": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^\\S*$",
"type": "string"
},
"_fixedUrl": {
"description": "Extensions for fixedUrl",
"$ref": "#/definitions/Element"
},
"fixedUuid": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
"_fixedUuid": {
"description": "Extensions for fixedUuid",
"$ref": "#/definitions/Element"
},
"fixedAddress": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Address"
},
"fixedAge": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Age"
},
"fixedAnnotation": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Annotation"
},
"fixedAttachment": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Attachment"
},
"fixedCodeableConcept": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/CodeableConcept"
},
"fixedCodeableReference": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/CodeableReference"
},
"fixedCoding": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Coding"
},
"fixedContactPoint": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/ContactPoint"
},
"fixedCount": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Count"
},
"fixedDistance": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Distance"
},
"fixedDuration": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Duration"
},
"fixedHumanName": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/HumanName"
},
"fixedIdentifier": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Identifier"
},
"fixedMoney": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Money"
},
"fixedPeriod": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Period"
},
"fixedQuantity": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Quantity"
},
"fixedRange": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Range"
},
"fixedRatio": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Ratio"
},
"fixedRatioRange": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/RatioRange"
},
"fixedReference": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Reference"
},
"fixedSampledData": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/SampledData"
},
"fixedSignature": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Signature"
},
"fixedTiming": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Timing"
},
"fixedContactDetail": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/ContactDetail"
},
"fixedDataRequirement": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/DataRequirement"
},
"fixedExpression": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Expression"
},
"fixedParameterDefinition": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/ParameterDefinition"
},
"fixedRelatedArtifact": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/RelatedArtifact"
},
"fixedTriggerDefinition": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/TriggerDefinition"
},
"fixedUsageContext": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/UsageContext"
},
"fixedAvailability": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Availability"
},
"fixedExtendedContactDetail": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/ExtendedContactDetail"
},
"fixedDosage": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Dosage"
},
"fixedMeta": {
"description": "Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"$ref": "#/definitions/Meta"
},
"patternBase64Binary": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
"type": "string"
},
"_patternBase64Binary": {
"description": "Extensions for patternBase64Binary",
"$ref": "#/definitions/Element"
},
"patternBoolean": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^true|false$",
"type": "boolean"
},
"_patternBoolean": {
"description": "Extensions for patternBoolean",
"$ref": "#/definitions/Element"
},
"patternCanonical": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^\\S*$",
"type": "string"
},
"_patternCanonical": {
"description": "Extensions for patternCanonical",
"$ref": "#/definitions/Element"
},
"patternCode": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_patternCode": {
"description": "Extensions for patternCode",
"$ref": "#/definitions/Element"
},
"patternDate": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_patternDate": {
"description": "Extensions for patternDate",
"$ref": "#/definitions/Element"
},
"patternDateTime": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_patternDateTime": {
"description": "Extensions for patternDateTime",
"$ref": "#/definitions/Element"
},
"patternDecimal": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_patternDecimal": {
"description": "Extensions for patternDecimal",
"$ref": "#/definitions/Element"
},
"patternId": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_patternId": {
"description": "Extensions for patternId",
"$ref": "#/definitions/Element"
},
"patternInstant": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_patternInstant": {
"description": "Extensions for patternInstant",
"$ref": "#/definitions/Element"
},
"patternInteger": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_patternInteger": {
"description": "Extensions for patternInteger",
"$ref": "#/definitions/Element"
},
"patternInteger64": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_patternInteger64": {
"description": "Extensions for patternInteger64",
"$ref": "#/definitions/Element"
},
"patternMarkdown": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_patternMarkdown": {
"description": "Extensions for patternMarkdown",
"$ref": "#/definitions/Element"
},
"patternOid": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string"
},
"_patternOid": {
"description": "Extensions for patternOid",
"$ref": "#/definitions/Element"
},
"patternPositiveInt": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_patternPositiveInt": {
"description": "Extensions for patternPositiveInt",
"$ref": "#/definitions/Element"
},
"patternString": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_patternString": {
"description": "Extensions for patternString",
"$ref": "#/definitions/Element"
},
"patternTime": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_patternTime": {
"description": "Extensions for patternTime",
"$ref": "#/definitions/Element"
},
"patternUnsignedInt": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_patternUnsignedInt": {
"description": "Extensions for patternUnsignedInt",
"$ref": "#/definitions/Element"
},
"patternUri": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^\\S*$",
"type": "string"
},
"_patternUri": {
"description": "Extensions for patternUri",
"$ref": "#/definitions/Element"
},
"patternUrl": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^\\S*$",
"type": "string"
},
"_patternUrl": {
"description": "Extensions for patternUrl",
"$ref": "#/definitions/Element"
},
"patternUuid": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
"_patternUuid": {
"description": "Extensions for patternUuid",
"$ref": "#/definitions/Element"
},
"patternAddress": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Address"
},
"patternAge": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Age"
},
"patternAnnotation": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Annotation"
},
"patternAttachment": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Attachment"
},
"patternCodeableConcept": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/CodeableConcept"
},
"patternCodeableReference": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/CodeableReference"
},
"patternCoding": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Coding"
},
"patternContactPoint": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/ContactPoint"
},
"patternCount": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Count"
},
"patternDistance": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Distance"
},
"patternDuration": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Duration"
},
"patternHumanName": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/HumanName"
},
"patternIdentifier": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Identifier"
},
"patternMoney": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Money"
},
"patternPeriod": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Period"
},
"patternQuantity": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Quantity"
},
"patternRange": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Range"
},
"patternRatio": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Ratio"
},
"patternRatioRange": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/RatioRange"
},
"patternReference": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Reference"
},
"patternSampledData": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/SampledData"
},
"patternSignature": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Signature"
},
"patternTiming": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Timing"
},
"patternContactDetail": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/ContactDetail"
},
"patternDataRequirement": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/DataRequirement"
},
"patternExpression": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Expression"
},
"patternParameterDefinition": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/ParameterDefinition"
},
"patternRelatedArtifact": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/RelatedArtifact"
},
"patternTriggerDefinition": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/TriggerDefinition"
},
"patternUsageContext": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/UsageContext"
},
"patternAvailability": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Availability"
},
"patternExtendedContactDetail": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/ExtendedContactDetail"
},
"patternDosage": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Dosage"
},
"patternMeta": {
"description": "Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"$ref": "#/definitions/Meta"
},
"example": {
"description": "A sample value for this element demonstrating the type of information that would typically be found in the element.",
"items": {
"$ref": "#/definitions/ElementDefinition_Example"
},
"type": "array"
},
"minValueDate": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_minValueDate": {
"description": "Extensions for minValueDate",
"$ref": "#/definitions/Element"
},
"minValueDateTime": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_minValueDateTime": {
"description": "Extensions for minValueDateTime",
"$ref": "#/definitions/Element"
},
"minValueInstant": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_minValueInstant": {
"description": "Extensions for minValueInstant",
"$ref": "#/definitions/Element"
},
"minValueTime": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_minValueTime": {
"description": "Extensions for minValueTime",
"$ref": "#/definitions/Element"
},
"minValueDecimal": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_minValueDecimal": {
"description": "Extensions for minValueDecimal",
"$ref": "#/definitions/Element"
},
"minValueInteger": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_minValueInteger": {
"description": "Extensions for minValueInteger",
"$ref": "#/definitions/Element"
},
"minValueInteger64": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_minValueInteger64": {
"description": "Extensions for minValueInteger64",
"$ref": "#/definitions/Element"
},
"minValuePositiveInt": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_minValuePositiveInt": {
"description": "Extensions for minValuePositiveInt",
"$ref": "#/definitions/Element"
},
"minValueUnsignedInt": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_minValueUnsignedInt": {
"description": "Extensions for minValueUnsignedInt",
"$ref": "#/definitions/Element"
},
"minValueQuantity": {
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"$ref": "#/definitions/Quantity"
},
"maxValueDate": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_maxValueDate": {
"description": "Extensions for maxValueDate",
"$ref": "#/definitions/Element"
},
"maxValueDateTime": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_maxValueDateTime": {
"description": "Extensions for maxValueDateTime",
"$ref": "#/definitions/Element"
},
"maxValueInstant": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_maxValueInstant": {
"description": "Extensions for maxValueInstant",
"$ref": "#/definitions/Element"
},
"maxValueTime": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_maxValueTime": {
"description": "Extensions for maxValueTime",
"$ref": "#/definitions/Element"
},
"maxValueDecimal": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_maxValueDecimal": {
"description": "Extensions for maxValueDecimal",
"$ref": "#/definitions/Element"
},
"maxValueInteger": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_maxValueInteger": {
"description": "Extensions for maxValueInteger",
"$ref": "#/definitions/Element"
},
"maxValueInteger64": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_maxValueInteger64": {
"description": "Extensions for maxValueInteger64",
"$ref": "#/definitions/Element"
},
"maxValuePositiveInt": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_maxValuePositiveInt": {
"description": "Extensions for maxValuePositiveInt",
"$ref": "#/definitions/Element"
},
"maxValueUnsignedInt": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_maxValueUnsignedInt": {
"description": "Extensions for maxValueUnsignedInt",
"$ref": "#/definitions/Element"
},
"maxValueQuantity": {
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"$ref": "#/definitions/Quantity"
},
"maxLength": {
"description": "Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element. ```maxLength``` SHOULD only be used on primitive data types that have a string representation (see [[[http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics]]]).",
"$ref": "#/definitions/integer"
},
"_maxLength": {
"description": "Extensions for maxLength",
"$ref": "#/definitions/Element"
},
"condition": {
"description": "A reference to an invariant that may make additional statements about the cardinality or value in the instance.",
"items": {
"$ref": "#/definitions/id"
},
"type": "array"
},
"_condition": {
"description": "Extensions for condition",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"constraint": {
"description": "Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.",
"items": {
"$ref": "#/definitions/ElementDefinition_Constraint"
},
"type": "array"
},
"mustHaveValue": {
"description": "Specifies for a primitive data type that the value of the data type cannot be replaced by an extension.",
"$ref": "#/definitions/boolean"
},
"_mustHaveValue": {
"description": "Extensions for mustHaveValue",
"$ref": "#/definitions/Element"
},
"valueAlternatives": {
"description": "Specifies a list of extensions that can appear in place of a primitive value.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"mustSupport": {
"description": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. Note that this is being phased out and replaced by obligations (see below). If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.",
"$ref": "#/definitions/boolean"
},
"_mustSupport": {
"description": "Extensions for mustSupport",
"$ref": "#/definitions/Element"
},
"isModifier": {
"description": "If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system. When used on the root element in an extension definition, this indicates whether or not the extension is a modifier extension.",
"$ref": "#/definitions/boolean"
},
"_isModifier": {
"description": "Extensions for isModifier",
"$ref": "#/definitions/Element"
},
"isModifierReason": {
"description": "Explains how that element affects the interpretation of the resource or element that contains it.",
"$ref": "#/definitions/string"
},
"_isModifierReason": {
"description": "Extensions for isModifierReason",
"$ref": "#/definitions/Element"
},
"isSummary": {
"description": "Whether the element should be included if a client requests a search with the parameter _summary\u003dtrue.",
"$ref": "#/definitions/boolean"
},
"_isSummary": {
"description": "Extensions for isSummary",
"$ref": "#/definitions/Element"
},
"binding": {
"description": "Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).",
"$ref": "#/definitions/ElementDefinition_Binding"
},
"mapping": {
"description": "Identifies a concept from an external specification that roughly corresponds to this element.",
"items": {
"$ref": "#/definitions/ElementDefinition_Mapping"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Slicing": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"discriminator": {
"description": "Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.",
"items": {
"$ref": "#/definitions/ElementDefinition_Discriminator"
},
"type": "array"
},
"description": {
"description": "A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"ordered": {
"description": "If the matching elements have to occur in the same order as defined in the profile.",
"$ref": "#/definitions/boolean"
},
"_ordered": {
"description": "Extensions for ordered",
"$ref": "#/definitions/Element"
},
"rules": {
"description": "Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.",
"enum": [
"closed",
"open",
"openAtEnd"
]
},
"_rules": {
"description": "Extensions for rules",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Discriminator": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "How the element value is interpreted when discrimination is evaluated.",
"enum": [
"value",
"exists",
"pattern",
"type",
"profile",
"position"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"path": {
"description": "A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Base": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"min": {
"description": "Minimum cardinality of the base element identified by the path.",
"$ref": "#/definitions/unsignedInt"
},
"_min": {
"description": "Extensions for min",
"$ref": "#/definitions/Element"
},
"max": {
"description": "Maximum cardinality of the base element identified by the path.",
"$ref": "#/definitions/string"
},
"_max": {
"description": "Extensions for max",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Type": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.",
"$ref": "#/definitions/uri"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"targetProfile": {
"description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"aggregation": {
"description": "If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.",
"items": {
"enum": [
"contained",
"referenced",
"bundled"
]
},
"type": "array"
},
"_aggregation": {
"description": "Extensions for aggregation",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"versioning": {
"description": "Whether this reference needs to be version specific or version independent, or whether either can be used.",
"enum": [
"either",
"independent",
"specific"
]
},
"_versioning": {
"description": "Extensions for versioning",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Example": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"label": {
"description": "Describes the purpose of this example among the set of examples.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "#/definitions/Element"
},
"valueBase64Binary": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
"type": "string"
},
"_valueBase64Binary": {
"description": "Extensions for valueBase64Binary",
"$ref": "#/definitions/Element"
},
"valueBoolean": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "#/definitions/Element"
},
"valueCanonical": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueCanonical": {
"description": "Extensions for valueCanonical",
"$ref": "#/definitions/Element"
},
"valueCode": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "#/definitions/Element"
},
"valueDate": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_valueDate": {
"description": "Extensions for valueDate",
"$ref": "#/definitions/Element"
},
"valueDateTime": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "#/definitions/Element"
},
"valueDecimal": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "#/definitions/Element"
},
"valueId": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_valueId": {
"description": "Extensions for valueId",
"$ref": "#/definitions/Element"
},
"valueInstant": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_valueInstant": {
"description": "Extensions for valueInstant",
"$ref": "#/definitions/Element"
},
"valueInteger": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "#/definitions/Element"
},
"valueInteger64": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "string"
},
"_valueInteger64": {
"description": "Extensions for valueInteger64",
"$ref": "#/definitions/Element"
},
"valueMarkdown": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueMarkdown": {
"description": "Extensions for valueMarkdown",
"$ref": "#/definitions/Element"
},
"valueOid": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string"
},
"_valueOid": {
"description": "Extensions for valueOid",
"$ref": "#/definitions/Element"
},
"valuePositiveInt": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_valuePositiveInt": {
"description": "Extensions for valuePositiveInt",
"$ref": "#/definitions/Element"
},
"valueString": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "#/definitions/Element"
},
"valueTime": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "#/definitions/Element"
},
"valueUnsignedInt": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_valueUnsignedInt": {
"description": "Extensions for valueUnsignedInt",
"$ref": "#/definitions/Element"
},
"valueUri": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "#/definitions/Element"
},
"valueUrl": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUrl": {
"description": "Extensions for valueUrl",
"$ref": "#/definitions/Element"
},
"valueUuid": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
"_valueUuid": {
"description": "Extensions for valueUuid",
"$ref": "#/definitions/Element"
},
"valueAddress": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Address"
},
"valueAge": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Age"
},
"valueAnnotation": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Annotation"
},
"valueAttachment": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Attachment"
},
"valueCodeableConcept": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/CodeableConcept"
},
"valueCodeableReference": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/CodeableReference"
},
"valueCoding": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Coding"
},
"valueContactPoint": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/ContactPoint"
},
"valueCount": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Count"
},
"valueDistance": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Distance"
},
"valueDuration": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Duration"
},
"valueHumanName": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/HumanName"
},
"valueIdentifier": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Identifier"
},
"valueMoney": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Money"
},
"valuePeriod": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Period"
},
"valueQuantity": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Quantity"
},
"valueRange": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Range"
},
"valueRatio": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Ratio"
},
"valueRatioRange": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/RatioRange"
},
"valueReference": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Reference"
},
"valueSampledData": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/SampledData"
},
"valueSignature": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Signature"
},
"valueTiming": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Timing"
},
"valueContactDetail": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/ContactDetail"
},
"valueDataRequirement": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/DataRequirement"
},
"valueExpression": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Expression"
},
"valueParameterDefinition": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/ParameterDefinition"
},
"valueRelatedArtifact": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/RelatedArtifact"
},
"valueTriggerDefinition": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/TriggerDefinition"
},
"valueUsageContext": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/UsageContext"
},
"valueAvailability": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Availability"
},
"valueExtendedContactDetail": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/ExtendedContactDetail"
},
"valueDosage": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Dosage"
},
"valueMeta": {
"description": "The actual value for the element, which must be one of the types allowed for this element.",
"$ref": "#/definitions/Meta"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Constraint": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"key": {
"description": "Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.",
"$ref": "#/definitions/id"
},
"_key": {
"description": "Extensions for key",
"$ref": "#/definitions/Element"
},
"requirements": {
"description": "Description of why this constraint is necessary or appropriate.",
"$ref": "#/definitions/markdown"
},
"_requirements": {
"description": "Extensions for requirements",
"$ref": "#/definitions/Element"
},
"severity": {
"description": "Identifies the impact constraint violation has on the conformance of the instance.",
"enum": [
"error",
"warning"
]
},
"_severity": {
"description": "Extensions for severity",
"$ref": "#/definitions/Element"
},
"suppress": {
"description": "If true, indicates that the warning or best practice guideline should be suppressed.",
"$ref": "#/definitions/boolean"
},
"_suppress": {
"description": "Extensions for suppress",
"$ref": "#/definitions/Element"
},
"human": {
"description": "Text that can be used to describe the constraint in messages identifying that the constraint has been violated.",
"$ref": "#/definitions/string"
},
"_human": {
"description": "Extensions for human",
"$ref": "#/definitions/Element"
},
"expression": {
"description": "A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.",
"$ref": "#/definitions/string"
},
"_expression": {
"description": "Extensions for expression",
"$ref": "#/definitions/Element"
},
"source": {
"description": "A reference to the original source of the constraint, for traceability purposes.",
"$ref": "#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Binding": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"strength": {
"description": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.",
"enum": [
"required",
"extensible",
"preferred",
"example"
]
},
"_strength": {
"description": "Extensions for strength",
"$ref": "#/definitions/Element"
},
"description": {
"description": "Describes the intended use of this particular set of codes.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"valueSet": {
"description": "Refers to the value set that identifies the set of codes the binding refers to.",
"$ref": "#/definitions/canonical"
},
"additional": {
"description": "Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.",
"items": {
"$ref": "#/definitions/ElementDefinition_Additional"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ElementDefinition_Additional": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"purpose": {
"description": "The use of this additional binding.",
"$ref": "#/definitions/code"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "#/definitions/Element"
},
"valueSet": {
"description": "The valueSet that is being bound for the purpose.",
"$ref": "#/definitions/canonical"
},
"documentation": {
"description": "Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"shortDoco": {
"description": "Concise documentation - for summary tables.",
"$ref": "#/definitions/string"
},
"_shortDoco": {
"description": "Extensions for shortDoco",
"$ref": "#/definitions/Element"
},
"usage": {
"description": "Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.",
"items": {
"$ref": "#/definitions/UsageContext"
},
"type": "array"
},
"any": {
"description": "Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.",
"$ref": "#/definitions/boolean"
},
"_any": {
"description": "Extensions for any",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"valueSet"
]
},
"ElementDefinition_Mapping": {
"description": "Captures constraints on each element within the resource, profile, or extension.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identity": {
"description": "An internal reference to the definition of a mapping.",
"$ref": "#/definitions/id"
},
"_identity": {
"description": "Extensions for identity",
"$ref": "#/definitions/Element"
},
"language": {
"description": "Identifies the computable language in which mapping.map is expressed.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"map": {
"description": "Expresses what part of the target specification corresponds to this element.",
"$ref": "#/definitions/string"
},
"_map": {
"description": "Extensions for map",
"$ref": "#/definitions/Element"
},
"comment": {
"description": "Comments that provide information about the mapping or its use.",
"$ref": "#/definitions/markdown"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Account": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"resourceType": {
"description": "This is a Account resource",
"const": "Account"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "Indicates whether the account is presently used/usable or not.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"billingStatus": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"type": {
"description": "Categorizes the account for reporting and searching purposes.",
"$ref": "#/definitions/CodeableConcept"
},
"name": {
"description": "Name used for the account when displaying it to humans in reports, etc.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"subject": {
"description": "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.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"servicePeriod": {
"description": "The date range of services associated with this account.",
"$ref": "#/definitions/Period"
},
"coverage": {
"description": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.",
"items": {
"$ref": "#/definitions/Account_Coverage"
},
"type": "array"
},
"owner": {
"description": "Indicates the service area, hospital, department, etc. with responsibility for managing the Account.",
"$ref": "#/definitions/Reference"
},
"description": {
"description": "Provides additional information about what the account tracks and how it is used.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"guarantor": {
"description": "The parties responsible for balancing the account if other payment options fall short.",
"items": {
"$ref": "#/definitions/Account_Guarantor"
},
"type": "array"
},
"diagnosis": {
"description": "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).",
"items": {
"$ref": "#/definitions/Account_Diagnosis"
},
"type": "array"
},
"procedure": {
"description": "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).",
"items": {
"$ref": "#/definitions/Account_Procedure"
},
"type": "array"
},
"relatedAccount": {
"description": "Other associated accounts related to this account.",
"items": {
"$ref": "#/definitions/Account_RelatedAccount"
},
"type": "array"
},
"currency": {
"description": "The default currency for the account.",
"$ref": "#/definitions/CodeableConcept"
},
"balance": {
"description": "The calculated account balances - these are calculated and processed by the finance system.\r\rThe balances with a `term` that is not current are usually generated/updated by an invoicing or similar process.",
"items": {
"$ref": "#/definitions/Account_Balance"
},
"type": "array"
},
"calculatedAt": {
"description": "Time the balance amount was calculated.",
"$ref": "#/definitions/instant"
},
"_calculatedAt": {
"description": "Extensions for calculatedAt",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Account_Coverage": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"coverage": {
"description": "The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).\n\nA 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.",
"$ref": "#/definitions/Reference"
},
"priority": {
"description": "The priority of the coverage in the context of this account.",
"$ref": "#/definitions/positiveInt"
},
"_priority": {
"description": "Extensions for priority",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"coverage"
]
},
"Account_Guarantor": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"party": {
"description": "The entity who is responsible.",
"$ref": "#/definitions/Reference"
},
"onHold": {
"description": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.",
"$ref": "#/definitions/boolean"
},
"_onHold": {
"description": "Extensions for onHold",
"$ref": "#/definitions/Element"
},
"period": {
"description": "The timeframe during which the guarantor accepts responsibility for the account.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"party"
]
},
"Account_Diagnosis": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "Ranking of the diagnosis (for each type).",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "#/definitions/Element"
},
"condition": {
"description": "The diagnosis relevant to the account.",
"$ref": "#/definitions/CodeableReference"
},
"dateOfDiagnosis": {
"description": "Ranking of the diagnosis (for each type).",
"$ref": "#/definitions/dateTime"
},
"_dateOfDiagnosis": {
"description": "Extensions for dateOfDiagnosis",
"$ref": "#/definitions/Element"
},
"type": {
"description": "Type that this diagnosis has relevant to the account (e.g. admission, billing, discharge …).",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"onAdmission": {
"description": "Was the Diagnosis present on Admission in the related Encounter.",
"$ref": "#/definitions/boolean"
},
"_onAdmission": {
"description": "Extensions for onAdmission",
"$ref": "#/definitions/Element"
},
"packageCode": {
"description": "The package code can be used to group diagnoses that may be priced or delivered as a single product. Such as DRGs.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"condition"
]
},
"Account_Procedure": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "Ranking of the procedure (for each type).",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "#/definitions/Element"
},
"code": {
"description": "The procedure relevant to the account.",
"$ref": "#/definitions/CodeableReference"
},
"dateOfService": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_dateOfService": {
"description": "Extensions for dateOfService",
"$ref": "#/definitions/Element"
},
"type": {
"description": "How this procedure value should be used in charging the account.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"packageCode": {
"description": "The package code can be used to group procedures that may be priced or delivered as a single product. Such as DRGs.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"device": {
"description": "Any devices that were associated with the procedure relevant to the account.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"Account_RelatedAccount": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"relationship": {
"description": "Relationship of the associated Account.",
"$ref": "#/definitions/CodeableConcept"
},
"account": {
"description": "Reference to an associated Account.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"account"
]
},
"Account_Balance": {
"description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"aggregate": {
"description": "Who is expected to pay this part of the balance.",
"$ref": "#/definitions/CodeableConcept"
},
"term": {
"description": "The term of the account balances - The balance value is the amount that was outstanding for this age.",
"$ref": "#/definitions/CodeableConcept"
},
"estimate": {
"description": "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).",
"$ref": "#/definitions/boolean"
},
"_estimate": {
"description": "Extensions for estimate",
"$ref": "#/definitions/Element"
},
"amount": {
"description": "The actual balance value calculated for the age defined in the term property.",
"$ref": "#/definitions/Money"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"amount"
]
},
"ActivityDefinition": {
"description": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"properties": {
"resourceType": {
"description": "This is a ActivityDefinition resource",
"const": "ActivityDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the activity definition.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"status": {
"description": "The status of this activity definition. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the activity definition from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the activity definition is intended to be used.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this activity definition is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the activity definition content was or is planned to be in active use.",
"$ref": "#/definitions/Period"
},
"topic": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the content.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the content.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"items": {
"$ref": "#/definitions/RelatedArtifact"
},
"type": "array"
},
"subtitle": {
"description": "An explanatory or alternate title for the activity definition giving additional information about its content.",
"$ref": "#/definitions/string"
},
"_subtitle": {
"description": "Extensions for subtitle",
"$ref": "#/definitions/Element"
},
"subjectCodeableConcept": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"subjectReference": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"subjectCanonical": {
"description": "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.",
"pattern": "^\\S*$",
"type": "string"
},
"_subjectCanonical": {
"description": "Extensions for subjectCanonical",
"$ref": "#/definitions/Element"
},
"usage": {
"description": "A detailed description of how the activity definition is used from a clinical perspective.",
"$ref": "#/definitions/markdown"
},
"_usage": {
"description": "Extensions for usage",
"$ref": "#/definitions/Element"
},
"library": {
"description": "A reference to a Library resource containing any formal logic used by the activity definition.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"kind": {
"description": "A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.",
"$ref": "#/definitions/code"
},
"_kind": {
"description": "Extensions for kind",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "A profile to which the target of the activity definition is expected to conform.",
"$ref": "#/definitions/canonical"
},
"code": {
"description": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"$ref": "#/definitions/CodeableConcept"
},
"intent": {
"description": "Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.",
"$ref": "#/definitions/code"
},
"_intent": {
"description": "Extensions for intent",
"$ref": "#/definitions/Element"
},
"priority": {
"description": "Indicates how quickly the activity should be addressed with respect to other requests.",
"$ref": "#/definitions/code"
},
"_priority": {
"description": "Extensions for priority",
"$ref": "#/definitions/Element"
},
"doNotPerform": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_doNotPerform": {
"description": "Extensions for doNotPerform",
"$ref": "#/definitions/Element"
},
"timingTiming": {
"description": "The timing or frequency upon which the described activity is to occur.",
"$ref": "#/definitions/Timing"
},
"timingAge": {
"description": "The timing or frequency upon which the described activity is to occur.",
"$ref": "#/definitions/Age"
},
"timingRange": {
"description": "The timing or frequency upon which the described activity is to occur.",
"$ref": "#/definitions/Range"
},
"timingDuration": {
"description": "The timing or frequency upon which the described activity is to occur.",
"$ref": "#/definitions/Duration"
},
"asNeededBoolean": {
"description": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.",
"pattern": "^true|false$",
"type": "boolean"
},
"_asNeededBoolean": {
"description": "Extensions for asNeededBoolean",
"$ref": "#/definitions/Element"
},
"asNeededCodeableConcept": {
"description": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.",
"$ref": "#/definitions/CodeableConcept"
},
"location": {
"description": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"$ref": "#/definitions/CodeableReference"
},
"participant": {
"description": "Indicates who should participate in performing the action described.",
"items": {
"$ref": "#/definitions/ActivityDefinition_Participant"
},
"type": "array"
},
"productReference": {
"description": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"$ref": "#/definitions/Reference"
},
"productCodeableConcept": {
"description": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"$ref": "#/definitions/CodeableConcept"
},
"quantity": {
"description": "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).",
"$ref": "#/definitions/Quantity"
},
"dosage": {
"description": "Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.",
"items": {
"$ref": "#/definitions/Dosage"
},
"type": "array"
},
"bodySite": {
"description": "Indicates the sites on the subject\u0027s body where the procedure should be performed (I.e. the target sites).",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"specimenRequirement": {
"description": "Defines specimen requirements for the action to be performed, such as required specimens for a lab test.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"observationRequirement": {
"description": "Defines observation requirements for the action to be performed, such as body weight or surface area.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"observationResultRequirement": {
"description": "Defines the observations that are expected to be produced by the action.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"transform": {
"description": "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.",
"$ref": "#/definitions/canonical"
},
"dynamicValue": {
"description": "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\u0027s 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.",
"items": {
"$ref": "#/definitions/ActivityDefinition_DynamicValue"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"ActivityDefinition_Participant": {
"description": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of participant in the action.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"typeCanonical": {
"description": "The type of participant in the action.",
"$ref": "#/definitions/canonical"
},
"typeReference": {
"description": "The type of participant in the action.",
"$ref": "#/definitions/Reference"
},
"role": {
"description": "The role the participant should play in performing the described action.",
"$ref": "#/definitions/CodeableConcept"
},
"function": {
"description": "Indicates how the actor will be involved in the action - author, reviewer, witness, etc.",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"ActivityDefinition_DynamicValue": {
"description": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "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](fhirpath.html#simple) for full details).",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "#/definitions/Element"
},
"expression": {
"description": "An expression specifying the value of the customized element.",
"$ref": "#/definitions/Expression"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"expression"
]
},
"ActorDefinition": {
"description": "Describes an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.",
"properties": {
"resourceType": {
"description": "This is a ActorDefinition resource",
"const": "ActorDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the actor definition.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"status": {
"description": "The status of this actor definition. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the actor.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the actor definition is intended to be used.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this actor definition is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "#/definitions/Element"
},
"type": {
"description": "Whether the actor represents a human or an appliction.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "Documentation about the functionality of the actor.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"reference": {
"description": "A reference to additional documentation about the actor, but description and documentation.",
"items": {
"$ref": "#/definitions/url"
},
"type": "array"
},
"_reference": {
"description": "Extensions for reference",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"capabilities": {
"description": "The capability statement for the actor (if the concept is applicable).",
"$ref": "#/definitions/canonical"
},
"derivedFrom": {
"description": "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.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"AdministrableProductDefinition": {
"description": "A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).",
"properties": {
"resourceType": {
"description": "This is a AdministrableProductDefinition resource",
"const": "AdministrableProductDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "An identifier for the administrable product.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "The status of this administrable product. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"formOf": {
"description": "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 \u0027formOf\u0027 would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the \u0027producedFrom\u0027 which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"administrableDoseForm": {
"description": "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 \u0027powder for solution for injection\u0027, the administrable dose form could be \u0027solution for injection\u0027 (once mixed with another item having manufactured form \u0027solvent for solution for injection\u0027).",
"$ref": "#/definitions/CodeableConcept"
},
"unitOfPresentation": {
"description": "The presentation type in which this item is given to a patient. e.g. for a spray - \u0027puff\u0027 (as in \u0027contains 100 mcg per puff\u0027), or for a liquid - \u0027vial\u0027 (as in \u0027contains 5 ml per vial\u0027).",
"$ref": "#/definitions/CodeableConcept"
},
"producedFrom": {
"description": "Indicates the specific manufactured items that are part of the \u0027formOf\u0027 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.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"ingredient": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"device": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"description": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"property": {
"description": "Characteristics e.g. a product\u0027s onset of action.",
"items": {
"$ref": "#/definitions/AdministrableProductDefinition_Property"
},
"type": "array"
},
"routeOfAdministration": {
"description": "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 \u0027formOf\u0027 product already uses MedicinalProductDefinition.route (and vice versa).",
"items": {
"$ref": "#/definitions/AdministrableProductDefinition_RouteOfAdministration"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"routeOfAdministration",
"resourceType"
]
},
"AdministrableProductDefinition_Property": {
"description": "A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "A code expressing the type of characteristic.",
"$ref": "#/definitions/CodeableConcept"
},
"valueCodeableConcept": {
"description": "A value for the characteristic.",
"$ref": "#/definitions/CodeableConcept"
},
"valueQuantity": {
"description": "A value for the characteristic.",
"$ref": "#/definitions/Quantity"
},
"valueDate": {
"description": "A value for the characteristic.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_valueDate": {
"description": "Extensions for valueDate",
"$ref": "#/definitions/Element"
},
"valueBoolean": {
"description": "A value for the characteristic.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "#/definitions/Element"
},
"valueMarkdown": {
"description": "A value for the characteristic.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueMarkdown": {
"description": "Extensions for valueMarkdown",
"$ref": "#/definitions/Element"
},
"valueAttachment": {
"description": "A value for the characteristic.",
"$ref": "#/definitions/Attachment"
},
"valueReference": {
"description": "A value for the characteristic.",
"$ref": "#/definitions/Reference"
},
"status": {
"description": "The status of characteristic e.g. assigned or pending.",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"AdministrableProductDefinition_RouteOfAdministration": {
"description": "A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Coded expression for the route.",
"$ref": "#/definitions/CodeableConcept"
},
"firstDose": {
"description": "The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.",
"$ref": "#/definitions/Quantity"
},
"maxSingleDose": {
"description": "The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.",
"$ref": "#/definitions/Quantity"
},
"maxDosePerDay": {
"description": "The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.",
"$ref": "#/definitions/Quantity"
},
"maxDosePerTreatmentPeriod": {
"description": "The maximum dose per treatment period that can be administered.",
"$ref": "#/definitions/Ratio"
},
"maxTreatmentPeriod": {
"description": "The maximum treatment period during which the product can be administered.",
"$ref": "#/definitions/Duration"
},
"targetSpecies": {
"description": "A species for which this route applies.",
"items": {
"$ref": "#/definitions/AdministrableProductDefinition_TargetSpecies"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"AdministrableProductDefinition_TargetSpecies": {
"description": "A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Coded expression for the species.",
"$ref": "#/definitions/CodeableConcept"
},
"withdrawalPeriod": {
"description": "A species specific time during which consumption of animal product is not appropriate.",
"items": {
"$ref": "#/definitions/AdministrableProductDefinition_WithdrawalPeriod"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"AdministrableProductDefinition_WithdrawalPeriod": {
"description": "A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"tissue": {
"description": "Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.",
"$ref": "#/definitions/CodeableConcept"
},
"value": {
"description": "A value for the time.",
"$ref": "#/definitions/Quantity"
},
"supportingInformation": {
"description": "Extra information about the withdrawal period.",
"$ref": "#/definitions/string"
},
"_supportingInformation": {
"description": "Extensions for supportingInformation",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"tissue",
"value"
]
},
"AdverseEvent": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"resourceType": {
"description": "This is a AdverseEvent resource",
"const": "AdverseEvent"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "The current state of the adverse event or potential adverse event.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"actuality": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_actuality": {
"description": "Extensions for actuality",
"$ref": "#/definitions/Element"
},
"category": {
"description": "The overall type of event, intended for search and filtering purposes.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"code": {
"description": "Specific event that occurred or that was averted, such as patient fall, wrong organ removed, or wrong blood transfused.",
"$ref": "#/definitions/CodeableConcept"
},
"subject": {
"description": "This subject or group impacted by the event.",
"$ref": "#/definitions/Reference"
},
"encounter": {
"description": "The Encounter associated with the start of the AdverseEvent.",
"$ref": "#/definitions/Reference"
},
"occurrenceDateTime": {
"description": "The date (and perhaps time) when the adverse event occurred.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_occurrenceDateTime": {
"description": "Extensions for occurrenceDateTime",
"$ref": "#/definitions/Element"
},
"occurrencePeriod": {
"description": "The date (and perhaps time) when the adverse event occurred.",
"$ref": "#/definitions/Period"
},
"occurrenceTiming": {
"description": "The date (and perhaps time) when the adverse event occurred.",
"$ref": "#/definitions/Timing"
},
"detected": {
"description": "Estimated or actual date the AdverseEvent began, in the opinion of the reporter.",
"$ref": "#/definitions/dateTime"
},
"_detected": {
"description": "Extensions for detected",
"$ref": "#/definitions/Element"
},
"recordedDate": {
"description": "The date on which the existence of the AdverseEvent was first recorded.",
"$ref": "#/definitions/dateTime"
},
"_recordedDate": {
"description": "Extensions for recordedDate",
"$ref": "#/definitions/Element"
},
"resultingEffect": {
"description": "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.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"location": {
"description": "The information about where the adverse event occurred.",
"$ref": "#/definitions/Reference"
},
"seriousness": {
"description": "Assessment whether this event, or averted event, was of clinical importance.",
"$ref": "#/definitions/CodeableConcept"
},
"outcome": {
"description": "Describes the type of outcome from the adverse event, such as resolved, recovering, ongoing, resolved-with-sequelae, or fatal.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"recorder": {
"description": "Information on who recorded the adverse event. May be the patient or a practitioner.",
"$ref": "#/definitions/Reference"
},
"participant": {
"description": "Indicates who or what participated in the adverse event and how they were involved.",
"items": {
"$ref": "#/definitions/AdverseEvent_Participant"
},
"type": "array"
},
"study": {
"description": "The research study that the subject is enrolled in.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"expectedInResearchStudy": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_expectedInResearchStudy": {
"description": "Extensions for expectedInResearchStudy",
"$ref": "#/definitions/Element"
},
"suspectEntity": {
"description": "Describes the entity that is suspected to have caused the adverse event.",
"items": {
"$ref": "#/definitions/AdverseEvent_SuspectEntity"
},
"type": "array"
},
"contributingFactor": {
"description": "The contributing factors suspected to have increased the probability or severity of the adverse event.",
"items": {
"$ref": "#/definitions/AdverseEvent_ContributingFactor"
},
"type": "array"
},
"preventiveAction": {
"description": "Preventive actions that contributed to avoiding the adverse event.",
"items": {
"$ref": "#/definitions/AdverseEvent_PreventiveAction"
},
"type": "array"
},
"mitigatingAction": {
"description": "The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.",
"items": {
"$ref": "#/definitions/AdverseEvent_MitigatingAction"
},
"type": "array"
},
"supportingInfo": {
"description": "Supporting information relevant to the event.",
"items": {
"$ref": "#/definitions/AdverseEvent_SupportingInfo"
},
"type": "array"
},
"note": {
"description": "Comments made about the adverse event by the performer, subject or other participants.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"subject",
"resourceType"
]
},
"AdverseEvent_Participant": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Distinguishes the type of involvement of the actor in the adverse event, such as contributor or informant.",
"$ref": "#/definitions/CodeableConcept"
},
"actor": {
"description": "Indicates who or what participated in the event.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"actor"
]
},
"AdverseEvent_SuspectEntity": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"instanceCodeableConcept": {
"description": "Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.",
"$ref": "#/definitions/CodeableConcept"
},
"instanceReference": {
"description": "Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.",
"$ref": "#/definitions/Reference"
},
"causality": {
"description": "Information on the possible cause of the event.",
"$ref": "#/definitions/AdverseEvent_Causality"
}
},
"type": "object",
"additionalProperties": false
},
"AdverseEvent_Causality": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"assessmentMethod": {
"description": "The method of evaluating the relatedness of the suspected entity to the event.",
"$ref": "#/definitions/CodeableConcept"
},
"entityRelatedness": {
"description": "The result of the assessment regarding the relatedness of the suspected entity to the event.",
"$ref": "#/definitions/CodeableConcept"
},
"author": {
"description": "The author of the information on the possible cause of the event.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"AdverseEvent_ContributingFactor": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"itemReference": {
"description": "The item that is suspected to have increased the probability or severity of the adverse event.",
"$ref": "#/definitions/Reference"
},
"itemCodeableConcept": {
"description": "The item that is suspected to have increased the probability or severity of the adverse event.",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"AdverseEvent_PreventiveAction": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"itemReference": {
"description": "The action that contributed to avoiding the adverse event.",
"$ref": "#/definitions/Reference"
},
"itemCodeableConcept": {
"description": "The action that contributed to avoiding the adverse event.",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"AdverseEvent_MitigatingAction": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"itemReference": {
"description": "The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.",
"$ref": "#/definitions/Reference"
},
"itemCodeableConcept": {
"description": "The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"AdverseEvent_SupportingInfo": {
"description": "An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"itemReference": {
"description": "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\u0027s 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.",
"$ref": "#/definitions/Reference"
},
"itemCodeableConcept": {
"description": "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\u0027s 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.",
"$ref": "#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"AllergyIntolerance": {
"description": "Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance.",
"properties": {
"resourceType": {
"description": "This is a AllergyIntolerance resource",
"const": "AllergyIntolerance"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"clinicalStatus": {
"description": "The clinical status of the allergy or intolerance.",
"$ref": "#/definitions/CodeableConcept"
},
"verificationStatus": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"type": {
"description": "Identification of the underlying physiological mechanism for the reaction risk.",
"$ref": "#/definitions/CodeableConcept"
},
"category": {
"description": "Category of the identified substance.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_category": {
"description": "Extensions for category",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"criticality": {
"description": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.",
"$ref": "#/definitions/code"
},
"_criticality": {
"description": "Extensions for criticality",
"$ref": "#/definitions/Element"
},
"code": {
"description": "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 \u0027code\u0027 and ignore the \u0027reaction.substance\u0027. 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.",
"$ref": "#/definitions/CodeableConcept"
},
"patient": {
"description": "The patient who has the allergy or intolerance.",
"$ref": "#/definitions/Reference"
},
"encounter": {
"description": "The encounter when the allergy or intolerance was asserted.",
"$ref": "#/definitions/Reference"
},
"onsetDateTime": {
"description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_onsetDateTime": {
"description": "Extensions for onsetDateTime",
"$ref": "#/definitions/Element"
},
"onsetAge": {
"description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"$ref": "#/definitions/Age"
},
"onsetPeriod": {
"description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"$ref": "#/definitions/Period"
},
"onsetRange": {
"description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"$ref": "#/definitions/Range"
},
"onsetString": {
"description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_onsetString": {
"description": "Extensions for onsetString",
"$ref": "#/definitions/Element"
},
"recordedDate": {
"description": "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.",
"$ref": "#/definitions/dateTime"
},
"_recordedDate": {
"description": "Extensions for recordedDate",
"$ref": "#/definitions/Element"
},
"participant": {
"description": "Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.",
"items": {
"$ref": "#/definitions/AllergyIntolerance_Participant"
},
"type": "array"
},
"lastOccurrence": {
"description": "Represents the date and/or time of the last known occurrence of a reaction event.",
"$ref": "#/definitions/dateTime"
},
"_lastOccurrence": {
"description": "Extensions for lastOccurrence",
"$ref": "#/definitions/Element"
},
"note": {
"description": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
},
"reaction": {
"description": "Details about each adverse reaction event linked to exposure to the identified substance.",
"items": {
"$ref": "#/definitions/AllergyIntolerance_Reaction"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"patient",
"resourceType"
]
},
"AllergyIntolerance_Participant": {
"description": "Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Distinguishes the type of involvement of the actor in the activities related to the allergy or intolerance.",
"$ref": "#/definitions/CodeableConcept"
},
"actor": {
"description": "Indicates who or what participated in the activities related to the allergy or intolerance.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"actor"
]
},
"AllergyIntolerance_Reaction": {
"description": "Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"substance": {
"description": "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 \u0027code\u0027 and ignore the \u0027reaction.substance\u0027. 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.",
"$ref": "#/definitions/CodeableConcept"
},
"manifestation": {
"description": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"description": {
"description": "Text description about the reaction as a whole, including details of the manifestation if required.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"onset": {
"description": "Record of the date and/or time of the onset of the Reaction.",
"$ref": "#/definitions/dateTime"
},
"_onset": {
"description": "Extensions for onset",
"$ref": "#/definitions/Element"
},
"severity": {
"description": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"$ref": "#/definitions/code"
},
"_severity": {
"description": "Extensions for severity",
"$ref": "#/definitions/Element"
},
"exposureRoute": {
"description": "Identification of the route by which the subject was exposed to the substance.",
"$ref": "#/definitions/CodeableConcept"
},
"note": {
"description": "Additional text about the adverse reaction event not captured in other fields.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"manifestation"
]
},
"Appointment": {
"description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"properties": {
"resourceType": {
"description": "This is a Appointment resource",
"const": "Appointment"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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).",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"cancellationReason": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"class": {
"description": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"serviceCategory": {
"description": "A broad categorization of the service that is to be performed during this appointment.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"serviceType": {
"description": "The specific service that is to be performed during this appointment.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"specialty": {
"description": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"appointmentType": {
"description": "The style of appointment or patient that has been booked in the slot (not service type).",
"$ref": "#/definitions/CodeableConcept"
},
"reason": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"priority": {
"description": "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).",
"$ref": "#/definitions/CodeableConcept"
},
"description": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"replaces": {
"description": "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).",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"virtualService": {
"description": "Connection details of a virtual service (e.g. conference call).",
"items": {
"$ref": "#/definitions/VirtualServiceDetail"
},
"type": "array"
},
"supportingInformation": {
"description": "Additional information to support the appointment provided when making the appointment.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"previousAppointment": {
"description": "The previous appointment in a series of related appointments.",
"$ref": "#/definitions/Reference"
},
"originatingAppointment": {
"description": "The originating appointment in a recurring set of related appointments.",
"$ref": "#/definitions/Reference"
},
"start": {
"description": "Date/Time that the appointment is to take place.",
"$ref": "#/definitions/instant"
},
"_start": {
"description": "Extensions for start",
"$ref": "#/definitions/Element"
},
"end": {
"description": "Date/Time that the appointment is to conclude.",
"$ref": "#/definitions/instant"
},
"_end": {
"description": "Extensions for end",
"$ref": "#/definitions/Element"
},
"minutesDuration": {
"description": "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.",
"$ref": "#/definitions/positiveInt"
},
"_minutesDuration": {
"description": "Extensions for minutesDuration",
"$ref": "#/definitions/Element"
},
"requestedPeriod": {
"description": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe 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.",
"items": {
"$ref": "#/definitions/Period"
},
"type": "array"
},
"slot": {
"description": "The slots from the participants\u0027 schedules that will be filled by the appointment.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"account": {
"description": "The set of accounts that is expected to be used for billing the activities that result from this Appointment.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"created": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_created": {
"description": "Extensions for created",
"$ref": "#/definitions/Element"
},
"cancellationDate": {
"description": "The date/time describing when the appointment was cancelled.",
"$ref": "#/definitions/dateTime"
},
"_cancellationDate": {
"description": "Extensions for cancellationDate",
"$ref": "#/definitions/Element"
},
"note": {
"description": "Additional notes/comments about the appointment.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
},
"patientInstruction": {
"description": "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).",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"basedOn": {
"description": "The request this appointment is allocated to assess (e.g. incoming referral or procedure request).",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"subject": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"participant": {
"description": "List of participants involved in the appointment.",
"items": {
"$ref": "#/definitions/Appointment_Participant"
},
"type": "array"
},
"recurrenceId": {
"description": "The sequence number that identifies a specific appointment in a recurring pattern.",
"$ref": "#/definitions/positiveInt"
},
"_recurrenceId": {
"description": "Extensions for recurrenceId",
"$ref": "#/definitions/Element"
},
"occurrenceChanged": {
"description": "This appointment varies from the recurring pattern.",
"$ref": "#/definitions/boolean"
},
"_occurrenceChanged": {
"description": "Extensions for occurrenceChanged",
"$ref": "#/definitions/Element"
},
"recurrenceTemplate": {
"description": "The details of the recurrence pattern or template that is used to generate recurring appointments.",
"items": {
"$ref": "#/definitions/Appointment_RecurrenceTemplate"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"participant",
"resourceType"
]
},
"Appointment_Participant": {
"description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Role of participant in the appointment.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"period": {
"description": "Participation period of the actor.",
"$ref": "#/definitions/Period"
},
"actor": {
"description": "The individual, device, location, or service participating in the appointment.",
"$ref": "#/definitions/Reference"
},
"required": {
"description": "Whether this participant is required to be present at the meeting. If false, the participant is optional.",
"$ref": "#/definitions/boolean"
},
"_required": {
"description": "Extensions for required",
"$ref": "#/definitions/Element"
},
"status": {
"description": "Participation status of the actor.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Appointment_RecurrenceTemplate": {
"description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"timezone": {
"description": "The timezone of the recurring appointment occurrences.",
"$ref": "#/definitions/CodeableConcept"
},
"recurrenceType": {
"description": "How often the appointment series should recur.",
"$ref": "#/definitions/CodeableConcept"
},
"lastOccurrenceDate": {
"description": "Recurring appointments will not occur after this date.",
"$ref": "#/definitions/date"
},
"_lastOccurrenceDate": {
"description": "Extensions for lastOccurrenceDate",
"$ref": "#/definitions/Element"
},
"occurrenceCount": {
"description": "How many appointments are planned in the recurrence.",
"$ref": "#/definitions/positiveInt"
},
"_occurrenceCount": {
"description": "Extensions for occurrenceCount",
"$ref": "#/definitions/Element"
},
"occurrenceDate": {
"description": "The list of specific dates that will have appointments generated.",
"items": {
"$ref": "#/definitions/date"
},
"type": "array"
},
"_occurrenceDate": {
"description": "Extensions for occurrenceDate",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"weeklyTemplate": {
"description": "Information about weekly recurring appointments.",
"$ref": "#/definitions/Appointment_WeeklyTemplate"
},
"monthlyTemplate": {
"description": "Information about monthly recurring appointments.",
"$ref": "#/definitions/Appointment_MonthlyTemplate"
},
"yearlyTemplate": {
"description": "Information about yearly recurring appointments.",
"$ref": "#/definitions/Appointment_YearlyTemplate"
},
"excludingDate": {
"description": "Any dates, such as holidays, that should be excluded from the recurrence.",
"items": {
"$ref": "#/definitions/date"
},
"type": "array"
},
"_excludingDate": {
"description": "Extensions for excludingDate",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"excludingRecurrenceId": {
"description": "Any dates, such as holidays, that should be excluded from the recurrence.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_excludingRecurrenceId": {
"description": "Extensions for excludingRecurrenceId",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"recurrenceType"
]
},
"Appointment_WeeklyTemplate": {
"description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"monday": {
"description": "Indicates that recurring appointments should occur on Mondays.",
"$ref": "#/definitions/boolean"
},
"_monday": {
"description": "Extensions for monday",
"$ref": "#/definitions/Element"
},
"tuesday": {
"description": "Indicates that recurring appointments should occur on Tuesdays.",
"$ref": "#/definitions/boolean"
},
"_tuesday": {
"description": "Extensions for tuesday",
"$ref": "#/definitions/Element"
},
"wednesday": {
"description": "Indicates that recurring appointments should occur on Wednesdays.",
"$ref": "#/definitions/boolean"
},
"_wednesday": {
"description": "Extensions for wednesday",
"$ref": "#/definitions/Element"
},
"thursday": {
"description": "Indicates that recurring appointments should occur on Thursdays.",
"$ref": "#/definitions/boolean"
},
"_thursday": {
"description": "Extensions for thursday",
"$ref": "#/definitions/Element"
},
"friday": {
"description": "Indicates that recurring appointments should occur on Fridays.",
"$ref": "#/definitions/boolean"
},
"_friday": {
"description": "Extensions for friday",
"$ref": "#/definitions/Element"
},
"saturday": {
"description": "Indicates that recurring appointments should occur on Saturdays.",
"$ref": "#/definitions/boolean"
},
"_saturday": {
"description": "Extensions for saturday",
"$ref": "#/definitions/Element"
},
"sunday": {
"description": "Indicates that recurring appointments should occur on Sundays.",
"$ref": "#/definitions/boolean"
},
"_sunday": {
"description": "Extensions for sunday",
"$ref": "#/definitions/Element"
},
"weekInterval": {
"description": "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.\r\re.g. For recurring every second week this interval would be 2, or every third week the interval would be 3.",
"$ref": "#/definitions/positiveInt"
},
"_weekInterval": {
"description": "Extensions for weekInterval",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Appointment_MonthlyTemplate": {
"description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"dayOfMonth": {
"description": "Indicates that appointments in the series of recurring appointments should occur on a specific day of the month.",
"$ref": "#/definitions/positiveInt"
},
"_dayOfMonth": {
"description": "Extensions for dayOfMonth",
"$ref": "#/definitions/Element"
},
"nthWeekOfMonth": {
"description": "Indicates which week within a month the appointments in the series of recurring appointments should occur on.",
"$ref": "#/definitions/Coding"
},
"dayOfWeek": {
"description": "Indicates which day of the week the recurring appointments should occur each nth week.",
"$ref": "#/definitions/Coding"
},
"monthInterval": {
"description": "Indicates that recurring appointments should occur every nth month.",
"$ref": "#/definitions/positiveInt"
},
"_monthInterval": {
"description": "Extensions for monthInterval",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Appointment_YearlyTemplate": {
"description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"yearInterval": {
"description": "Appointment recurs every nth year.",
"$ref": "#/definitions/positiveInt"
},
"_yearInterval": {
"description": "Extensions for yearInterval",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"AppointmentResponse": {
"description": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"properties": {
"resourceType": {
"description": "This is a AppointmentResponse resource",
"const": "AppointmentResponse"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"appointment": {
"description": "Appointment that this response is replying to.",
"$ref": "#/definitions/Reference"
},
"proposedNewTime": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_proposedNewTime": {
"description": "Extensions for proposedNewTime",
"$ref": "#/definitions/Element"
},
"start": {
"description": "Date/Time that the appointment is to take place, or requested new start time.",
"$ref": "#/definitions/instant"
},
"_start": {
"description": "Extensions for start",
"$ref": "#/definitions/Element"
},
"end": {
"description": "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.",
"$ref": "#/definitions/instant"
},
"_end": {
"description": "Extensions for end",
"$ref": "#/definitions/Element"
},
"participantType": {
"description": "Role of participant in the appointment.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"actor": {
"description": "A Person, Location, HealthcareService, or Device that is participating in the appointment.",
"$ref": "#/definitions/Reference"
},
"participantStatus": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_participantStatus": {
"description": "Extensions for participantStatus",
"$ref": "#/definitions/Element"
},
"comment": {
"description": "Additional comments about the appointment.",
"$ref": "#/definitions/markdown"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "#/definitions/Element"
},
"recurring": {
"description": "Indicates that this AppointmentResponse applies to all occurrences in a recurring request.",
"$ref": "#/definitions/boolean"
},
"_recurring": {
"description": "Extensions for recurring",
"$ref": "#/definitions/Element"
},
"occurrenceDate": {
"description": "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`).",
"$ref": "#/definitions/date"
},
"_occurrenceDate": {
"description": "Extensions for occurrenceDate",
"$ref": "#/definitions/Element"
},
"recurrenceId": {
"description": "The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.",
"$ref": "#/definitions/positiveInt"
},
"_recurrenceId": {
"description": "Extensions for recurrenceId",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"appointment",
"resourceType"
]
},
"ArtifactAssessment": {
"description": "This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.",
"properties": {
"resourceType": {
"description": "This is a ArtifactAssessment resource",
"const": "ArtifactAssessment"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"title": {
"description": "A short title for the assessment for use in displaying and selecting.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"citeAsReference": {
"description": "Display of or reference to the bibliographic citation of the comment, classifier, or rating.",
"$ref": "#/definitions/Reference"
},
"citeAsMarkdown": {
"description": "Display of or reference to the bibliographic citation of the comment, classifier, or rating.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_citeAsMarkdown": {
"description": "Extensions for citeAsMarkdown",
"$ref": "#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "#/definitions/Element"
},
"artifactReference": {
"description": "A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.",
"$ref": "#/definitions/Reference"
},
"artifactCanonical": {
"description": "A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.",
"pattern": "^\\S*$",
"type": "string"
},
"_artifactCanonical": {
"description": "Extensions for artifactCanonical",
"$ref": "#/definitions/Element"
},
"artifactUri": {
"description": "A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.",
"pattern": "^\\S*$",
"type": "string"
},
"_artifactUri": {
"description": "Extensions for artifactUri",
"$ref": "#/definitions/Element"
},
"content": {
"description": "A component comment, classifier, or rating of the artifact.",
"items": {
"$ref": "#/definitions/ArtifactAssessment_Content"
},
"type": "array"
},
"workflowStatus": {
"description": "Indicates the workflow status of the comment or change request.",
"$ref": "#/definitions/code"
},
"_workflowStatus": {
"description": "Extensions for workflowStatus",
"$ref": "#/definitions/Element"
},
"disposition": {
"description": "Indicates the disposition of the responsible party to the comment or change request.",
"$ref": "#/definitions/code"
},
"_disposition": {
"description": "Extensions for disposition",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"ArtifactAssessment_Content": {
"description": "This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"informationType": {
"description": "The type of information this component of the content represents.",
"$ref": "#/definitions/code"
},
"_informationType": {
"description": "Extensions for informationType",
"$ref": "#/definitions/Element"
},
"summary": {
"description": "A brief summary of the content of this component.",
"$ref": "#/definitions/markdown"
},
"_summary": {
"description": "Extensions for summary",
"$ref": "#/definitions/Element"
},
"type": {
"description": "Indicates what type of content this component represents.",
"$ref": "#/definitions/CodeableConcept"
},
"classifier": {
"description": "Represents a rating, classifier, or assessment of the artifact.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"quantity": {
"description": "A quantitative rating of the artifact.",
"$ref": "#/definitions/Quantity"
},
"author": {
"description": "Indicates who or what authored the content.",
"$ref": "#/definitions/Reference"
},
"path": {
"description": "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.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_path": {
"description": "Extensions for path",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"relatedArtifact": {
"description": "Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.",
"items": {
"$ref": "#/definitions/RelatedArtifact"
},
"type": "array"
},
"freeToShare": {
"description": "Acceptable to publicly share the comment, classifier or rating.",
"$ref": "#/definitions/boolean"
},
"_freeToShare": {
"description": "Extensions for freeToShare",
"$ref": "#/definitions/Element"
},
"component": {
"description": "If the informationType is container, the components of the content.",
"items": {
"$ref": "#/definitions/ArtifactAssessment_Content"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"AuditEvent": {
"description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"properties": {
"resourceType": {
"description": "This is a AuditEvent resource",
"const": "AuditEvent"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"category": {
"description": "Classification of the type of event.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"code": {
"description": "Describes what happened. The most specific code for the event.",
"$ref": "#/definitions/CodeableConcept"
},
"action": {
"description": "Indicator for type of action performed during the event that generated the audit.",
"$ref": "#/definitions/code"
},
"_action": {
"description": "Extensions for action",
"$ref": "#/definitions/Element"
},
"severity": {
"description": "Indicates and enables segmentation of various severity including debugging from critical.",
"$ref": "#/definitions/code"
},
"_severity": {
"description": "Extensions for severity",
"$ref": "#/definitions/Element"
},
"occurredPeriod": {
"description": "The time or period during which the activity occurred.",
"$ref": "#/definitions/Period"
},
"occurredDateTime": {
"description": "The time or period during which the activity occurred.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_occurredDateTime": {
"description": "Extensions for occurredDateTime",
"$ref": "#/definitions/Element"
},
"recorded": {
"description": "The time when the event was recorded.",
"$ref": "#/definitions/instant"
},
"_recorded": {
"description": "Extensions for recorded",
"$ref": "#/definitions/Element"
},
"outcome": {
"description": "Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.",
"$ref": "#/definitions/AuditEvent_Outcome"
},
"authorization": {
"description": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"basedOn": {
"description": "Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"patient": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"encounter": {
"description": "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).",
"$ref": "#/definitions/Reference"
},
"agent": {
"description": "An actor taking an active role in the event or activity that is logged.",
"items": {
"$ref": "#/definitions/AuditEvent_Agent"
},
"type": "array"
},
"source": {
"description": "The actor that is reporting the event.",
"$ref": "#/definitions/AuditEvent_Source"
},
"entity": {
"description": "Specific instances of data or objects that have been accessed.",
"items": {
"$ref": "#/definitions/AuditEvent_Entity"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"agent",
"code",
"source",
"resourceType"
]
},
"AuditEvent_Outcome": {
"description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Indicates whether the event succeeded or failed.",
"$ref": "#/definitions/Coding"
},
"detail": {
"description": "Additional details about the error. This may be a text description of the error or a system code that identifies the error.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"AuditEvent_Agent": {
"description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The Functional Role of the user when performing the event.",
"$ref": "#/definitions/CodeableConcept"
},
"role": {
"description": "The structural roles of the agent indicating the agent\u0027s competency. The security role enabling the agent with respect to the activity.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"who": {
"description": "Reference to who this agent is that was involved in the event.",
"$ref": "#/definitions/Reference"
},
"requestor": {
"description": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"$ref": "#/definitions/boolean"
},
"_requestor": {
"description": "Extensions for requestor",
"$ref": "#/definitions/Element"
},
"location": {
"description": "Where the agent location is known, the agent location when the event occurred.",
"$ref": "#/definitions/Reference"
},
"policy": {
"description": "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.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_policy": {
"description": "Extensions for policy",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"networkReference": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"networkUri": {
"description": "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.",
"pattern": "^\\S*$",
"type": "string"
},
"_networkUri": {
"description": "Extensions for networkUri",
"$ref": "#/definitions/Element"
},
"networkString": {
"description": "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.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_networkString": {
"description": "Extensions for networkString",
"$ref": "#/definitions/Element"
},
"authorization": {
"description": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"who"
]
},
"AuditEvent_Source": {
"description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"site": {
"description": "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.",
"$ref": "#/definitions/Reference"
},
"observer": {
"description": "Identifier of the source where the event was detected.",
"$ref": "#/definitions/Reference"
},
"type": {
"description": "Code specifying the type of source where event originated.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"observer"
]
},
"AuditEvent_Entity": {
"description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"what": {
"description": "Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource.",
"$ref": "#/definitions/Reference"
},
"role": {
"description": "Code representing the role the entity played in the event being audited.",
"$ref": "#/definitions/CodeableConcept"
},
"securityLabel": {
"description": "Security labels for the identified entity.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"query": {
"description": "The query parameters for a query-type entities.",
"$ref": "#/definitions/base64Binary"
},
"_query": {
"description": "Extensions for query",
"$ref": "#/definitions/Element"
},
"detail": {
"description": "Tagged value pairs for conveying additional information about the entity.",
"items": {
"$ref": "#/definitions/AuditEvent_Detail"
},
"type": "array"
},
"agent": {
"description": "The entity is attributed to an agent to express the agent\u0027s responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.",
"items": {
"$ref": "#/definitions/AuditEvent_Agent"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"AuditEvent_Detail": {
"description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of extra detail provided in the value.",
"$ref": "#/definitions/CodeableConcept"
},
"valueQuantity": {
"description": "The value of the extra detail.",
"$ref": "#/definitions/Quantity"
},
"valueCodeableConcept": {
"description": "The value of the extra detail.",
"$ref": "#/definitions/CodeableConcept"
},
"valueString": {
"description": "The value of the extra detail.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "#/definitions/Element"
},
"valueBoolean": {
"description": "The value of the extra detail.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "#/definitions/Element"
},
"valueInteger": {
"description": "The value of the extra detail.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "#/definitions/Element"
},
"valueRange": {
"description": "The value of the extra detail.",
"$ref": "#/definitions/Range"
},
"valueRatio": {
"description": "The value of the extra detail.",
"$ref": "#/definitions/Ratio"
},
"valueTime": {
"description": "The value of the extra detail.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "#/definitions/Element"
},
"valueDateTime": {
"description": "The value of the extra detail.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "#/definitions/Element"
},
"valuePeriod": {
"description": "The value of the extra detail.",
"$ref": "#/definitions/Period"
},
"valueBase64Binary": {
"description": "The value of the extra detail.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
"type": "string"
},
"_valueBase64Binary": {
"description": "Extensions for valueBase64Binary",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"Basic": {
"description": "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don\u0027t map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.",
"properties": {
"resourceType": {
"description": "This is a Basic resource",
"const": "Basic"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"code": {
"description": "Identifies the \u0027type\u0027 of resource - equivalent to the resource name for other resources.",
"$ref": "#/definitions/CodeableConcept"
},
"subject": {
"description": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resource.",
"$ref": "#/definitions/Reference"
},
"created": {
"description": "Identifies when the resource was first created.",
"$ref": "#/definitions/dateTime"
},
"_created": {
"description": "Extensions for created",
"$ref": "#/definitions/Element"
},
"author": {
"description": "Indicates who was responsible for creating the resource instance.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code",
"resourceType"
]
},
"Binary": {
"description": "A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"properties": {
"resourceType": {
"description": "This is a Binary resource",
"const": "Binary"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"contentType": {
"description": "MimeType of the binary content represented as a standard MimeType (BCP 13).",
"$ref": "#/definitions/code"
},
"_contentType": {
"description": "Extensions for contentType",
"$ref": "#/definitions/Element"
},
"securityContext": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"data": {
"description": "The actual content, base64 encoded.",
"$ref": "#/definitions/base64Binary"
},
"_data": {
"description": "Extensions for data",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"BiologicallyDerivedProduct": {
"description": "This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
"properties": {
"resourceType": {
"description": "This is a BiologicallyDerivedProduct resource",
"const": "BiologicallyDerivedProduct"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"productCategory": {
"description": "Broad category of this product.",
"$ref": "#/definitions/Coding"
},
"productCode": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"parent": {
"description": "Parent product (if any) for this biologically-derived product.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"request": {
"description": "Request to obtain and/or infuse this biologically derived product.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"identifier": {
"description": "Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"biologicalSourceEvent": {
"description": "An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.",
"$ref": "#/definitions/Identifier"
},
"processingFacility": {
"description": "Processing facilities responsible for the labeling and distribution of this biologically derived product.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"division": {
"description": "A unique identifier for an aliquot of a product. Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.",
"$ref": "#/definitions/string"
},
"_division": {
"description": "Extensions for division",
"$ref": "#/definitions/Element"
},
"productStatus": {
"description": "Whether the product is currently available.",
"$ref": "#/definitions/Coding"
},
"expirationDate": {
"description": "Date, and where relevant time, of expiration.",
"$ref": "#/definitions/dateTime"
},
"_expirationDate": {
"description": "Extensions for expirationDate",
"$ref": "#/definitions/Element"
},
"collection": {
"description": "How this product was collected.",
"$ref": "#/definitions/BiologicallyDerivedProduct_Collection"
},
"storageTempRequirements": {
"description": "The temperature requirements for storage of the biologically-derived product.",
"$ref": "#/definitions/Range"
},
"property": {
"description": "A property that is specific to this BiologicallyDerviedProduct instance.",
"items": {
"$ref": "#/definitions/BiologicallyDerivedProduct_Property"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"BiologicallyDerivedProduct_Collection": {
"description": "This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"collector": {
"description": "Healthcare professional who is performing the collection.",
"$ref": "#/definitions/Reference"
},
"source": {
"description": "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.",
"$ref": "#/definitions/Reference"
},
"collectedDateTime": {
"description": "Time of product collection.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_collectedDateTime": {
"description": "Extensions for collectedDateTime",
"$ref": "#/definitions/Element"
},
"collectedPeriod": {
"description": "Time of product collection.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false
},
"BiologicallyDerivedProduct_Property": {
"description": "This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Code that specifies the property. It should reference an established coding system.",
"$ref": "#/definitions/CodeableConcept"
},
"valueBoolean": {
"description": "Property values.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "#/definitions/Element"
},
"valueInteger": {
"description": "Property values.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "#/definitions/Element"
},
"valueCodeableConcept": {
"description": "Property values.",
"$ref": "#/definitions/CodeableConcept"
},
"valuePeriod": {
"description": "Property values.",
"$ref": "#/definitions/Period"
},
"valueQuantity": {
"description": "Property values.",
"$ref": "#/definitions/Quantity"
},
"valueRange": {
"description": "Property values.",
"$ref": "#/definitions/Range"
},
"valueRatio": {
"description": "Property values.",
"$ref": "#/definitions/Ratio"
},
"valueString": {
"description": "Property values.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "#/definitions/Element"
},
"valueAttachment": {
"description": "Property values.",
"$ref": "#/definitions/Attachment"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"BiologicallyDerivedProductDispense": {
"description": "This resource reflects an instance of a biologically derived product dispense. The supply or dispense of a biologically derived product from the supply organization or department (e.g. hospital transfusion laboratory) to the clinical team responsible for clinical application.",
"properties": {
"resourceType": {
"description": "This is a BiologicallyDerivedProductDispense resource",
"const": "BiologicallyDerivedProductDispense"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"basedOn": {
"description": "The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"partOf": {
"description": "A larger event of which this particular event is a component.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "A code specifying the state of the dispense event.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"originRelationshipType": {
"description": "Indicates the relationship between the donor of the biologically derived product and the intended recipient.",
"$ref": "#/definitions/CodeableConcept"
},
"product": {
"description": "A link to a resource identifying the biologically derived product that is being dispensed.",
"$ref": "#/definitions/Reference"
},
"patient": {
"description": "A link to a resource representing the patient that the product is dispensed for.",
"$ref": "#/definitions/Reference"
},
"matchStatus": {
"description": "Indicates the type of matching associated with the dispense.",
"$ref": "#/definitions/CodeableConcept"
},
"performer": {
"description": "Indicates who or what performed an action.",
"items": {
"$ref": "#/definitions/BiologicallyDerivedProductDispense_Performer"
},
"type": "array"
},
"location": {
"description": "The physical location where the dispense was performed.",
"$ref": "#/definitions/Reference"
},
"quantity": {
"description": "The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration.",
"$ref": "#/definitions/Quantity"
},
"preparedDate": {
"description": "When the product was selected/ matched.",
"$ref": "#/definitions/dateTime"
},
"_preparedDate": {
"description": "Extensions for preparedDate",
"$ref": "#/definitions/Element"
},
"whenHandedOver": {
"description": "When the product was dispatched for clinical use.",
"$ref": "#/definitions/dateTime"
},
"_whenHandedOver": {
"description": "Extensions for whenHandedOver",
"$ref": "#/definitions/Element"
},
"destination": {
"description": "Link to a resource identifying the physical location that the product was dispatched to.",
"$ref": "#/definitions/Reference"
},
"note": {
"description": "Additional notes.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
},
"usageInstruction": {
"description": "Specific instructions for use.",
"$ref": "#/definitions/string"
},
"_usageInstruction": {
"description": "Extensions for usageInstruction",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"product",
"patient",
"resourceType"
]
},
"BiologicallyDerivedProductDispense_Performer": {
"description": "This resource reflects an instance of a biologically derived product dispense. The supply or dispense of a biologically derived product from the supply organization or department (e.g. hospital transfusion laboratory) to the clinical team responsible for clinical application.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Identifies the function of the performer during the dispense.",
"$ref": "#/definitions/CodeableConcept"
},
"actor": {
"description": "Identifies the person responsible for the action.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"actor"
]
},
"BodyStructure": {
"description": "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"properties": {
"resourceType": {
"description": "This is a BodyStructure resource",
"const": "BodyStructure"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Identifier for this instance of the anatomical structure.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"active": {
"description": "Whether this body site is in active use.",
"$ref": "#/definitions/boolean"
},
"_active": {
"description": "Extensions for active",
"$ref": "#/definitions/Element"
},
"morphology": {
"description": "The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.",
"$ref": "#/definitions/CodeableConcept"
},
"includedStructure": {
"description": "The anatomical location(s) or region(s) of the specimen, lesion, or body structure.",
"items": {
"$ref": "#/definitions/BodyStructure_IncludedStructure"
},
"type": "array"
},
"excludedStructure": {
"description": "The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.",
"items": {
"$ref": "#/definitions/BodyStructure_IncludedStructure"
},
"type": "array"
},
"description": {
"description": "A summary, characterization or explanation of the body structure.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"image": {
"description": "Image or images used to identify a location.",
"items": {
"$ref": "#/definitions/Attachment"
},
"type": "array"
},
"patient": {
"description": "The person to which the body site belongs.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"includedStructure",
"patient",
"resourceType"
]
},
"BodyStructure_IncludedStructure": {
"description": "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"structure": {
"description": "Code that represents the included structure.",
"$ref": "#/definitions/CodeableConcept"
},
"laterality": {
"description": "Code that represents the included structure laterality.",
"$ref": "#/definitions/CodeableConcept"
},
"bodyLandmarkOrientation": {
"description": "Body locations in relation to a specific body landmark (tatoo, scar, other body structure).",
"items": {
"$ref": "#/definitions/BodyStructure_BodyLandmarkOrientation"
},
"type": "array"
},
"spatialReference": {
"description": "XY or XYZ-coordinate orientation for structure.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"qualifier": {
"description": "Code that represents the included structure qualifier.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"structure"
]
},
"BodyStructure_BodyLandmarkOrientation": {
"description": "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"landmarkDescription": {
"description": "A description of a landmark on the body used as a reference to locate something else.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"clockFacePosition": {
"description": "An description of the direction away from a landmark something is located based on a radial clock dial.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"distanceFromLandmark": {
"description": "The distance in centimeters a certain observation is made from a body landmark.",
"items": {
"$ref": "#/definitions/BodyStructure_DistanceFromLandmark"
},
"type": "array"
},
"surfaceOrientation": {
"description": "The surface area a body location is in relation to a landmark.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"BodyStructure_DistanceFromLandmark": {
"description": "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"device": {
"description": "An instrument, tool, analyzer, etc. used in the measurement.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"value": {
"description": "The measured distance (e.g., in cm) from a body landmark.",
"items": {
"$ref": "#/definitions/Quantity"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Bundle": {
"description": "A container for a collection of resources.",
"properties": {
"resourceType": {
"description": "This is a Bundle resource",
"const": "Bundle"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "A persistent identifier for the bundle that won\u0027t change as a bundle is copied from server to server.",
"$ref": "#/definitions/Identifier"
},
"type": {
"description": "Indicates the purpose of this bundle - how it is intended to be used.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"timestamp": {
"description": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"$ref": "#/definitions/instant"
},
"_timestamp": {
"description": "Extensions for timestamp",
"$ref": "#/definitions/Element"
},
"total": {
"description": "If a set of search matches, this is the (potentially estimated) total number of entries of type \u0027match\u0027 across all pages in the search. It does not include search.mode \u003d \u0027include\u0027 or \u0027outcome\u0027 entries and it does not provide a count of the number of entries in the Bundle.",
"$ref": "#/definitions/unsignedInt"
},
"_total": {
"description": "Extensions for total",
"$ref": "#/definitions/Element"
},
"link": {
"description": "A series of links that provide context to this bundle.",
"items": {
"$ref": "#/definitions/Bundle_Link"
},
"type": "array"
},
"entry": {
"description": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
"items": {
"$ref": "#/definitions/Bundle_Entry"
},
"type": "array"
},
"signature": {
"description": "Digital Signature - base64 encoded. XML-DSig or a JWS.",
"$ref": "#/definitions/Signature"
},
"issues": {
"description": "Captures issues and warnings that relate to the construction of the Bundle and the content within it.",
"$ref": "#/definitions/ResourceList"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Bundle_Link": {
"description": "A container for a collection of resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"relation": {
"description": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
"$ref": "#/definitions/code"
},
"_relation": {
"description": "Extensions for relation",
"$ref": "#/definitions/Element"
},
"url": {
"description": "The reference details for the link.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Bundle_Entry": {
"description": "A container for a collection of resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"link": {
"description": "A series of links that provide context to this entry.",
"items": {
"$ref": "#/definitions/Bundle_Link"
},
"type": "array"
},
"fullUrl": {
"description": "The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: \n* invoking a create\n* invoking or responding to an operation where the body is not a single identified resource\n* invoking or returning the results of a search or history operation.",
"$ref": "#/definitions/uri"
},
"_fullUrl": {
"description": "Extensions for fullUrl",
"$ref": "#/definitions/Element"
},
"resource": {
"description": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.",
"$ref": "#/definitions/ResourceList"
},
"search": {
"description": "Information about the search process that lead to the creation of this entry.",
"$ref": "#/definitions/Bundle_Search"
},
"request": {
"description": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.",
"$ref": "#/definitions/Bundle_Request"
},
"response": {
"description": "Indicates the results of processing the corresponding \u0027request\u0027 entry in the batch or transaction being responded to or what the results of an operation where when returning history.",
"$ref": "#/definitions/Bundle_Response"
}
},
"type": "object",
"additionalProperties": false
},
"Bundle_Search": {
"description": "A container for a collection of resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "Why this entry is in the result set - whether it\u0027s included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"$ref": "#/definitions/code"
},
"_mode": {
"description": "Extensions for mode",
"$ref": "#/definitions/Element"
},
"score": {
"description": "When searching, the server\u0027s search ranking score for the entry.",
"$ref": "#/definitions/decimal"
},
"_score": {
"description": "Extensions for score",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Bundle_Request": {
"description": "A container for a collection of resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"method": {
"description": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.",
"$ref": "#/definitions/code"
},
"_method": {
"description": "Extensions for method",
"$ref": "#/definitions/Element"
},
"url": {
"description": "The URL for this entry, relative to the root (the address to which the request is posted).",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"ifNoneMatch": {
"description": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"$ref": "#/definitions/string"
},
"_ifNoneMatch": {
"description": "Extensions for ifNoneMatch",
"$ref": "#/definitions/Element"
},
"ifModifiedSince": {
"description": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"$ref": "#/definitions/instant"
},
"_ifModifiedSince": {
"description": "Extensions for ifModifiedSince",
"$ref": "#/definitions/Element"
},
"ifMatch": {
"description": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
"$ref": "#/definitions/string"
},
"_ifMatch": {
"description": "Extensions for ifMatch",
"$ref": "#/definitions/Element"
},
"ifNoneExist": {
"description": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"$ref": "#/definitions/string"
},
"_ifNoneExist": {
"description": "Extensions for ifNoneExist",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Bundle_Response": {
"description": "A container for a collection of resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"status": {
"description": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"$ref": "#/definitions/string"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"location": {
"description": "The location header created by processing this operation, populated if the operation returns a location.",
"$ref": "#/definitions/uri"
},
"_location": {
"description": "Extensions for location",
"$ref": "#/definitions/Element"
},
"etag": {
"description": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
"$ref": "#/definitions/string"
},
"_etag": {
"description": "Extensions for etag",
"$ref": "#/definitions/Element"
},
"lastModified": {
"description": "The date/time that the resource was modified on the server.",
"$ref": "#/definitions/instant"
},
"_lastModified": {
"description": "Extensions for lastModified",
"$ref": "#/definitions/Element"
},
"outcome": {
"description": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"$ref": "#/definitions/ResourceList"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"resourceType": {
"description": "This is a CapabilityStatement resource",
"const": "CapabilityStatement"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the capability statement.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"status": {
"description": "The status of this capability statement. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the capability statement.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the capability statement from a consumer\u0027s 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.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the capability statement is intended to be used.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this capability statement is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "#/definitions/Element"
},
"kind": {
"description": "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).",
"$ref": "#/definitions/code"
},
"_kind": {
"description": "Extensions for kind",
"$ref": "#/definitions/Element"
},
"instantiates": {
"description": "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.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"imports": {
"description": "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.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"software": {
"description": "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.",
"$ref": "#/definitions/CapabilityStatement_Software"
},
"implementation": {
"description": "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.",
"$ref": "#/definitions/CapabilityStatement_Implementation"
},
"fhirVersion": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_fhirVersion": {
"description": "Extensions for fhirVersion",
"$ref": "#/definitions/Element"
},
"format": {
"description": "A list of the formats supported by this implementation using their content types.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_format": {
"description": "Extensions for format",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"patchFormat": {
"description": "A list of the patch formats supported by this implementation using their content types.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_patchFormat": {
"description": "Extensions for patchFormat",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"acceptLanguage": {
"description": "A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` header.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_acceptLanguage": {
"description": "Extensions for acceptLanguage",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"implementationGuide": {
"description": "A list of implementation guides that the server does (or should) support in their entirety.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"rest": {
"description": "A definition of the restful capabilities of the solution, if any.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Rest"
},
"type": "array"
},
"messaging": {
"description": "A description of the messaging capabilities of the solution.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Messaging"
},
"type": "array"
},
"document": {
"description": "A document definition.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Document"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"CapabilityStatement_Software": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "Name the software is known by.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"version": {
"description": "The version identifier for the software covered by this statement.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"releaseDate": {
"description": "Date this version of the software was released.",
"$ref": "#/definitions/dateTime"
},
"_releaseDate": {
"description": "Extensions for releaseDate",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Implementation": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "Information about the specific installation that this capability statement relates to.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"url": {
"description": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"$ref": "#/definitions/url"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"custodian": {
"description": "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Rest": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.",
"$ref": "#/definitions/code"
},
"_mode": {
"description": "Extensions for mode",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "Information about the system\u0027s restful capabilities that apply across all applications, such as security.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"security": {
"description": "Information about security implementation from an interface perspective - what a client needs to know.",
"$ref": "#/definitions/CapabilityStatement_Security"
},
"resource": {
"description": "A specification of the restful capabilities of the solution for a specific resource type.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Resource"
},
"type": "array"
},
"interaction": {
"description": "A specification of restful operations supported by the system.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Interaction1"
},
"type": "array"
},
"searchParam": {
"description": "Search parameters that are supported for searching all resources 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. This is only for searches executed against the system-level endpoint.",
"items": {
"$ref": "#/definitions/CapabilityStatement_SearchParam"
},
"type": "array"
},
"operation": {
"description": "Definition of an operation or a named query together with its parameters and their meaning and type.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Operation"
},
"type": "array"
},
"compartment": {
"description": "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 .",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Security": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"cors": {
"description": "Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.",
"$ref": "#/definitions/boolean"
},
"_cors": {
"description": "Extensions for cors",
"$ref": "#/definitions/Element"
},
"service": {
"description": "Types of security services that are supported/required by the system.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"description": {
"description": "General description of how security works.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Resource": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "A type of resource exposed via the restful interface.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "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](profiling.html#profile-uses).",
"$ref": "#/definitions/canonical"
},
"supportedProfile": {
"description": "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](profiling.html#profile-uses).",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"documentation": {
"description": "Additional information about the resource type used by the system.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"interaction": {
"description": "Identifies a restful operation supported by the solution.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Interaction"
},
"type": "array"
},
"versioning": {
"description": "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 \u0027versioned-update\u0027, then the server supports all the versioning features, including using e-tags for version integrity in the API.",
"$ref": "#/definitions/code"
},
"_versioning": {
"description": "Extensions for versioning",
"$ref": "#/definitions/Element"
},
"readHistory": {
"description": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"$ref": "#/definitions/boolean"
},
"_readHistory": {
"description": "Extensions for readHistory",
"$ref": "#/definitions/Element"
},
"updateCreate": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_updateCreate": {
"description": "Extensions for updateCreate",
"$ref": "#/definitions/Element"
},
"conditionalCreate": {
"description": "A flag that indicates that the server supports conditional create.",
"$ref": "#/definitions/boolean"
},
"_conditionalCreate": {
"description": "Extensions for conditionalCreate",
"$ref": "#/definitions/Element"
},
"conditionalRead": {
"description": "A code that indicates how the server supports conditional read.",
"$ref": "#/definitions/code"
},
"_conditionalRead": {
"description": "Extensions for conditionalRead",
"$ref": "#/definitions/Element"
},
"conditionalUpdate": {
"description": "A flag that indicates that the server supports conditional update.",
"$ref": "#/definitions/boolean"
},
"_conditionalUpdate": {
"description": "Extensions for conditionalUpdate",
"$ref": "#/definitions/Element"
},
"conditionalPatch": {
"description": "A flag that indicates that the server supports conditional patch.",
"$ref": "#/definitions/boolean"
},
"_conditionalPatch": {
"description": "Extensions for conditionalPatch",
"$ref": "#/definitions/Element"
},
"conditionalDelete": {
"description": "A code that indicates how the server supports conditional delete.",
"$ref": "#/definitions/code"
},
"_conditionalDelete": {
"description": "Extensions for conditionalDelete",
"$ref": "#/definitions/Element"
},
"referencePolicy": {
"description": "A set of flags that defines how references are supported.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_referencePolicy": {
"description": "Extensions for referencePolicy",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"searchInclude": {
"description": "A list of _include values supported by the server.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_searchInclude": {
"description": "Extensions for searchInclude",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"searchRevInclude": {
"description": "A list of _revinclude (reverse include) values supported by the server.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_searchRevInclude": {
"description": "Extensions for searchRevInclude",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"searchParam": {
"description": "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.",
"items": {
"$ref": "#/definitions/CapabilityStatement_SearchParam"
},
"type": "array"
},
"operation": {
"description": "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.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Operation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Interaction": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Coded identifier of the operation, supported by the system resource.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "Guidance specific to the implementation of this operation, such as \u0027delete is a logical delete\u0027 or \u0027updates are only allowed with version id\u0027 or \u0027creates permitted from pre-authorized certificates only\u0027.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_SearchParam": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The label used for the search parameter in this particular system\u0027s API - i.e. the \u0027name\u0027 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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"definition": {
"description": "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](searchparameter-definitions.html#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.",
"$ref": "#/definitions/canonical"
},
"type": {
"description": "The type of value a search parameter refers to, and how the content is interpreted.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Operation": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"definition": {
"description": "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](operationdefinition.html#) with a \u0027base\u0027 of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.",
"$ref": "#/definitions/canonical"
},
"documentation": {
"description": "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"definition"
]
},
"CapabilityStatement_Interaction1": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A coded identifier of the operation, supported by the system.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Messaging": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"endpoint": {
"description": "An endpoint (network accessible address) to which messages and/or replies are to be sent.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Endpoint"
},
"type": "array"
},
"reliableCache": {
"description": "Length if the receiver\u0027s reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"$ref": "#/definitions/unsignedInt"
},
"_reliableCache": {
"description": "Extensions for reliableCache",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "Documentation about the system\u0027s messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"supportedMessage": {
"description": "References to message definitions for messages this system can send or receive.",
"items": {
"$ref": "#/definitions/CapabilityStatement_SupportedMessage"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"CapabilityStatement_Endpoint": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"protocol": {
"description": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"$ref": "#/definitions/Coding"
},
"address": {
"description": "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.",
"$ref": "#/definitions/url"
},
"_address": {
"description": "Extensions for address",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"protocol"
]
},
"CapabilityStatement_SupportedMessage": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "The mode of this event declaration - whether application is sender or receiver.",
"$ref": "#/definitions/code"
},
"_mode": {
"description": "Extensions for mode",
"$ref": "#/definitions/Element"
},
"definition": {
"description": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.",
"$ref": "#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"definition"
]
},
"CapabilityStatement_Document": {
"description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "Mode of this document declaration - whether an application is a producer or consumer.",
"$ref": "#/definitions/code"
},
"_mode": {
"description": "Extensions for mode",
"$ref": "#/definitions/Element"
},
"documentation": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "#/definitions/Element"
},
"profile": {
"description": "A profile on the document Bundle that constrains which resources are present, and their contents.",
"$ref": "#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"profile"
]
},
"CarePlan": {
"description": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"properties": {
"resourceType": {
"description": "This is a CarePlan resource",
"const": "CarePlan"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"instantiatesCanonical": {
"description": "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.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"instantiatesUri": {
"description": "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.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiatesUri": {
"description": "Extensions for instantiatesUri",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"basedOn": {
"description": "A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"replaces": {
"description": "Completed or terminated care plan whose function is taken by this new care plan.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"partOf": {
"description": "A larger care plan of which this particular care plan is a component or step.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"intent": {
"description": "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.",
"$ref": "#/definitions/code"
},
"_intent": {
"description": "Extensions for intent",
"$ref": "#/definitions/Element"
},
"category": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"title": {
"description": "Human-friendly name for the care plan.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"description": {
"description": "A description of the scope and nature of the plan.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"subject": {
"description": "Identifies the patient or group whose intended care is described by the plan.",
"$ref": "#/definitions/Reference"
},
"encounter": {
"description": "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.",
"$ref": "#/definitions/Reference"
},
"period": {
"description": "Indicates when the plan did (or is intended to) come into effect and end.",
"$ref": "#/definitions/Period"
},
"created": {
"description": "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.",
"$ref": "#/definitions/dateTime"
},
"_created": {
"description": "Extensions for created",
"$ref": "#/definitions/Element"
},
"custodian": {
"description": "When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.",
"$ref": "#/definitions/Reference"
},
"contributor": {
"description": "Identifies the individual(s), organization or device who provided the contents of the care plan.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"careTeam": {
"description": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"addresses": {
"description": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"supportingInfo": {
"description": "Identifies portions of the patient\u0027s record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"goal": {
"description": "Describes the intended objective(s) of carrying out the care plan.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"activity": {
"description": "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.",
"items": {
"$ref": "#/definitions/CarePlan_Activity"
},
"type": "array"
},
"note": {
"description": "General notes about the care plan not covered elsewhere.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"subject",
"resourceType"
]
},
"CarePlan_Activity": {
"description": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"performedActivity": {
"description": "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).",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"progress": {
"description": "Notes about the adherence/status/progress of the activity.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
},
"plannedActivityReference": {
"description": "The details of the proposed activity represented in a specific resource.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"CareTeam": {
"description": "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care.",
"properties": {
"resourceType": {
"description": "This is a CareTeam resource",
"const": "CareTeam"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "Indicates the current state of the care team.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"category": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"name": {
"description": "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"subject": {
"description": "Identifies the patient or group whose intended care is handled by the team.",
"$ref": "#/definitions/Reference"
},
"period": {
"description": "Indicates when the team did (or is intended to) come into effect and end.",
"$ref": "#/definitions/Period"
},
"participant": {
"description": "Identifies all people and organizations who are expected to be involved in the care team.",
"items": {
"$ref": "#/definitions/CareTeam_Participant"
},
"type": "array"
},
"reason": {
"description": "Describes why the care team exists.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"managingOrganization": {
"description": "The organization responsible for the care team.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"telecom": {
"description": "A central contact detail for the care team (that applies to all members).",
"items": {
"$ref": "#/definitions/ContactPoint"
},
"type": "array"
},
"note": {
"description": "Comments made about the CareTeam.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"CareTeam_Participant": {
"description": "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"role": {
"description": "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.",
"$ref": "#/definitions/CodeableConcept"
},
"member": {
"description": "The specific person or organization who is participating/expected to participate in the care team.",
"$ref": "#/definitions/Reference"
},
"onBehalfOf": {
"description": "The organization of the practitioner.",
"$ref": "#/definitions/Reference"
},
"coveragePeriod": {
"description": "When the member is generally available within this care team.",
"$ref": "#/definitions/Period"
},
"coverageTiming": {
"description": "When the member is generally available within this care team.",
"$ref": "#/definitions/Timing"
}
},
"type": "object",
"additionalProperties": false
},
"ChargeItem": {
"description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
"properties": {
"resourceType": {
"description": "This is a ChargeItem resource",
"const": "ChargeItem"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Identifiers assigned to this event performer or other systems.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"definitionUri": {
"description": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_definitionUri": {
"description": "Extensions for definitionUri",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"definitionCanonical": {
"description": "References the source of pricing information, rules of application for the code this ChargeItem uses.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"status": {
"description": "The current state of the ChargeItem.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"partOf": {
"description": "ChargeItems can be grouped to larger ChargeItems covering the whole set.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"code": {
"description": "A code that identifies the charge, like a billing code.",
"$ref": "#/definitions/CodeableConcept"
},
"subject": {
"description": "The individual or set of individuals the action is being or was performed on.",
"$ref": "#/definitions/Reference"
},
"encounter": {
"description": "This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.",
"$ref": "#/definitions/Reference"
},
"occurrenceDateTime": {
"description": "Date/time(s) or duration when the charged service was applied.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_occurrenceDateTime": {
"description": "Extensions for occurrenceDateTime",
"$ref": "#/definitions/Element"
},
"occurrencePeriod": {
"description": "Date/time(s) or duration when the charged service was applied.",
"$ref": "#/definitions/Period"
},
"occurrenceTiming": {
"description": "Date/time(s) or duration when the charged service was applied.",
"$ref": "#/definitions/Timing"
},
"performer": {
"description": "Indicates who or what performed or participated in the charged service.",
"items": {
"$ref": "#/definitions/ChargeItem_Performer"
},
"type": "array"
},
"performingOrganization": {
"description": "The organization performing the service.",
"$ref": "#/definitions/Reference"
},
"requestingOrganization": {
"description": "The organization requesting the service.",
"$ref": "#/definitions/Reference"
},
"costCenter": {
"description": "The financial cost center permits the tracking of charge attribution.",
"$ref": "#/definitions/Reference"
},
"quantity": {
"description": "Quantity of which the charge item has been serviced.",
"$ref": "#/definitions/Quantity"
},
"bodysite": {
"description": "The anatomical location where the related service has been applied.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"unitPriceComponent": {
"description": "The unit price of the chargable item.",
"$ref": "#/definitions/MonetaryComponent"
},
"totalPriceComponent": {
"description": "The total price for the chargable item, accounting for the quantity.",
"$ref": "#/definitions/MonetaryComponent"
},
"overrideReason": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"enterer": {
"description": "The device, practitioner, etc. who entered the charge item.",
"$ref": "#/definitions/Reference"
},
"enteredDate": {
"description": "Date the charge item was entered.",
"$ref": "#/definitions/dateTime"
},
"_enteredDate": {
"description": "Extensions for enteredDate",
"$ref": "#/definitions/Element"
},
"reason": {
"description": "Describes why the event occurred in coded or textual form.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"service": {
"description": "Indicated the rendered service that caused this charge.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"product": {
"description": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.",
"items": {
"$ref": "#/definitions/CodeableReference"
},
"type": "array"
},
"account": {
"description": "Account into which this ChargeItems belongs.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"note": {
"description": "Comments made about the event by the performer, subject or other participants.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
},
"supportingInformation": {
"description": "Further information supporting this charge.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code",
"subject",
"resourceType"
]
},
"ChargeItem_Performer": {
"description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).",
"$ref": "#/definitions/CodeableConcept"
},
"actor": {
"description": "The device, practitioner, etc. who performed or participated in the service.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"actor"
]
},
"ChargeItemDefinition": {
"description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.",
"properties": {
"resourceType": {
"description": "This is a ChargeItemDefinition resource",
"const": "ChargeItemDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the charge item definition.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"status": {
"description": "The current state of the ChargeItemDefinition.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the charge item definition.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the charge item definition from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the charge item definition is intended to be used.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this charge item definition is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the {{title}} content was or is planned to be in active use.",
"$ref": "#/definitions/Period"
},
"topic": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the {{title}}.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the {{title}}.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"items": {
"$ref": "#/definitions/RelatedArtifact"
},
"type": "array"
},
"derivedFromUri": {
"description": "The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_derivedFromUri": {
"description": "Extensions for derivedFromUri",
"items": {
"$ref": "#/definitions/Element"
},
"type": "array"
},
"partOf": {
"description": "A larger definition of which this particular definition is a component or step.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"replaces": {
"description": "As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.",
"items": {
"$ref": "#/definitions/canonical"
},
"type": "array"
},
"code": {
"description": "The defined billing details in this resource pertain to the given billing code.",
"$ref": "#/definitions/CodeableConcept"
},
"instance": {
"description": "The defined billing details in this resource pertain to the given product instance(s).",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"applicability": {
"description": "Expressions that describe applicability criteria for the billing code.",
"items": {
"$ref": "#/definitions/ChargeItemDefinition_Applicability"
},
"type": "array"
},
"propertyGroup": {
"description": "Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.",
"items": {
"$ref": "#/definitions/ChargeItemDefinition_PropertyGroup"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"ChargeItemDefinition_Applicability": {
"description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"condition": {
"description": "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.",
"$ref": "#/definitions/Expression"
},
"effectivePeriod": {
"description": "The period during which the charge item definition content was or is planned to be in active use.",
"$ref": "#/definitions/Period"
},
"relatedArtifact": {
"description": "Reference to / quotation of the external source of the group of properties.",
"$ref": "#/definitions/RelatedArtifact"
}
},
"type": "object",
"additionalProperties": false
},
"ChargeItemDefinition_PropertyGroup": {
"description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"applicability": {
"description": "Expressions that describe applicability criteria for the priceComponent.",
"items": {
"$ref": "#/definitions/ChargeItemDefinition_Applicability"
},
"type": "array"
},
"priceComponent": {
"description": "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.",
"items": {
"$ref": "#/definitions/MonetaryComponent"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Citation": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"resourceType": {
"description": "This is a Citation resource",
"const": "Citation"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the citation record.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"status": {
"description": "The status of this summary. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual that published the citation record.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the citation from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the citation record is intended to be used.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this citation is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "Use and/or publishing restrictions for the citation record, not for the cited artifact.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the citation record content was or is planned to be in active use.",
"$ref": "#/definitions/Period"
},
"topic": {
"description": "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.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "Who authored or created the citation record.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "Who edited or revised the citation record.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "Who reviewed the citation record.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "Who endorsed the citation record.",
"items": {
"$ref": "#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Artifact related to the citation record.",
"items": {
"$ref": "#/definitions/RelatedArtifact"
},
"type": "array"
},
"summary": {
"description": "A human-readable display of key concepts to represent the citation.",
"items": {
"$ref": "#/definitions/Citation_Summary"
},
"type": "array"
},
"classification": {
"description": "The assignment to an organizing scheme.",
"items": {
"$ref": "#/definitions/Citation_Classification"
},
"type": "array"
},
"note": {
"description": "Used for general notes and annotations not coded elsewhere.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
},
"currentState": {
"description": "The status of the citation record.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"statusDate": {
"description": "The state or status of the citation record paired with an effective date or period for that state.",
"items": {
"$ref": "#/definitions/Citation_StatusDate"
},
"type": "array"
},
"citedArtifact": {
"description": "The article or artifact being described.",
"$ref": "#/definitions/Citation_CitedArtifact"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Citation_Summary": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"style": {
"description": "Format for display of the citation summary.",
"$ref": "#/definitions/CodeableConcept"
},
"text": {
"description": "The human-readable display of the citation summary.",
"$ref": "#/definitions/markdown"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Classification": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The kind of classifier (e.g. publication type, keyword).",
"$ref": "#/definitions/CodeableConcept"
},
"classifier": {
"description": "The specific classification value.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_StatusDate": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"activity": {
"description": "The state or status of the citation record (that will be paired with the period).",
"$ref": "#/definitions/CodeableConcept"
},
"actual": {
"description": "Whether the status date is actual (has occurred) or expected (estimated or anticipated).",
"$ref": "#/definitions/boolean"
},
"_actual": {
"description": "Extensions for actual",
"$ref": "#/definitions/Element"
},
"period": {
"description": "When the status started and/or ended.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"period",
"activity"
]
},
"Citation_CitedArtifact": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"relatedIdentifier": {
"description": "A formal identifier that is used to identify things closely related to the cited artifact.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"dateAccessed": {
"description": "When the cited artifact was accessed.",
"$ref": "#/definitions/dateTime"
},
"_dateAccessed": {
"description": "Extensions for dateAccessed",
"$ref": "#/definitions/Element"
},
"version": {
"description": "The defined version of the cited artifact.",
"$ref": "#/definitions/Citation_Version"
},
"currentState": {
"description": "The status of the cited artifact.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"statusDate": {
"description": "An effective date or period, historical or future, actual or expected, for a status of the cited artifact.",
"items": {
"$ref": "#/definitions/Citation_StatusDate1"
},
"type": "array"
},
"title": {
"description": "The title details of the article or artifact.",
"items": {
"$ref": "#/definitions/Citation_Title"
},
"type": "array"
},
"abstract": {
"description": "The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.",
"items": {
"$ref": "#/definitions/Citation_Abstract"
},
"type": "array"
},
"part": {
"description": "The component of the article or artifact.",
"$ref": "#/definitions/Citation_Part"
},
"relatesTo": {
"description": "The artifact related to the cited artifact.",
"items": {
"$ref": "#/definitions/Citation_RelatesTo"
},
"type": "array"
},
"publicationForm": {
"description": "If multiple, used to represent alternative forms of the article that are not separate citations.",
"items": {
"$ref": "#/definitions/Citation_PublicationForm"
},
"type": "array"
},
"webLocation": {
"description": "Used for any URL for the article or artifact cited.",
"items": {
"$ref": "#/definitions/Citation_WebLocation"
},
"type": "array"
},
"classification": {
"description": "The assignment to an organizing scheme.",
"items": {
"$ref": "#/definitions/Citation_Classification1"
},
"type": "array"
},
"contributorship": {
"description": "This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.",
"$ref": "#/definitions/Citation_Contributorship"
},
"note": {
"description": "Any additional information or content for the article or artifact.",
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Version": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"value": {
"description": "The version number or other version identifier.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"baseCitation": {
"description": "Citation for the main version of the cited artifact.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_StatusDate1": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"activity": {
"description": "A definition of the status associated with a date or period.",
"$ref": "#/definitions/CodeableConcept"
},
"actual": {
"description": "Either occurred or expected.",
"$ref": "#/definitions/boolean"
},
"_actual": {
"description": "Extensions for actual",
"$ref": "#/definitions/Element"
},
"period": {
"description": "When the status started and/or ended.",
"$ref": "#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"period",
"activity"
]
},
"Citation_Title": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Used to express the reason for or classification of the title.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"language": {
"description": "Used to express the specific language of the title.",
"$ref": "#/definitions/CodeableConcept"
},
"text": {
"description": "The title of the article or artifact.",
"$ref": "#/definitions/markdown"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Abstract": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Used to express the reason for or classification of the abstract.",
"$ref": "#/definitions/CodeableConcept"
},
"language": {
"description": "Used to express the specific language of the abstract.",
"$ref": "#/definitions/CodeableConcept"
},
"text": {
"description": "Abstract content.",
"$ref": "#/definitions/markdown"
},
"_text": {
"description": "Extensions for text",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "Copyright notice for the abstract.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Part": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The kind of component.",
"$ref": "#/definitions/CodeableConcept"
},
"value": {
"description": "The specification of the component.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
},
"baseCitation": {
"description": "The citation for the full article or artifact.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_RelatesTo": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of relationship to the related artifact.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "#/definitions/Element"
},
"classifier": {
"description": "Provides additional classifiers of the related artifact.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"label": {
"description": "A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "#/definitions/Element"
},
"display": {
"description": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "#/definitions/Element"
},
"citation": {
"description": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"$ref": "#/definitions/markdown"
},
"_citation": {
"description": "Extensions for citation",
"$ref": "#/definitions/Element"
},
"document": {
"description": "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.",
"$ref": "#/definitions/Attachment"
},
"resource": {
"description": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"$ref": "#/definitions/canonical"
},
"_resource": {
"description": "Extensions for resource",
"$ref": "#/definitions/Element"
},
"resourceReference": {
"description": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"$ref": "#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_PublicationForm": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"publishedIn": {
"description": "The collection the cited article or artifact is published in.",
"$ref": "#/definitions/Citation_PublishedIn"
},
"citedMedium": {
"description": "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.",
"$ref": "#/definitions/CodeableConcept"
},
"volume": {
"description": "Volume number of journal or other collection in which the article is published.",
"$ref": "#/definitions/string"
},
"_volume": {
"description": "Extensions for volume",
"$ref": "#/definitions/Element"
},
"issue": {
"description": "Issue, part or supplement of journal or other collection in which the article is published.",
"$ref": "#/definitions/string"
},
"_issue": {
"description": "Extensions for issue",
"$ref": "#/definitions/Element"
},
"articleDate": {
"description": "The date the article was added to the database, or the date the article was released.",
"$ref": "#/definitions/dateTime"
},
"_articleDate": {
"description": "Extensions for articleDate",
"$ref": "#/definitions/Element"
},
"publicationDateText": {
"description": "Text representation of the date on which the issue of the cited artifact was published.",
"$ref": "#/definitions/string"
},
"_publicationDateText": {
"description": "Extensions for publicationDateText",
"$ref": "#/definitions/Element"
},
"publicationDateSeason": {
"description": "Spring, Summer, Fall/Autumn, Winter.",
"$ref": "#/definitions/string"
},
"_publicationDateSeason": {
"description": "Extensions for publicationDateSeason",
"$ref": "#/definitions/Element"
},
"lastRevisionDate": {
"description": "The date the article was last revised or updated in the database.",
"$ref": "#/definitions/dateTime"
},
"_lastRevisionDate": {
"description": "Extensions for lastRevisionDate",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The language or languages in which this form of the article is published.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"accessionNumber": {
"description": "Entry number or identifier for inclusion in a database.",
"$ref": "#/definitions/string"
},
"_accessionNumber": {
"description": "Extensions for accessionNumber",
"$ref": "#/definitions/Element"
},
"pageString": {
"description": "Used for full display of pagination.",
"$ref": "#/definitions/string"
},
"_pageString": {
"description": "Extensions for pageString",
"$ref": "#/definitions/Element"
},
"firstPage": {
"description": "Used for isolated representation of first page.",
"$ref": "#/definitions/string"
},
"_firstPage": {
"description": "Extensions for firstPage",
"$ref": "#/definitions/Element"
},
"lastPage": {
"description": "Used for isolated representation of last page.",
"$ref": "#/definitions/string"
},
"_lastPage": {
"description": "Extensions for lastPage",
"$ref": "#/definitions/Element"
},
"pageCount": {
"description": "Actual or approximate number of pages or screens. Distinct from reporting the page numbers.",
"$ref": "#/definitions/string"
},
"_pageCount": {
"description": "Extensions for pageCount",
"$ref": "#/definitions/Element"
},
"copyright": {
"description": "Copyright notice for the full article or artifact.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_PublishedIn": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Kind of container (e.g. Periodical, database, or book).",
"$ref": "#/definitions/CodeableConcept"
},
"identifier": {
"description": "Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"title": {
"description": "Name of the database or title of the book or journal.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "#/definitions/Element"
},
"publisher": {
"description": "Name of or resource describing the publisher.",
"$ref": "#/definitions/Reference"
},
"publisherLocation": {
"description": "Geographic location of the publisher.",
"$ref": "#/definitions/string"
},
"_publisherLocation": {
"description": "Extensions for publisherLocation",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_WebLocation": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"classifier": {
"description": "A characterization of the object expected at the web location.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"url": {
"description": "The specific URL.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Classification1": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The kind of classifier (e.g. publication type, keyword).",
"$ref": "#/definitions/CodeableConcept"
},
"classifier": {
"description": "The specific classification value.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"artifactAssessment": {
"description": "Complex or externally created classification.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Contributorship": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"complete": {
"description": "Indicates if the list includes all authors and/or contributors.",
"$ref": "#/definitions/boolean"
},
"_complete": {
"description": "Extensions for complete",
"$ref": "#/definitions/Element"
},
"entry": {
"description": "An individual entity named as a contributor, for example in the author list or contributor list.",
"items": {
"$ref": "#/definitions/Citation_Entry"
},
"type": "array"
},
"summary": {
"description": "Used to record a display of the author/contributor list without separate data element for each list member.",
"items": {
"$ref": "#/definitions/Citation_Summary1"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Citation_Entry": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"contributor": {
"description": "The identity of the individual contributor.",
"$ref": "#/definitions/Reference"
},
"forenameInitials": {
"description": "For citation styles that use initials.",
"$ref": "#/definitions/string"
},
"_forenameInitials": {
"description": "Extensions for forenameInitials",
"$ref": "#/definitions/Element"
},
"affiliation": {
"description": "Organization affiliated with the contributor.",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"contributionType": {
"description": "This element identifies the specific nature of an individual’s contribution with respect to the cited work.",
"items": {
"$ref": "#/definitions/CodeableConcept"
},
"type": "array"
},
"role": {
"description": "The role of the contributor (e.g. author, editor, reviewer, funder).",
"$ref": "#/definitions/CodeableConcept"
},
"contributionInstance": {
"description": "Contributions with accounting for time or number.",
"items": {
"$ref": "#/definitions/Citation_ContributionInstance"
},
"type": "array"
},
"correspondingContact": {
"description": "Whether the contributor is the corresponding contributor for the role.",
"$ref": "#/definitions/boolean"
},
"_correspondingContact": {
"description": "Extensions for correspondingContact",
"$ref": "#/definitions/Element"
},
"rankingOrder": {
"description": "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.",
"$ref": "#/definitions/positiveInt"
},
"_rankingOrder": {
"description": "Extensions for rankingOrder",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"contributor"
]
},
"Citation_ContributionInstance": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The specific contribution.",
"$ref": "#/definitions/CodeableConcept"
},
"time": {
"description": "The time that the contribution was made.",
"$ref": "#/definitions/dateTime"
},
"_time": {
"description": "Extensions for time",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"Citation_Summary1": {
"description": "The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Used most commonly to express an author list or a contributorship statement.",
"$ref": "#/definitions/CodeableConcept"
},
"style": {
"description": "The format for the display string, such as author last name with first letter capitalized followed by forename initials.",
"$ref": "#/definitions/CodeableConcept"
},
"source": {
"description": "Used to code the producer or rule for creating the display string.",
"$ref": "#/definitions/CodeableConcept"
},
"value": {
"description": "The display string for the author list, contributor list, or contributorship statement.",
"$ref": "#/definitions/markdown"
},
"_value": {
"description": "Extensions for value",
"$ref": "#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Claim": {
"description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"properties": {
"resourceType": {
"description": "This is a Claim resource",
"const": "Claim"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be 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.",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "A unique identifier assigned to this claim.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"traceNumber": {
"description": "Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.",
"items": {
"$ref": "#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "The status of the resource instance.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "#/definitions/Element"
},
"type": {
"description": "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.",
"$ref": "#/definitions/CodeableConcept"
},
"subType": {
"description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"$ref": "#/definitions/CodeableConcept"
},
"use": {
"description": "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 \u0027what if\u0027 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.",
"$ref": "#/definitions/code"
},
"_use": {
"description": "Extensions for use",
"$ref": "#/definitions/Element"
},
"patient": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"billablePeriod": {
"description": "The period for which charges are being submitted.",
"$ref": "#/definitions/Period"
},
"created": {
"description": "The date this resource was created.",
"$ref": "#/definitions/dateTime"
},
"_created": {
"description": "Extensions for created",
"$ref": "#/definitions/Element"
},
"enterer": {
"description": "Individual who created the claim, predetermination or preauthorization.",
"$ref": "#/definitions/Reference"
},
"insurer": {
"description": "The Insurer who is target of the request.",
"$ref": "#/definitions/Reference"
},
"provider": {
"description": "The provider which is responsible for the claim, predetermination or preauthorization.",
"$ref": "#/definitions/Reference"
},
"priority": {
"description": "The provider-required urgency of processing the request. Typical values include: stat, normal, deferred.",
"$ref": "#/definitions/CodeableConcept"
},
"fundsReserve": {
"description": "A code to indicate whether and for whom funds are to be reserved for future claims.",
"$ref": "#/definitions/CodeableConcept"
},
"related": {
"description": "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.",
"items": {
"$ref": "#/definitions/Claim_Related"
},
"type": "array"
},
"prescription": {
"description": "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 \u0027order\u0027 for oxygen or wheelchair or physiotherapy treatments.",
"$ref": "#/definitions/Reference"
},
"originalPrescription": {
"description": "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.",
"$ref": "#/definitions/Reference"
},
"payee": {
"description": "The party to be reimbursed for cost of the products and services according to the terms of the policy.",
"$ref": "#/definitions/Claim_Payee"
},
"referral": {
"description": "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.",
"$ref": "#/definitions/Reference"
},
"encounter": {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment