Jump to

• Request
• Response

GET ActorDefinition Resource Bundle

get

oracle-fhir-server/fhir/ActorDefinition

This endpoint supports the retrieval of ActorDefinition resource list.It returns Bundle of ActorDefinition resource.

Request

Query Parameters

• _content(optional): SPECIAL
  Search on the entire content of the resource
• _filter(optional): STRING
  Search the contents of the resource's data using a filter
• _has(optional): STRING
  Return resources linked to by the given target
• _id(optional): TOKEN
  Logical id of this artifact
• _lastUpdated(optional): DATE
  When the resource version last changed
• _profile(optional): REFERENCE
  Profiles this resource claims to conform to
• _security(optional): TOKEN
  Security Labels applied to this resource
• _source(optional): URI
  Identifies where the resource comes from
• _tag(optional): TOKEN
  Tags applied to this resource
• _text(optional): SPECIAL
  Search on the narrative of the resource
• context(optional): TOKEN
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): A use context assigned to the activity definition * [ActorDefinition](actordefinition.html): A use context assigned to the Actor Definition * [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): A use context assigned to the charge item definition * [Citation](citation.html): A use context assigned to the citation * [CodeSystem](codesystem.html): A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition * [ConceptMap](conceptmap.html): A use context assigned to the concept map * [ConditionDefinition](conditiondefinition.html): A use context assigned to the condition definition * [EventDefinition](eventdefinition.html): A use context assigned to the event definition * [Evidence](evidence.html): A use context assigned to the evidence * [EvidenceReport](evidencereport.html): A use context assigned to the evidence report * [EvidenceVariable](evidencevariable.html): A use context assigned to the evidence variable * [ExampleScenario](examplescenario.html): A use context assigned to the example scenario * [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide * [Library](library.html): A use context assigned to the library * [Measure](measure.html): A use context assigned to the measure * [MessageDefinition](messagedefinition.html): A use context assigned to the message definition * [NamingSystem](namingsystem.html): A use context assigned to the naming system * [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition * [PlanDefinition](plandefinition.html): A use context assigned to the plan definition * [Questionnaire](questionnaire.html): A use context assigned to the questionnaire * [Requirements](requirements.html): A use context assigned to the requirements * [SearchParameter](searchparameter.html): A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition * [StructureMap](structuremap.html): A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities * [TestScript](testscript.html): A use context assigned to the test script * [ValueSet](valueset.html): A use context assigned to the value set
• context-quantity(optional): QUANTITY
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): A quantity- or range-valued use context assigned to the activity definition * [ActorDefinition](actordefinition.html): A quantity- or range-valued use context assigned to the Actor Definition * [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): A quantity- or range-valued use context assigned to the charge item definition * [Citation](citation.html): A quantity- or range-valued use context assigned to the citation * [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition * [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map * [ConditionDefinition](conditiondefinition.html): A quantity- or range-valued use context assigned to the condition definition * [EventDefinition](eventdefinition.html): A quantity- or range-valued use context assigned to the event definition * [Evidence](evidence.html): A quantity- or range-valued use context assigned to the evidence * [EvidenceReport](evidencereport.html): A quantity- or range-valued use context assigned to the evidence report * [EvidenceVariable](evidencevariable.html): A quantity- or range-valued use context assigned to the evidence variable * [ExampleScenario](examplescenario.html): A quantity- or range-valued use context assigned to the example scenario * [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition * [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide * [Library](library.html): A quantity- or range-valued use context assigned to the library * [Measure](measure.html): A quantity- or range-valued use context assigned to the measure * [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition * [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system * [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition * [PlanDefinition](plandefinition.html): A quantity- or range-valued use context assigned to the plan definition * [Questionnaire](questionnaire.html): A quantity- or range-valued use context assigned to the questionnaire * [Requirements](requirements.html): A quantity- or range-valued use context assigned to the requirements * [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter * [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition * [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities * [TestScript](testscript.html): A quantity- or range-valued use context assigned to the test script * [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
• context-type(optional): TOKEN
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): A type of use context assigned to the activity definition * [ActorDefinition](actordefinition.html): A type of use context assigned to the Actor Definition * [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): A type of use context assigned to the charge item definition * [Citation](citation.html): A type of use context assigned to the citation * [CodeSystem](codesystem.html): A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html): A type of use context assigned to the concept map * [ConditionDefinition](conditiondefinition.html): A type of use context assigned to the condition definition * [EventDefinition](eventdefinition.html): A type of use context assigned to the event definition * [Evidence](evidence.html): A type of use context assigned to the evidence * [EvidenceReport](evidencereport.html): A type of use context assigned to the evidence report * [EvidenceVariable](evidencevariable.html): A type of use context assigned to the evidence variable * [ExampleScenario](examplescenario.html): A type of use context assigned to the example scenario * [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide * [Library](library.html): A type of use context assigned to the library * [Measure](measure.html): A type of use context assigned to the measure * [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition * [NamingSystem](namingsystem.html): A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition * [PlanDefinition](plandefinition.html): A type of use context assigned to the plan definition * [Questionnaire](questionnaire.html): A type of use context assigned to the questionnaire * [Requirements](requirements.html): A type of use context assigned to the requirements * [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition * [StructureMap](structuremap.html): A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities * [TestScript](testscript.html): A type of use context assigned to the test script * [ValueSet](valueset.html): A type of use context assigned to the value set
• context-type-quantity(optional): COMPOSITE
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): A use context type and quantity- or range-based value assigned to the activity definition * [ActorDefinition](actordefinition.html): A use context type and quantity- or range-based value assigned to the Actor Definition * [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): A use context type and quantity- or range-based value assigned to the charge item definition * [Citation](citation.html): A use context type and quantity- or range-based value assigned to the citation * [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition * [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map * [ConditionDefinition](conditiondefinition.html): A use context type and quantity- or range-based value assigned to the condition definition * [EventDefinition](eventdefinition.html): A use context type and quantity- or range-based value assigned to the event definition * [Evidence](evidence.html): A use context type and quantity- or range-based value assigned to the evidence * [EvidenceReport](evidencereport.html): A use context type and quantity- or range-based value assigned to the evidence report * [EvidenceVariable](evidencevariable.html): A use context type and quantity- or range-based value assigned to the evidence variable * [ExampleScenario](examplescenario.html): A use context type and quantity- or range-based value assigned to the example scenario * [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide * [Library](library.html): A use context type and quantity- or range-based value assigned to the library * [Measure](measure.html): A use context type and quantity- or range-based value assigned to the measure * [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition * [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition * [PlanDefinition](plandefinition.html): A use context type and quantity- or range-based value assigned to the plan definition * [Questionnaire](questionnaire.html): A use context type and quantity- or range-based value assigned to the questionnaire * [Requirements](requirements.html): A use context type and quantity- or range-based value assigned to the requirements * [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter * [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition * [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities * [TestScript](testscript.html): A use context type and quantity- or range-based value assigned to the test script * [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
• context-type-value(optional): COMPOSITE
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): A use context type and value assigned to the activity definition * [ActorDefinition](actordefinition.html): A use context type and value assigned to the Actor Definition * [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): A use context type and value assigned to the charge item definition * [Citation](citation.html): A use context type and value assigned to the citation * [CodeSystem](codesystem.html): A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition * [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map * [ConditionDefinition](conditiondefinition.html): A use context type and value assigned to the condition definition * [EventDefinition](eventdefinition.html): A use context type and value assigned to the event definition * [Evidence](evidence.html): A use context type and value assigned to the evidence * [EvidenceReport](evidencereport.html): A use context type and value assigned to the evidence report * [EvidenceVariable](evidencevariable.html): A use context type and value assigned to the evidence variable * [ExampleScenario](examplescenario.html): A use context type and value assigned to the example scenario * [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide * [Library](library.html): A use context type and value assigned to the library * [Measure](measure.html): A use context type and value assigned to the measure * [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition * [PlanDefinition](plandefinition.html): A use context type and value assigned to the plan definition * [Questionnaire](questionnaire.html): A use context type and value assigned to the questionnaire * [Requirements](requirements.html): A use context type and value assigned to the requirements * [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition * [StructureMap](structuremap.html): A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities * [TestScript](testscript.html): A use context type and value assigned to the test script * [ValueSet](valueset.html): A use context type and value assigned to the value set
• date(optional): DATE
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): The activity definition publication date * [ActorDefinition](actordefinition.html): The Actor Definition publication date * [CapabilityStatement](capabilitystatement.html): The capability statement publication date * [ChargeItemDefinition](chargeitemdefinition.html): The charge item definition publication date * [Citation](citation.html): The citation publication date * [CodeSystem](codesystem.html): The code system publication date * [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date * [ConceptMap](conceptmap.html): The concept map publication date * [ConditionDefinition](conditiondefinition.html): The condition definition publication date * [EventDefinition](eventdefinition.html): The event definition publication date * [Evidence](evidence.html): The evidence publication date * [EvidenceVariable](evidencevariable.html): The evidence variable publication date * [ExampleScenario](examplescenario.html): The example scenario publication date * [GraphDefinition](graphdefinition.html): The graph definition publication date * [ImplementationGuide](implementationguide.html): The implementation guide publication date * [Library](library.html): The library publication date * [Measure](measure.html): The measure publication date * [MessageDefinition](messagedefinition.html): The message definition publication date * [NamingSystem](namingsystem.html): The naming system publication date * [OperationDefinition](operationdefinition.html): The operation definition publication date * [PlanDefinition](plandefinition.html): The plan definition publication date * [Questionnaire](questionnaire.html): The questionnaire publication date * [Requirements](requirements.html): The requirements publication date * [SearchParameter](searchparameter.html): The search parameter publication date * [StructureDefinition](structuredefinition.html): The structure definition publication date * [StructureMap](structuremap.html): The structure map publication date * [SubscriptionTopic](subscriptiontopic.html): Date status first applied * [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date * [TestScript](testscript.html): The test script publication date * [ValueSet](valueset.html): The value set publication date
• description(optional): STRING
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): The description of the activity definition * [ActorDefinition](actordefinition.html): The description of the Actor Definition * [CapabilityStatement](capabilitystatement.html): The description of the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): The description of the charge item definition * [Citation](citation.html): The description of the citation * [CodeSystem](codesystem.html): The description of the code system * [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition * [ConceptMap](conceptmap.html): The description of the concept map * [ConditionDefinition](conditiondefinition.html): The description of the condition definition * [EventDefinition](eventdefinition.html): The description of the event definition * [Evidence](evidence.html): The description of the evidence * [EvidenceVariable](evidencevariable.html): The description of the evidence variable * [GraphDefinition](graphdefinition.html): The description of the graph definition * [ImplementationGuide](implementationguide.html): The description of the implementation guide * [Library](library.html): The description of the library * [Measure](measure.html): The description of the measure * [MessageDefinition](messagedefinition.html): The description of the message definition * [NamingSystem](namingsystem.html): The description of the naming system * [OperationDefinition](operationdefinition.html): The description of the operation definition * [PlanDefinition](plandefinition.html): The description of the plan definition * [Questionnaire](questionnaire.html): The description of the questionnaire * [Requirements](requirements.html): The description of the requirements * [SearchParameter](searchparameter.html): The description of the search parameter * [StructureDefinition](structuredefinition.html): The description of the structure definition * [StructureMap](structuremap.html): The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities * [TestScript](testscript.html): The description of the test script * [ValueSet](valueset.html): The description of the value set
• identifier(optional): TOKEN
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): External identifier for the activity definition * [ActorDefinition](actordefinition.html): External identifier for the Actor Definition * [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition * [Citation](citation.html): External identifier for the citation * [CodeSystem](codesystem.html): External identifier for the code system * [ConceptMap](conceptmap.html): External identifier for the concept map * [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition * [EventDefinition](eventdefinition.html): External identifier for the event definition * [Evidence](evidence.html): External identifier for the evidence * [EvidenceReport](evidencereport.html): External identifier for the evidence report * [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable * [ExampleScenario](examplescenario.html): External identifier for the example scenario * [Library](library.html): External identifier for the library * [Measure](measure.html): External identifier for the measure * [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication * [MessageDefinition](messagedefinition.html): External identifier for the message definition * [NamingSystem](namingsystem.html): External identifier for the naming system * [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition * [PlanDefinition](plandefinition.html): External identifier for the plan definition * [Questionnaire](questionnaire.html): External identifier for the questionnaire * [Requirements](requirements.html): External identifier for the requirements * [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition * [StructureDefinition](structuredefinition.html): External identifier for the structure definition * [StructureMap](structuremap.html): External identifier for the structure map * [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic * [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities * [TestScript](testscript.html): External identifier for the test script * [ValueSet](valueset.html): External identifier for the value set
• jurisdiction(optional): TOKEN
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): Intended jurisdiction for the activity definition * [ActorDefinition](actordefinition.html): Intended jurisdiction for the Actor Definition * [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): Intended jurisdiction for the charge item definition * [Citation](citation.html): Intended jurisdiction for the citation * [CodeSystem](codesystem.html): Intended jurisdiction for the code system * [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map * [ConditionDefinition](conditiondefinition.html): Intended jurisdiction for the condition definition * [EventDefinition](eventdefinition.html): Intended jurisdiction for the event definition * [ExampleScenario](examplescenario.html): Intended jurisdiction for the example scenario * [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide * [Library](library.html): Intended jurisdiction for the library * [Measure](measure.html): Intended jurisdiction for the measure * [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition * [PlanDefinition](plandefinition.html): Intended jurisdiction for the plan definition * [Questionnaire](questionnaire.html): Intended jurisdiction for the questionnaire * [Requirements](requirements.html): Intended jurisdiction for the requirements * [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition * [StructureMap](structuremap.html): Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities * [TestScript](testscript.html): Intended jurisdiction for the test script * [ValueSet](valueset.html): Intended jurisdiction for the value set
• publisher(optional): STRING
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): Name of the publisher of the activity definition * [ActorDefinition](actordefinition.html): Name of the publisher of the Actor Definition * [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): Name of the publisher of the charge item definition * [Citation](citation.html): Name of the publisher of the citation * [CodeSystem](codesystem.html): Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html): Name of the publisher of the concept map * [ConditionDefinition](conditiondefinition.html): Name of the publisher of the condition definition * [EventDefinition](eventdefinition.html): Name of the publisher of the event definition * [Evidence](evidence.html): Name of the publisher of the evidence * [EvidenceReport](evidencereport.html): Name of the publisher of the evidence report * [EvidenceVariable](evidencevariable.html): Name of the publisher of the evidence variable * [ExampleScenario](examplescenario.html): Name of the publisher of the example scenario * [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide * [Library](library.html): Name of the publisher of the library * [Measure](measure.html): Name of the publisher of the measure * [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition * [NamingSystem](namingsystem.html): Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition * [PlanDefinition](plandefinition.html): Name of the publisher of the plan definition * [Questionnaire](questionnaire.html): Name of the publisher of the questionnaire * [Requirements](requirements.html): Name of the publisher of the requirements * [SearchParameter](searchparameter.html): Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition * [StructureMap](structuremap.html): Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities * [TestScript](testscript.html): Name of the publisher of the test script * [ValueSet](valueset.html): Name of the publisher of the value set
• status(optional): TOKEN
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): The current status of the activity definition * [ActorDefinition](actordefinition.html): The current status of the Actor Definition * [CapabilityStatement](capabilitystatement.html): The current status of the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition * [Citation](citation.html): The current status of the citation * [CodeSystem](codesystem.html): The current status of the code system * [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition * [ConceptMap](conceptmap.html): The current status of the concept map * [ConditionDefinition](conditiondefinition.html): The current status of the condition definition * [EventDefinition](eventdefinition.html): The current status of the event definition * [Evidence](evidence.html): The current status of the evidence * [EvidenceReport](evidencereport.html): The current status of the evidence report * [EvidenceVariable](evidencevariable.html): The current status of the evidence variable * [ExampleScenario](examplescenario.html): The current status of the example scenario * [GraphDefinition](graphdefinition.html): The current status of the graph definition * [ImplementationGuide](implementationguide.html): The current status of the implementation guide * [Library](library.html): The current status of the library * [Measure](measure.html): The current status of the measure * [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error * [MessageDefinition](messagedefinition.html): The current status of the message definition * [NamingSystem](namingsystem.html): The current status of the naming system * [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown * [OperationDefinition](operationdefinition.html): The current status of the operation definition * [PlanDefinition](plandefinition.html): The current status of the plan definition * [Questionnaire](questionnaire.html): The current status of the questionnaire * [Requirements](requirements.html): The current status of the requirements * [SearchParameter](searchparameter.html): The current status of the search parameter * [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown * [StructureDefinition](structuredefinition.html): The current status of the structure definition * [StructureMap](structuremap.html): The current status of the structure map * [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown * [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities * [TestScript](testscript.html): The current status of the test script * [ValueSet](valueset.html): The current status of the value set
• title(optional): STRING
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition * [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition * [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition * [Citation](citation.html): The human-friendly name of the citation * [CodeSystem](codesystem.html): The human-friendly name of the code system * [ConceptMap](conceptmap.html): The human-friendly name of the concept map * [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition * [EventDefinition](eventdefinition.html): The human-friendly name of the event definition * [Evidence](evidence.html): The human-friendly name of the evidence * [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable * [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide * [Library](library.html): The human-friendly name of the library * [Measure](measure.html): The human-friendly name of the measure * [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition * [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition * [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition * [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition * [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire * [Requirements](requirements.html): The human-friendly name of the requirements * [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition * [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition * [StructureMap](structuremap.html): The human-friendly name of the structure map * [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) * [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities * [TestScript](testscript.html): The human-friendly name of the test script * [ValueSet](valueset.html): The human-friendly name of the value set
• type(optional): TOKEN
  The type of actor
• url(optional): URI
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition * [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition * [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition * [Citation](citation.html): The uri that identifies the citation * [CodeSystem](codesystem.html): The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition * [ConceptMap](conceptmap.html): The URI that identifies the concept map * [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition * [EventDefinition](eventdefinition.html): The uri that identifies the event definition * [Evidence](evidence.html): The uri that identifies the evidence * [EvidenceReport](evidencereport.html): The uri that identifies the evidence report * [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable * [ExampleScenario](examplescenario.html): The uri that identifies the example scenario * [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide * [Library](library.html): The uri that identifies the library * [Measure](measure.html): The uri that identifies the measure * [MessageDefinition](messagedefinition.html): The uri that identifies the message definition * [NamingSystem](namingsystem.html): The uri that identifies the naming system * [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition * [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition * [PlanDefinition](plandefinition.html): The uri that identifies the plan definition * [Questionnaire](questionnaire.html): The uri that identifies the questionnaire * [Requirements](requirements.html): The uri that identifies the requirements * [SearchParameter](searchparameter.html): The uri that identifies the search parameter * [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition * [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition * [StructureMap](structuremap.html): The uri that identifies the structure map * [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) * [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities * [TestScript](testscript.html): The uri that identifies the test script * [ValueSet](valueset.html): The uri that identifies the value set
• version(optional): TOKEN
  Multiple Resources: * [ActivityDefinition](activitydefinition.html): The business version of the activity definition * [ActorDefinition](actordefinition.html): The business version of the Actor Definition * [CapabilityStatement](capabilitystatement.html): The business version of the capability statement * [ChargeItemDefinition](chargeitemdefinition.html): The business version of the charge item definition * [Citation](citation.html): The business version of the citation * [CodeSystem](codesystem.html): The business version of the code system * [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition * [ConceptMap](conceptmap.html): The business version of the concept map * [ConditionDefinition](conditiondefinition.html): The business version of the condition definition * [EventDefinition](eventdefinition.html): The business version of the event definition * [Evidence](evidence.html): The business version of the evidence * [EvidenceVariable](evidencevariable.html): The business version of the evidence variable * [ExampleScenario](examplescenario.html): The business version of the example scenario * [GraphDefinition](graphdefinition.html): The business version of the graph definition * [ImplementationGuide](implementationguide.html): The business version of the implementation guide * [Library](library.html): The business version of the library * [Measure](measure.html): The business version of the measure * [MessageDefinition](messagedefinition.html): The business version of the message definition * [NamingSystem](namingsystem.html): The business version of the naming system * [OperationDefinition](operationdefinition.html): The business version of the operation definition * [PlanDefinition](plandefinition.html): The business version of the plan definition * [Questionnaire](questionnaire.html): The business version of the questionnaire * [Requirements](requirements.html): The business version of the requirements * [SearchParameter](searchparameter.html): The business version of the search parameter * [StructureDefinition](structuredefinition.html): The business version of the structure definition * [StructureMap](structuremap.html): The business version of the structure map * [SubscriptionTopic](subscriptiontopic.html): Business version of the SubscriptionTopic * [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities * [TestScript](testscript.html): The business version of the test script * [ValueSet](valueset.html): The business version of the value set

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/fhir+json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ActorDefinition"
    }
}

Nested Schema : schema

Type: object

Show Source

• _copyright: object Element
  Base definition for all elements in a resource.
• _copyrightLabel: object Element
  Base definition for all elements in a resource.
• _date: object Element
  Base definition for all elements in a resource.
• _description: object Element
  Base definition for all elements in a resource.
• _documentation: object Element
  Base definition for all elements in a resource.
• _experimental: object Element
  Base definition for all elements in a resource.
• _implicitRules: object Element
  Base definition for all elements in a resource.
• _language: object Element
  Base definition for all elements in a resource.
• _name: object Element
  Base definition for all elements in a resource.
• _publisher: object Element
  Base definition for all elements in a resource.
• _purpose: object Element
  Base definition for all elements in a resource.
• _reference: array _reference
  Extensions for reference
• _status: object Element
  Base definition for all elements in a resource.
• _title: object Element
  Base definition for all elements in a resource.
• _type: object Element
  Base definition for all elements in a resource.
• _url: object Element
  Base definition for all elements in a resource.
• _version: object Element
  Base definition for all elements in a resource.
• _versionAlgorithmString: object Element
  Base definition for all elements in a resource.
• capabilities: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource
• contact: array contact
  Contact details to assist a user in finding and communicating with the publisher.
• contained: array contained
  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.
• copyright: string
  Pattern: ^^[\s\S]+$$

  A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
• copyrightLabel: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• date: string
  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)?)?)?$

  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.
• derivedFrom: array derivedFrom
  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.
• description: string
  Pattern: ^^[\s\S]+$$

  A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
• documentation: string
  Pattern: ^^[\s\S]+$$

  A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
• experimental: boolean
  Pattern: ^true|false$

  Value of "true" or "false"
• extension: array extension
  May be 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.
• id: string
  Pattern: ^[A-Za-z0-9\-\.]{1,64}$

  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.
• identifier: array identifier
  A formal identifier that is used to identify this actor definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
• implicitRules: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• jurisdiction: array jurisdiction
  A legal or geographic region in which the actor definition is intended to be used.
• language: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• meta: object Meta
  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.
• modifierExtension: array modifierExtension
  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
• name: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• publisher: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• purpose: string
  Pattern: ^^[\s\S]+$$

  A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
• reference: array reference
  A reference to additional documentation about the actor, but description and documentation.
• resourceType(required):
  This is a ActorDefinition resource
• status: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• text: object Narrative
  A human-readable summary of the resource conveying the essential clinical and business information for the resource.
• title: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• type: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• url: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• useContext: array useContext
  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.
• version: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• versionAlgorithmCoding: object Coding
  A reference to a code defined by a terminology system.
• versionAlgorithmString: string
  Pattern: ^^[\s\S]+$$

  Indicates the mechanism used to compare versions to determine which is more current.

{
    "description":"",
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/uri"
        },
        "_implicitRules":{
            "description":"Extensions for implicitRules",
            "$ref":"#/components/schemas/Element"
        },
        "language":{
            "description":"The base language in which the resource is written.",
            "$ref":"#/components/schemas/code"
        },
        "_language":{
            "description":"Extensions for language",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the 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":"#/components/schemas/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":"#/components/schemas/uri"
        },
        "_url":{
            "description":"Extensions for url",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_version":{
            "description":"Extensions for version",
            "$ref":"#/components/schemas/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":"#/components/schemas/Element"
        },
        "versionAlgorithmCoding":{
            "description":"Indicates the mechanism used to compare versions to determine which is more current.",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_name":{
            "description":"Extensions for name",
            "$ref":"#/components/schemas/Element"
        },
        "title":{
            "description":"A short, descriptive, user-friendly title for the actor definition.",
            "$ref":"#/components/schemas/string"
        },
        "_title":{
            "description":"Extensions for title",
            "$ref":"#/components/schemas/Element"
        },
        "status":{
            "description":"The status of this actor definition. Enables tracking the life-cycle of the content.",
            "$ref":"#/components/schemas/code"
        },
        "_status":{
            "description":"Extensions for status",
            "$ref":"#/components/schemas/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":"#/components/schemas/boolean"
        },
        "_experimental":{
            "description":"Extensions for experimental",
            "$ref":"#/components/schemas/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":"#/components/schemas/dateTime"
        },
        "_date":{
            "description":"Extensions for date",
            "$ref":"#/components/schemas/Element"
        },
        "publisher":{
            "description":"The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition.",
            "$ref":"#/components/schemas/string"
        },
        "_publisher":{
            "description":"Extensions for publisher",
            "$ref":"#/components/schemas/Element"
        },
        "contact":{
            "description":"Contact details to assist a user in finding and communicating with the publisher.",
            "items":{
                "$ref":"#/components/schemas/ContactDetail"
            },
            "type":"array"
        },
        "description":{
            "description":"A free text natural language description of the actor.",
            "$ref":"#/components/schemas/markdown"
        },
        "_description":{
            "description":"Extensions for description",
            "$ref":"#/components/schemas/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":"#/components/schemas/UsageContext"
            },
            "type":"array"
        },
        "jurisdiction":{
            "description":"A legal or geographic region in which the actor definition is intended to be used.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            },
            "type":"array"
        },
        "purpose":{
            "description":"Explanation of why this actor definition is needed and why it has been designed as it has.",
            "$ref":"#/components/schemas/markdown"
        },
        "_purpose":{
            "description":"Extensions for purpose",
            "$ref":"#/components/schemas/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":"#/components/schemas/markdown"
        },
        "_copyright":{
            "description":"Extensions for copyright",
            "$ref":"#/components/schemas/Element"
        },
        "copyrightLabel":{
            "description":"A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').",
            "$ref":"#/components/schemas/string"
        },
        "_copyrightLabel":{
            "description":"Extensions for copyrightLabel",
            "$ref":"#/components/schemas/Element"
        },
        "type":{
            "description":"Whether the actor represents a human or an appliction.",
            "$ref":"#/components/schemas/code"
        },
        "_type":{
            "description":"Extensions for type",
            "$ref":"#/components/schemas/Element"
        },
        "documentation":{
            "description":"Documentation about the functionality of the actor.",
            "$ref":"#/components/schemas/markdown"
        },
        "_documentation":{
            "description":"Extensions for documentation",
            "$ref":"#/components/schemas/Element"
        },
        "reference":{
            "description":"A reference to additional documentation about the actor, but description and documentation.",
            "items":{
                "$ref":"#/components/schemas/url"
            },
            "type":"array"
        },
        "_reference":{
            "description":"Extensions for reference",
            "items":{
                "$ref":"#/components/schemas/Element"
            },
            "type":"array"
        },
        "capabilities":{
            "description":"The capability statement for the actor (if the concept is applicable).",
            "$ref":"#/components/schemas/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":"#/components/schemas/canonical"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false,
    "required":[
        "resourceType"
    ]
}

Nested Schema : Element

Type: object

Base definition for all elements in a resource.

Show Source

• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : _reference

Type: array

Extensions for reference

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for reference",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : contact

Type: array

Contact details to assist a user in finding and communicating with the publisher.

Show Source

• Array of: object ContactDetail
  Specifies contact information for a person or organization.

{
    "description":"Contact details to assist a user in finding and communicating with the publisher.",
    "items":{
        "$ref":"#/components/schemas/ContactDetail"
    },
    "type":"array"
}

Nested Schema : contained

Type: array

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.

Show Source

• Array of: object ResourceList
  One of FHIR Resource: Ref: FHIR R5 specification.

{
    "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":"#/components/schemas/ResourceList"
    },
    "type":"array"
}

Nested Schema : derivedFrom

Type: array

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.

Show Source

• Array of: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource

{
    "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":"#/components/schemas/canonical"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

May be 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.

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : identifier

Type: array

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.

Show Source

• Array of: object Identifier
  An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

{
    "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":"#/components/schemas/Identifier"
    },
    "type":"array"
}

Nested Schema : jurisdiction

Type: array

A legal or geographic region in which the actor definition is intended to be used.

Show Source

• Array of: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

{
    "description":"A legal or geographic region in which the actor definition is intended to be used.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    },
    "type":"array"
}

Nested Schema : Meta

Type: object

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.

Show Source

• _lastUpdated: object Element
  Base definition for all elements in a resource.
• _source: object Element
  Base definition for all elements in a resource.
• _versionId: object Element
  Base definition for all elements in a resource.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• lastUpdated: string
  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))$

  An instant in time - known at least to the second
• profile: array profile
  A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
• security: array security
  Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
• source: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• tag: array tag
  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.
• versionId: string
  Pattern: ^[A-Za-z0-9\-\.]{1,64}$

  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.

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/id"
        },
        "_versionId":{
            "description":"Extensions for versionId",
            "$ref":"#/components/schemas/Element"
        },
        "lastUpdated":{
            "description":"When the resource last changed - e.g. when the version changed.",
            "$ref":"#/components/schemas/instant"
        },
        "_lastUpdated":{
            "description":"Extensions for lastUpdated",
            "$ref":"#/components/schemas/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":"#/components/schemas/uri"
        },
        "_source":{
            "description":"Extensions for source",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Coding"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : reference

Type: array

A reference to additional documentation about the actor, but description and documentation.

Show Source

• Array of: string
  Pattern: ^\S*$

  A URI that is a literal reference

{
    "description":"A reference to additional documentation about the actor, but description and documentation.",
    "items":{
        "$ref":"#/components/schemas/url"
    },
    "type":"array"
}

Nested Schema : Narrative

Type: object

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

Show Source

• _status: object Element
  Base definition for all elements in a resource.
• div(required):
  xhtml - escaped html (see specfication)
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• status:
  Allowed Values: [ "generated", "extensions", "additional", "empty" ]

  The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "status":{
            "description":"The status of the narrative - whether it's 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":"#/components/schemas/Element"
        },
        "div":{
            "description":"The actual narrative content, a stripped down version of XHTML.",
            "$ref":"#/components/schemas/xhtml"
        }
    },
    "type":"object",
    "additionalProperties":false,
    "required":[
        "div"
    ]
}

Nested Schema : useContext

Type: array

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.

Show Source

• Array of: object UsageContext
  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).

{
    "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":"#/components/schemas/UsageContext"
    },
    "type":"array"
}

Nested Schema : Coding

Type: object

A reference to a code defined by a terminology system.

Show Source

• _code: object Element
  Base definition for all elements in a resource.
• _display: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _userSelected: object Element
  Base definition for all elements in a resource.
• _version: object Element
  Base definition for all elements in a resource.
• code: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• display: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• userSelected: boolean
  Pattern: ^true|false$

  Value of "true" or "false"
• version: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "system":{
            "description":"The identification of the code system that defines the meaning of the symbol in the code.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_version":{
            "description":"Extensions for version",
            "$ref":"#/components/schemas/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":"#/components/schemas/code"
        },
        "_code":{
            "description":"Extensions for code",
            "$ref":"#/components/schemas/Element"
        },
        "display":{
            "description":"A representation of the meaning of the code in the system, following the rules of the system.",
            "$ref":"#/components/schemas/string"
        },
        "_display":{
            "description":"Extensions for display",
            "$ref":"#/components/schemas/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":"#/components/schemas/boolean"
        },
        "_userSelected":{
            "description":"Extensions for userSelected",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : Extension

Type: object

Optional Extension Element - found in all resources.

Show Source

• _url: object Element
  Base definition for all elements in a resource.
• _valueBase64Binary: object Element
  Base definition for all elements in a resource.
• _valueBoolean: object Element
  Base definition for all elements in a resource.
• _valueCanonical: object Element
  Base definition for all elements in a resource.
• _valueCode: object Element
  Base definition for all elements in a resource.
• _valueDate: object Element
  Base definition for all elements in a resource.
• _valueDateTime: object Element
  Base definition for all elements in a resource.
• _valueDecimal: object Element
  Base definition for all elements in a resource.
• _valueId: object Element
  Base definition for all elements in a resource.
• _valueInstant: object Element
  Base definition for all elements in a resource.
• _valueInteger: object Element
  Base definition for all elements in a resource.
• _valueInteger64: object Element
  Base definition for all elements in a resource.
• _valueMarkdown: object Element
  Base definition for all elements in a resource.
• _valueOid: object Element
  Base definition for all elements in a resource.
• _valuePositiveInt: object Element
  Base definition for all elements in a resource.
• _valueString: object Element
  Base definition for all elements in a resource.
• _valueTime: object Element
  Base definition for all elements in a resource.
• _valueUnsignedInt: object Element
  Base definition for all elements in a resource.
• _valueUri: object Element
  Base definition for all elements in a resource.
• _valueUrl: object Element
  Base definition for all elements in a resource.
• _valueUuid: object Element
  Base definition for all elements in a resource.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• url: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• valueAddress: object Address
  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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
• valueAge: object Age
  A duration of time during which an organism (or a process) has existed.
• valueAnnotation: object Annotation
  A text note which also contains information about who made the statement and when.
• valueAttachment: object Attachment
  For referring to data content defined in other formats.
• valueAvailability: object Availability
  Availability data for an {item}.
• valueBase64Binary: string
  Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueBoolean: boolean
  Pattern: ^true|false$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueCanonical: string
  Pattern: ^\S*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueCode: string
  Pattern: ^[^\s]+( [^\s]+)*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueCodeableConcept: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• valueCodeableReference: object CodeableReference
  A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
• valueCoding: object Coding
  A reference to a code defined by a terminology system.
• valueContactDetail: object ContactDetail
  Specifies contact information for a person or organization.
• valueContactPoint: object ContactPoint
  Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
• valueCount: object Count
  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.
• valueDataRequirement: object DataRequirement
  Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
• valueDate: string
  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]))?)?$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueDateTime: string
  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)?)?)?$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueDecimal: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueDistance: object Distance
  A length - a value with a unit that is a physical distance.
• valueDosage: object Dosage
  Indicates how the medication is/was taken or should be taken by the patient.
• valueDuration: object Duration
  A length of time.
• valueExpression: object Expression
  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.
• valueExtendedContactDetail: object ExtendedContactDetail
  Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
• valueHumanName: object HumanName
  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.
• valueId: string
  Pattern: ^[A-Za-z0-9\-\.]{1,64}$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueIdentifier: object Identifier
  An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
• valueInstant: string
  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))$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueInteger: number
  Pattern: ^[0]|[-+]?[1-9][0-9]*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueInteger64: string
  Pattern: ^[0]|[-+]?[1-9][0-9]*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueMarkdown: string
  Pattern: ^^[\s\S]+$$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueMeta: object Meta
  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.
• valueMoney: object Money
  An amount of economic utility in some recognized currency.
• valueOid: string
  Pattern: ^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueParameterDefinition: object ParameterDefinition
  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.
• valuePeriod: object Period
  A time period defined by a start and end date and optionally time.
• valuePositiveInt: number
  Pattern: ^[1-9][0-9]*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueQuantity: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• valueRange: object Range
  A set of ordered Quantities defined by a low and high limit.
• valueRatio: object Ratio
  A relationship of two Quantity values - expressed as a numerator and a denominator.
• valueRatioRange: object RatioRange
  A range of ratios expressed as a low and high numerator and a denominator.
• valueReference: object Reference
  A reference from one resource to another.
• valueRelatedArtifact: object RelatedArtifact
  Related artifacts such as additional documentation, justification, or bibliographic references.
• valueSampledData: object SampledData
  A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
• valueSignature: object Signature
  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.
• valueString: string
  Pattern: ^^[\s\S]+$$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueTime: string
  Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueTiming: object Timing
  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.
• valueTriggerDefinition: object TriggerDefinition
  A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
• valueUnsignedInt: number
  Pattern: ^[0]|([1-9][0-9]*)$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueUri: string
  Pattern: ^\S*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueUrl: string
  Pattern: ^\S*$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
• valueUsageContext: object UsageContext
  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).
• valueUuid: string
  Pattern: ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

  Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "url":{
            "description":"Source of the definition for the extension code - a logical name or a URL.",
            "$ref":"#/components/schemas/uri"
        },
        "_url":{
            "description":"Extensions for url",
            "$ref":"#/components/schemas/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}==|[A-Za-z0-9+/]{3}=)?$",
            "type":"string"
        },
        "_valueBase64Binary":{
            "description":"Extensions for valueBase64Binary",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Meta"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : Address

Type: object

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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

Show Source

• _city: object Element
  Base definition for all elements in a resource.
• _country: object Element
  Base definition for all elements in a resource.
• _district: object Element
  Base definition for all elements in a resource.
• _line: array _line
  Extensions for line
• _postalCode: object Element
  Base definition for all elements in a resource.
• _state: object Element
  Base definition for all elements in a resource.
• _text: object Element
  Base definition for all elements in a resource.
• _type: object Element
  Base definition for all elements in a resource.
• _use: object Element
  Base definition for all elements in a resource.
• city: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• country: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• district: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• line: array line
  This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
• period: object Period
  A time period defined by a start and end date and optionally time.
• postalCode: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• state: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• text: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• type:
  Allowed Values: [ "postal", "physical", "both" ]

  Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
• use:
  Allowed Values: [ "home", "work", "temp", "old", "billing" ]

  The purpose of this 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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "use":{
            "description":"The purpose of this address.",
            "enum":[
                "home",
                "work",
                "temp",
                "old",
                "billing"
            ]
        },
        "_use":{
            "description":"Extensions for use",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_text":{
            "description":"Extensions for text",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
            },
            "type":"array"
        },
        "_line":{
            "description":"Extensions for line",
            "items":{
                "$ref":"#/components/schemas/Element"
            },
            "type":"array"
        },
        "city":{
            "description":"The name of the city, town, suburb, village or other community or delivery center.",
            "$ref":"#/components/schemas/string"
        },
        "_city":{
            "description":"Extensions for city",
            "$ref":"#/components/schemas/Element"
        },
        "district":{
            "description":"The name of the administrative area (county).",
            "$ref":"#/components/schemas/string"
        },
        "_district":{
            "description":"Extensions for district",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_state":{
            "description":"Extensions for state",
            "$ref":"#/components/schemas/Element"
        },
        "postalCode":{
            "description":"A postal code designating a region defined by the postal service.",
            "$ref":"#/components/schemas/string"
        },
        "_postalCode":{
            "description":"Extensions for postalCode",
            "$ref":"#/components/schemas/Element"
        },
        "country":{
            "description":"Country - a nation as commonly understood or generally accepted.",
            "$ref":"#/components/schemas/string"
        },
        "_country":{
            "description":"Extensions for country",
            "$ref":"#/components/schemas/Element"
        },
        "period":{
            "description":"Time period when address was/is in use.",
            "$ref":"#/components/schemas/Period"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Age

Type: object

A duration of time during which an organism (or a process) has existed.

Show Source

• _code: object Element
  Base definition for all elements in a resource.
• _comparator: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _unit: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• code: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• comparator:
  Allowed Values: [ "<", "<=", ">=", ">", "ad" ]

  How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div>
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• unit: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• value: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "value":{
            "description":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
            "$ref":"#/components/schemas/decimal"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/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 \"<\" , then the real value is < stated value.",
            "enum":[
                "<",
                "<=",
                ">=",
                ">",
                "ad"
            ]
        },
        "_comparator":{
            "description":"Extensions for comparator",
            "$ref":"#/components/schemas/Element"
        },
        "unit":{
            "description":"A human-readable form of the unit.",
            "$ref":"#/components/schemas/string"
        },
        "_unit":{
            "description":"Extensions for unit",
            "$ref":"#/components/schemas/Element"
        },
        "system":{
            "description":"The identification of the system that provides the coded form of the unit.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/Element"
        },
        "code":{
            "description":"A computer processable form of the unit in some unit representation system.",
            "$ref":"#/components/schemas/code"
        },
        "_code":{
            "description":"Extensions for code",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Annotation

Type: object

A text note which also contains information about who made the statement and when.

Show Source

• _authorString: object Element
  Base definition for all elements in a resource.
• _text: object Element
  Base definition for all elements in a resource.
• _time: object Element
  Base definition for all elements in a resource.
• authorReference: object Reference
  A reference from one resource to another.
• authorString: string
  Pattern: ^^[\s\S]+$$

  The individual responsible for making the annotation.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• text: string
  Pattern: ^^[\s\S]+$$

  A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
• time: string
  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)?)?)?$

  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.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "authorReference":{
            "description":"The individual responsible for making the annotation.",
            "$ref":"#/components/schemas/Reference"
        },
        "authorString":{
            "description":"The individual responsible for making the annotation.",
            "pattern":"^^[\\s\\S]+$$",
            "type":"string"
        },
        "_authorString":{
            "description":"Extensions for authorString",
            "$ref":"#/components/schemas/Element"
        },
        "time":{
            "description":"Indicates when this particular annotation was made.",
            "$ref":"#/components/schemas/dateTime"
        },
        "_time":{
            "description":"Extensions for time",
            "$ref":"#/components/schemas/Element"
        },
        "text":{
            "description":"The text of the annotation in markdown format.",
            "$ref":"#/components/schemas/markdown"
        },
        "_text":{
            "description":"Extensions for text",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Attachment

Type: object

For referring to data content defined in other formats.

Show Source

• _contentType: object Element
  Base definition for all elements in a resource.
• _creation: object Element
  Base definition for all elements in a resource.
• _data: object Element
  Base definition for all elements in a resource.
• _duration: object Element
  Base definition for all elements in a resource.
• _frames: object Element
  Base definition for all elements in a resource.
• _hash: object Element
  Base definition for all elements in a resource.
• _height: object Element
  Base definition for all elements in a resource.
• _language: object Element
  Base definition for all elements in a resource.
• _pages: object Element
  Base definition for all elements in a resource.
• _size: object Element
  Base definition for all elements in a resource.
• _title: object Element
  Base definition for all elements in a resource.
• _url: object Element
  Base definition for all elements in a resource.
• _width: object Element
  Base definition for all elements in a resource.
• contentType: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• creation: string
  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)?)?)?$

  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.
• data: string
  A stream of bytes
• duration: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• frames: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• hash: string
  A stream of bytes
• height: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• language: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• pages: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• size: string
  Pattern: ^[0]|[-+]?[1-9][0-9]*$

  A very large whole number
• title: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• url: string
  Pattern: ^\S*$

  A URI that is a literal reference
• width: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/code"
        },
        "_contentType":{
            "description":"Extensions for contentType",
            "$ref":"#/components/schemas/Element"
        },
        "language":{
            "description":"The human language of the content. The value can be any valid value according to BCP 47.",
            "$ref":"#/components/schemas/code"
        },
        "_language":{
            "description":"Extensions for language",
            "$ref":"#/components/schemas/Element"
        },
        "data":{
            "description":"The actual data of the attachment - a sequence of bytes, base64 encoded.",
            "$ref":"#/components/schemas/base64Binary"
        },
        "_data":{
            "description":"Extensions for data",
            "$ref":"#/components/schemas/Element"
        },
        "url":{
            "description":"A location where the data can be accessed.",
            "$ref":"#/components/schemas/url"
        },
        "_url":{
            "description":"Extensions for url",
            "$ref":"#/components/schemas/Element"
        },
        "size":{
            "description":"The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
            "$ref":"#/components/schemas/integer64"
        },
        "_size":{
            "description":"Extensions for size",
            "$ref":"#/components/schemas/Element"
        },
        "hash":{
            "description":"The calculated hash of the data using SHA-1. Represented using base64.",
            "$ref":"#/components/schemas/base64Binary"
        },
        "_hash":{
            "description":"Extensions for hash",
            "$ref":"#/components/schemas/Element"
        },
        "title":{
            "description":"A label or set of text to display in place of the data.",
            "$ref":"#/components/schemas/string"
        },
        "_title":{
            "description":"Extensions for title",
            "$ref":"#/components/schemas/Element"
        },
        "creation":{
            "description":"The date that the attachment was first created.",
            "$ref":"#/components/schemas/dateTime"
        },
        "_creation":{
            "description":"Extensions for creation",
            "$ref":"#/components/schemas/Element"
        },
        "height":{
            "description":"Height of the image in pixels (photo/video).",
            "$ref":"#/components/schemas/positiveInt"
        },
        "_height":{
            "description":"Extensions for height",
            "$ref":"#/components/schemas/Element"
        },
        "width":{
            "description":"Width of the image in pixels (photo/video).",
            "$ref":"#/components/schemas/positiveInt"
        },
        "_width":{
            "description":"Extensions for width",
            "$ref":"#/components/schemas/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":"#/components/schemas/positiveInt"
        },
        "_frames":{
            "description":"Extensions for frames",
            "$ref":"#/components/schemas/Element"
        },
        "duration":{
            "description":"The duration of the recording in seconds - for audio and video.",
            "$ref":"#/components/schemas/decimal"
        },
        "_duration":{
            "description":"Extensions for duration",
            "$ref":"#/components/schemas/Element"
        },
        "pages":{
            "description":"The number of pages when printed.",
            "$ref":"#/components/schemas/positiveInt"
        },
        "_pages":{
            "description":"Extensions for pages",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Availability

Type: object

Availability data for an {item}.

Show Source

• availableTime: array availableTime
  Times the {item} is available.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• notAvailableTime: array notAvailableTime
  Not available during this time due to provided reason.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "availableTime":{
            "description":"Times the {item} is available.",
            "items":{
                "$ref":"#/components/schemas/Availability_AvailableTime"
            },
            "type":"array"
        },
        "notAvailableTime":{
            "description":"Not available during this time due to provided reason.",
            "items":{
                "$ref":"#/components/schemas/Availability_NotAvailableTime"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : CodeableConcept

Type: object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Show Source

• _text: object Element
  Base definition for all elements in a resource.
• coding: array coding
  A reference to a code defined by a terminology system.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• text: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "coding":{
            "description":"A reference to a code defined by a terminology system.",
            "items":{
                "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_text":{
            "description":"Extensions for text",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : CodeableReference

Type: object

A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).

Show Source

• concept: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• reference: object Reference
  A reference from one resource to another.

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/CodeableConcept"
        },
        "reference":{
            "description":"A reference to a resource the provides exact details about the information being referenced.",
            "$ref":"#/components/schemas/Reference"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : ContactDetail

Type: object

Specifies contact information for a person or organization.

Show Source

• _name: object Element
  Base definition for all elements in a resource.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• name: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• telecom: array telecom
  The contact details for the individual (if a name was provided) or the organization.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "name":{
            "description":"The name of an individual to contact.",
            "$ref":"#/components/schemas/string"
        },
        "_name":{
            "description":"Extensions for name",
            "$ref":"#/components/schemas/Element"
        },
        "telecom":{
            "description":"The contact details for the individual (if a name was provided) or the organization.",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : ContactPoint

Type: object

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Show Source

• _rank: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _use: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• period: object Period
  A time period defined by a start and end date and optionally time.
• rank: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• system:
  Allowed Values: [ "phone", "fax", "email", "pager", "url", "sms", "other" ]

  Telecommunications form for contact point - what communications system is required to make use of the contact.
• use:
  Allowed Values: [ "home", "work", "temp", "old", "mobile" ]

  Identifies the purpose for the contact point.
• value: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/Element"
        },
        "use":{
            "description":"Identifies the purpose for the contact point.",
            "enum":[
                "home",
                "work",
                "temp",
                "old",
                "mobile"
            ]
        },
        "_use":{
            "description":"Extensions for use",
            "$ref":"#/components/schemas/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":"#/components/schemas/positiveInt"
        },
        "_rank":{
            "description":"Extensions for rank",
            "$ref":"#/components/schemas/Element"
        },
        "period":{
            "description":"Time period when the contact point was/is in use.",
            "$ref":"#/components/schemas/Period"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Count

Type: object

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.

Show Source

• _code: object Element
  Base definition for all elements in a resource.
• _comparator: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _unit: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• code: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• comparator:
  Allowed Values: [ "<", "<=", ">=", ">", "ad" ]

  How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div>
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• unit: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• value: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "value":{
            "description":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
            "$ref":"#/components/schemas/decimal"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/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 \"<\" , then the real value is < stated value.",
            "enum":[
                "<",
                "<=",
                ">=",
                ">",
                "ad"
            ]
        },
        "_comparator":{
            "description":"Extensions for comparator",
            "$ref":"#/components/schemas/Element"
        },
        "unit":{
            "description":"A human-readable form of the unit.",
            "$ref":"#/components/schemas/string"
        },
        "_unit":{
            "description":"Extensions for unit",
            "$ref":"#/components/schemas/Element"
        },
        "system":{
            "description":"The identification of the system that provides the coded form of the unit.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/Element"
        },
        "code":{
            "description":"A computer processable form of the unit in some unit representation system.",
            "$ref":"#/components/schemas/code"
        },
        "_code":{
            "description":"Extensions for code",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : DataRequirement

Type: object

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Show Source

• _limit: object Element
  Base definition for all elements in a resource.
• _mustSupport: array _mustSupport
  Extensions for mustSupport
• _type: object Element
  Base definition for all elements in a resource.
• codeFilter: array codeFilter
  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'ed, not OR'ed.
• dateFilter: array dateFilter
  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'ed, not OR'ed.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• limit: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• mustSupport: array mustSupport
  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. The 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).
• profile: array profile
  The profile of the required data, specified as the uri of the profile definition.
• sort: array sort
  Specifies the order of the results to be returned.
• subjectCodeableConcept: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• subjectReference: object Reference
  A reference from one resource to another.
• type: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• valueFilter: array valueFilter
  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'ed, not OR'ed).

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/code"
        },
        "_type":{
            "description":"Extensions for type",
            "$ref":"#/components/schemas/Element"
        },
        "profile":{
            "description":"The profile of the required data, specified as the uri of the profile definition.",
            "items":{
                "$ref":"#/components/schemas/canonical"
            },
            "type":"array"
        },
        "subjectCodeableConcept":{
            "description":"The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.",
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "subjectReference":{
            "description":"The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
            },
            "type":"array"
        },
        "_mustSupport":{
            "description":"Extensions for mustSupport",
            "items":{
                "$ref":"#/components/schemas/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'ed, not OR'ed.",
            "items":{
                "$ref":"#/components/schemas/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'ed, not OR'ed.",
            "items":{
                "$ref":"#/components/schemas/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'ed, not OR'ed).",
            "items":{
                "$ref":"#/components/schemas/DataRequirement_ValueFilter"
            },
            "type":"array"
        },
        "limit":{
            "description":"Specifies a maximum number of results that are required (uses the _count search parameter).",
            "$ref":"#/components/schemas/positiveInt"
        },
        "_limit":{
            "description":"Extensions for limit",
            "$ref":"#/components/schemas/Element"
        },
        "sort":{
            "description":"Specifies the order of the results to be returned.",
            "items":{
                "$ref":"#/components/schemas/DataRequirement_Sort"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Distance

Type: object

A length - a value with a unit that is a physical distance.

Show Source

• _code: object Element
  Base definition for all elements in a resource.
• _comparator: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _unit: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• code: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• comparator:
  Allowed Values: [ "<", "<=", ">=", ">", "ad" ]

  How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div>
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• unit: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• value: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "value":{
            "description":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
            "$ref":"#/components/schemas/decimal"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/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 \"<\" , then the real value is < stated value.",
            "enum":[
                "<",
                "<=",
                ">=",
                ">",
                "ad"
            ]
        },
        "_comparator":{
            "description":"Extensions for comparator",
            "$ref":"#/components/schemas/Element"
        },
        "unit":{
            "description":"A human-readable form of the unit.",
            "$ref":"#/components/schemas/string"
        },
        "_unit":{
            "description":"Extensions for unit",
            "$ref":"#/components/schemas/Element"
        },
        "system":{
            "description":"The identification of the system that provides the coded form of the unit.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/Element"
        },
        "code":{
            "description":"A computer processable form of the unit in some unit representation system.",
            "$ref":"#/components/schemas/code"
        },
        "_code":{
            "description":"Extensions for code",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Dosage

Type: object

Indicates how the medication is/was taken or should be taken by the patient.

Show Source

• _asNeeded: object Element
  Base definition for all elements in a resource.
• _patientInstruction: object Element
  Base definition for all elements in a resource.
• _sequence: object Element
  Base definition for all elements in a resource.
• _text: object Element
  Base definition for all elements in a resource.
• additionalInstruction: array additionalInstruction
  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").
• asNeeded: boolean
  Pattern: ^true|false$

  Value of "true" or "false"
• asNeededFor: array asNeededFor
  Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
• doseAndRate: array doseAndRate
  Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• maxDosePerAdministration: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• maxDosePerLifetime: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• maxDosePerPeriod: array maxDosePerPeriod
  Upper limit on medication per unit of time.
• method: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• modifierExtension: array modifierExtension
  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
• patientInstruction: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• route: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• sequence: number
  Pattern: ^[0]|[-+]?[1-9][0-9]*$

  A whole number
• site: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• text: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• timing: object Timing
  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.

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "sequence":{
            "description":"Indicates the order in which the dosage instructions should be applied or interpreted.",
            "$ref":"#/components/schemas/integer"
        },
        "_sequence":{
            "description":"Extensions for sequence",
            "$ref":"#/components/schemas/Element"
        },
        "text":{
            "description":"Free text dosage instructions e.g. SIG.",
            "$ref":"#/components/schemas/string"
        },
        "_text":{
            "description":"Extensions for text",
            "$ref":"#/components/schemas/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":"#/components/schemas/CodeableConcept"
            },
            "type":"array"
        },
        "patientInstruction":{
            "description":"Instructions in terms that are understood by the patient or consumer.",
            "$ref":"#/components/schemas/string"
        },
        "_patientInstruction":{
            "description":"Extensions for patientInstruction",
            "$ref":"#/components/schemas/Element"
        },
        "timing":{
            "description":"When medication should be administered.",
            "$ref":"#/components/schemas/Timing"
        },
        "asNeeded":{
            "description":"Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).",
            "$ref":"#/components/schemas/boolean"
        },
        "_asNeeded":{
            "description":"Extensions for asNeeded",
            "$ref":"#/components/schemas/Element"
        },
        "asNeededFor":{
            "description":"Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            },
            "type":"array"
        },
        "site":{
            "description":"Body site to administer to.",
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "route":{
            "description":"How drug should enter body.",
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "method":{
            "description":"Technique for administering medication.",
            "$ref":"#/components/schemas/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":"#/components/schemas/Dosage_DoseAndRate"
            },
            "type":"array"
        },
        "maxDosePerPeriod":{
            "description":"Upper limit on medication per unit of time.",
            "items":{
                "$ref":"#/components/schemas/Ratio"
            },
            "type":"array"
        },
        "maxDosePerAdministration":{
            "description":"Upper limit on medication per administration.",
            "$ref":"#/components/schemas/Quantity"
        },
        "maxDosePerLifetime":{
            "description":"Upper limit on medication per lifetime of the patient.",
            "$ref":"#/components/schemas/Quantity"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Duration

Type: object

A length of time.

Show Source

• _code: object Element
  Base definition for all elements in a resource.
• _comparator: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _unit: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• code: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• comparator:
  Allowed Values: [ "<", "<=", ">=", ">", "ad" ]

  How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div>
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• unit: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• value: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "value":{
            "description":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
            "$ref":"#/components/schemas/decimal"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/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 \"<\" , then the real value is < stated value.",
            "enum":[
                "<",
                "<=",
                ">=",
                ">",
                "ad"
            ]
        },
        "_comparator":{
            "description":"Extensions for comparator",
            "$ref":"#/components/schemas/Element"
        },
        "unit":{
            "description":"A human-readable form of the unit.",
            "$ref":"#/components/schemas/string"
        },
        "_unit":{
            "description":"Extensions for unit",
            "$ref":"#/components/schemas/Element"
        },
        "system":{
            "description":"The identification of the system that provides the coded form of the unit.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/Element"
        },
        "code":{
            "description":"A computer processable form of the unit in some unit representation system.",
            "$ref":"#/components/schemas/code"
        },
        "_code":{
            "description":"Extensions for code",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Expression

Type: object

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.

Show Source

• _description: object Element
  Base definition for all elements in a resource.
• _expression: object Element
  Base definition for all elements in a resource.
• _language: object Element
  Base definition for all elements in a resource.
• _name: object Element
  Base definition for all elements in a resource.
• _reference: object Element
  Base definition for all elements in a resource.
• description: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• expression: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• language: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• name: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• reference: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "description":{
            "description":"A brief, natural language description of the condition that effectively communicates the intended semantics.",
            "$ref":"#/components/schemas/string"
        },
        "_description":{
            "description":"Extensions for description",
            "$ref":"#/components/schemas/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":"#/components/schemas/code"
        },
        "_name":{
            "description":"Extensions for name",
            "$ref":"#/components/schemas/Element"
        },
        "language":{
            "description":"The media type of the language for the expression.",
            "$ref":"#/components/schemas/code"
        },
        "_language":{
            "description":"Extensions for language",
            "$ref":"#/components/schemas/Element"
        },
        "expression":{
            "description":"An expression in the specified language that returns a value.",
            "$ref":"#/components/schemas/string"
        },
        "_expression":{
            "description":"Extensions for expression",
            "$ref":"#/components/schemas/Element"
        },
        "reference":{
            "description":"A URI that defines where the expression is found.",
            "$ref":"#/components/schemas/uri"
        },
        "_reference":{
            "description":"Extensions for reference",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : ExtendedContactDetail

Type: object

Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.

Show Source

• address: object Address
  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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• name: array name
  The name of an individual to contact, some types of contact detail are usually blank.
• organization: object Reference
  A reference from one resource to another.
• period: object Period
  A time period defined by a start and end date and optionally time.
• purpose: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• telecom: array telecom
  The contact details application for the purpose defined.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "purpose":{
            "description":"The purpose/type of contact.",
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "name":{
            "description":"The name of an individual to contact, some types of contact detail are usually blank.",
            "items":{
                "$ref":"#/components/schemas/HumanName"
            },
            "type":"array"
        },
        "telecom":{
            "description":"The contact details application for the purpose defined.",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            },
            "type":"array"
        },
        "address":{
            "description":"Address for the contact.",
            "$ref":"#/components/schemas/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":"#/components/schemas/Reference"
        },
        "period":{
            "description":"Period that this contact was valid for usage.",
            "$ref":"#/components/schemas/Period"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : HumanName

Type: object

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.

Show Source

• _family: object Element
  Base definition for all elements in a resource.
• _given: array _given
  Extensions for given
• _prefix: array _prefix
  Extensions for prefix
• _suffix: array _suffix
  Extensions for suffix
• _text: object Element
  Base definition for all elements in a resource.
• _use: object Element
  Base definition for all elements in a resource.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• family: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• given: array given
  Given name.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• period: object Period
  A time period defined by a start and end date and optionally time.
• prefix: array prefix
  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.
• suffix: array suffix
  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.
• text: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• use:
  Allowed Values: [ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ]

  Identifies the purpose for this name.

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_text":{
            "description":"Extensions for text",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_family":{
            "description":"Extensions for family",
            "$ref":"#/components/schemas/Element"
        },
        "given":{
            "description":"Given name.",
            "items":{
                "$ref":"#/components/schemas/string"
            },
            "type":"array"
        },
        "_given":{
            "description":"Extensions for given",
            "items":{
                "$ref":"#/components/schemas/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":"#/components/schemas/string"
            },
            "type":"array"
        },
        "_prefix":{
            "description":"Extensions for prefix",
            "items":{
                "$ref":"#/components/schemas/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":"#/components/schemas/string"
            },
            "type":"array"
        },
        "_suffix":{
            "description":"Extensions for suffix",
            "items":{
                "$ref":"#/components/schemas/Element"
            },
            "type":"array"
        },
        "period":{
            "description":"Indicates the period of time when this name was valid for the named person.",
            "$ref":"#/components/schemas/Period"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Identifier

Type: object

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Show Source

• _system: object Element
  Base definition for all elements in a resource.
• _use: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• assigner: object Reference
  A reference from one resource to another.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• period: object Period
  A time period defined by a start and end date and optionally time.
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• type: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• use:
  Allowed Values: [ "usual", "official", "temp", "secondary", "old" ]

  The purpose of this identifier.
• value: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "use":{
            "description":"The purpose of this identifier.",
            "enum":[
                "usual",
                "official",
                "temp",
                "secondary",
                "old"
            ]
        },
        "_use":{
            "description":"Extensions for use",
            "$ref":"#/components/schemas/Element"
        },
        "type":{
            "description":"A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "description":"Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/Element"
        },
        "value":{
            "description":"The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
            "$ref":"#/components/schemas/string"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/Element"
        },
        "period":{
            "description":"Time period during which identifier is/was valid for use.",
            "$ref":"#/components/schemas/Period"
        },
        "assigner":{
            "description":"Organization that issued/manages the identifier.",
            "$ref":"#/components/schemas/Reference"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Money

Type: object

An amount of economic utility in some recognized currency.

Show Source

• _currency: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• currency: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• value: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "value":{
            "description":"Numerical value (with implicit precision).",
            "$ref":"#/components/schemas/decimal"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/Element"
        },
        "currency":{
            "description":"ISO 4217 Currency Code.",
            "$ref":"#/components/schemas/code"
        },
        "_currency":{
            "description":"Extensions for currency",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : ParameterDefinition

Type: object

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.

Show Source

• _documentation: object Element
  Base definition for all elements in a resource.
• _max: object Element
  Base definition for all elements in a resource.
• _min: object Element
  Base definition for all elements in a resource.
• _name: object Element
  Base definition for all elements in a resource.
• _type: object Element
  Base definition for all elements in a resource.
• _use: object Element
  Base definition for all elements in a resource.
• documentation: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• max: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• min: number
  Pattern: ^[0]|[-+]?[1-9][0-9]*$

  A whole number
• name: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• profile: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource
• type: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• use: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "name":{
            "description":"The name of the parameter used to allow access to the value of the parameter in evaluation contexts.",
            "$ref":"#/components/schemas/code"
        },
        "_name":{
            "description":"Extensions for name",
            "$ref":"#/components/schemas/Element"
        },
        "use":{
            "description":"Whether the parameter is input or output for the module.",
            "$ref":"#/components/schemas/code"
        },
        "_use":{
            "description":"Extensions for use",
            "$ref":"#/components/schemas/Element"
        },
        "min":{
            "description":"The minimum number of times this parameter SHALL appear in the request or response.",
            "$ref":"#/components/schemas/integer"
        },
        "_min":{
            "description":"Extensions for min",
            "$ref":"#/components/schemas/Element"
        },
        "max":{
            "description":"The maximum number of times this element is permitted to appear in the request or response.",
            "$ref":"#/components/schemas/string"
        },
        "_max":{
            "description":"Extensions for max",
            "$ref":"#/components/schemas/Element"
        },
        "documentation":{
            "description":"A brief discussion of what the parameter is for and how it is used by the module.",
            "$ref":"#/components/schemas/string"
        },
        "_documentation":{
            "description":"Extensions for documentation",
            "$ref":"#/components/schemas/Element"
        },
        "type":{
            "description":"The type of the parameter.",
            "$ref":"#/components/schemas/code"
        },
        "_type":{
            "description":"Extensions for type",
            "$ref":"#/components/schemas/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":"#/components/schemas/canonical"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Period

Type: object

A time period defined by a start and end date and optionally time.

Show Source

• _end: object Element
  Base definition for all elements in a resource.
• _start: object Element
  Base definition for all elements in a resource.
• end: string
  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)?)?)?$

  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.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• start: string
  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)?)?)?$

  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.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "start":{
            "description":"The start of the period. The boundary is inclusive.",
            "$ref":"#/components/schemas/dateTime"
        },
        "_start":{
            "description":"Extensions for start",
            "$ref":"#/components/schemas/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":"#/components/schemas/dateTime"
        },
        "_end":{
            "description":"Extensions for end",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Quantity

Type: object

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.

Show Source

• _code: object Element
  Base definition for all elements in a resource.
• _comparator: object Element
  Base definition for all elements in a resource.
• _system: object Element
  Base definition for all elements in a resource.
• _unit: object Element
  Base definition for all elements in a resource.
• _value: object Element
  Base definition for all elements in a resource.
• code: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• comparator:
  Allowed Values: [ "<", "<=", ">=", ">", "ad" ]

  How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div>
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• system: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource
• unit: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• value: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "value":{
            "description":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
            "$ref":"#/components/schemas/decimal"
        },
        "_value":{
            "description":"Extensions for value",
            "$ref":"#/components/schemas/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 \"<\" , then the real value is < stated value.",
            "enum":[
                "<",
                "<=",
                ">=",
                ">",
                "ad"
            ]
        },
        "_comparator":{
            "description":"Extensions for comparator",
            "$ref":"#/components/schemas/Element"
        },
        "unit":{
            "description":"A human-readable form of the unit.",
            "$ref":"#/components/schemas/string"
        },
        "_unit":{
            "description":"Extensions for unit",
            "$ref":"#/components/schemas/Element"
        },
        "system":{
            "description":"The identification of the system that provides the coded form of the unit.",
            "$ref":"#/components/schemas/uri"
        },
        "_system":{
            "description":"Extensions for system",
            "$ref":"#/components/schemas/Element"
        },
        "code":{
            "description":"A computer processable form of the unit in some unit representation system.",
            "$ref":"#/components/schemas/code"
        },
        "_code":{
            "description":"Extensions for code",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Range

Type: object

A set of ordered Quantities defined by a low and high limit.

Show Source

• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• high: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• low: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "low":{
            "description":"The low limit. The boundary is inclusive.",
            "$ref":"#/components/schemas/Quantity"
        },
        "high":{
            "description":"The high limit. The boundary is inclusive.",
            "$ref":"#/components/schemas/Quantity"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Ratio

Type: object

A relationship of two Quantity values - expressed as a numerator and a denominator.

Show Source

• denominator: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• numerator: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "numerator":{
            "description":"The value of the numerator.",
            "$ref":"#/components/schemas/Quantity"
        },
        "denominator":{
            "description":"The value of the denominator.",
            "$ref":"#/components/schemas/Quantity"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : RatioRange

Type: object

A range of ratios expressed as a low and high numerator and a denominator.

Show Source

• denominator: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• highNumerator: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• lowNumerator: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "lowNumerator":{
            "description":"The value of the low limit numerator.",
            "$ref":"#/components/schemas/Quantity"
        },
        "highNumerator":{
            "description":"The value of the high limit numerator.",
            "$ref":"#/components/schemas/Quantity"
        },
        "denominator":{
            "description":"The value of the denominator.",
            "$ref":"#/components/schemas/Quantity"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Reference

Type: object

A reference from one resource to another.

Show Source

• _display: object Element
  Base definition for all elements in a resource.
• _reference: object Element
  Base definition for all elements in a resource.
• _type: object Element
  Base definition for all elements in a resource.
• display: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• identifier: object Identifier
  An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
• reference: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• type: string
  Pattern: ^\S*$

  String of characters used to identify a name or a resource

{
    "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":"#/components/schemas/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":"#/components/schemas/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 '#') refer to contained resources.",
            "$ref":"#/components/schemas/string"
        },
        "_reference":{
            "description":"Extensions for reference",
            "$ref":"#/components/schemas/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":"#/components/schemas/uri"
        },
        "_type":{
            "description":"Extensions for type",
            "$ref":"#/components/schemas/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":"#/components/schemas/Identifier"
        },
        "display":{
            "description":"Plain text narrative that identifies the resource in addition to the resource reference.",
            "$ref":"#/components/schemas/string"
        },
        "_display":{
            "description":"Extensions for display",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : RelatedArtifact

Type: object

Related artifacts such as additional documentation, justification, or bibliographic references.

Show Source

• _citation: object Element
  Base definition for all elements in a resource.
• _display: object Element
  Base definition for all elements in a resource.
• _label: object Element
  Base definition for all elements in a resource.
• _publicationDate: object Element
  Base definition for all elements in a resource.
• _publicationStatus: object Element
  Base definition for all elements in a resource.
• _type: object Element
  Base definition for all elements in a resource.
• citation: string
  Pattern: ^^[\s\S]+$$

  A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
• classifier: array classifier
  Provides additional classifiers of the related artifact.
• display: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• document: object Attachment
  For referring to data content defined in other formats.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• label: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• publicationDate: string
  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]))?)?$

  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.
• publicationStatus: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• resource: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource
• resourceReference: object Reference
  A reference from one resource to another.
• type:
  Allowed Values: [ "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" ]

  The type of relationship to the related artifact.

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Element"
        },
        "classifier":{
            "description":"Provides additional classifiers of the related artifact.",
            "items":{
                "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_label":{
            "description":"Extensions for label",
            "$ref":"#/components/schemas/Element"
        },
        "display":{
            "description":"A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
            "$ref":"#/components/schemas/string"
        },
        "_display":{
            "description":"Extensions for display",
            "$ref":"#/components/schemas/Element"
        },
        "citation":{
            "description":"A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
            "$ref":"#/components/schemas/markdown"
        },
        "_citation":{
            "description":"Extensions for citation",
            "$ref":"#/components/schemas/Element"
        },
        "document":{
            "description":"The document being referenced, represented as an attachment. This is exclusive with the resource element.",
            "$ref":"#/components/schemas/Attachment"
        },
        "resource":{
            "description":"The related artifact, such as a library, value set, profile, or other knowledge resource.",
            "$ref":"#/components/schemas/canonical"
        },
        "resourceReference":{
            "description":"The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
            "$ref":"#/components/schemas/Reference"
        },
        "publicationStatus":{
            "description":"The publication status of the artifact being referred to.",
            "$ref":"#/components/schemas/code"
        },
        "_publicationStatus":{
            "description":"Extensions for publicationStatus",
            "$ref":"#/components/schemas/Element"
        },
        "publicationDate":{
            "description":"The date of publication of the artifact being referred to.",
            "$ref":"#/components/schemas/date"
        },
        "_publicationDate":{
            "description":"Extensions for publicationDate",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : SampledData

Type: object

A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

Show Source

• _data: object Element
  Base definition for all elements in a resource.
• _dimensions: object Element
  Base definition for all elements in a resource.
• _factor: object Element
  Base definition for all elements in a resource.
• _interval: object Element
  Base definition for all elements in a resource.
• _intervalUnit: object Element
  Base definition for all elements in a resource.
• _lowerLimit: object Element
  Base definition for all elements in a resource.
• _offsets: object Element
  Base definition for all elements in a resource.
• _upperLimit: object Element
  Base definition for all elements in a resource.
• codeMap: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource
• data: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• dimensions: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• factor: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• interval: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• intervalUnit: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• lowerLimit: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• offsets: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• origin(required): object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• upperLimit: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Quantity"
        },
        "interval":{
            "description":"Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.",
            "$ref":"#/components/schemas/decimal"
        },
        "_interval":{
            "description":"Extensions for interval",
            "$ref":"#/components/schemas/Element"
        },
        "intervalUnit":{
            "description":"The measurement unit in which the sample interval is expressed.",
            "$ref":"#/components/schemas/code"
        },
        "_intervalUnit":{
            "description":"Extensions for intervalUnit",
            "$ref":"#/components/schemas/Element"
        },
        "factor":{
            "description":"A correction factor that is applied to the sampled data points before they are added to the origin.",
            "$ref":"#/components/schemas/decimal"
        },
        "_factor":{
            "description":"Extensions for factor",
            "$ref":"#/components/schemas/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":"#/components/schemas/decimal"
        },
        "_lowerLimit":{
            "description":"Extensions for lowerLimit",
            "$ref":"#/components/schemas/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":"#/components/schemas/decimal"
        },
        "_upperLimit":{
            "description":"Extensions for upperLimit",
            "$ref":"#/components/schemas/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":"#/components/schemas/positiveInt"
        },
        "_dimensions":{
            "description":"Extensions for dimensions",
            "$ref":"#/components/schemas/Element"
        },
        "codeMap":{
            "description":"Reference to ConceptMap that defines the codes used in the data.",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_offsets":{
            "description":"Extensions for offsets",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_data":{
            "description":"Extensions for data",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false,
    "required":[
        "origin"
    ]
}

Nested Schema : Signature

Type: object

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.

Show Source

• _data: object Element
  Base definition for all elements in a resource.
• _sigFormat: object Element
  Base definition for all elements in a resource.
• _targetFormat: object Element
  Base definition for all elements in a resource.
• _when: object Element
  Base definition for all elements in a resource.
• data: string
  A stream of bytes
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• onBehalfOf: object Reference
  A reference from one resource to another.
• sigFormat: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• targetFormat: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• type: array type
  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.
• when: string
  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))$

  An instant in time - known at least to the second
• who: object Reference
  A reference from one resource to another.

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Coding"
            },
            "type":"array"
        },
        "when":{
            "description":"When the digital signature was signed.",
            "$ref":"#/components/schemas/instant"
        },
        "_when":{
            "description":"Extensions for when",
            "$ref":"#/components/schemas/Element"
        },
        "who":{
            "description":"A reference to an application-usable description of the identity that signed  (e.g. the signature used their private key).",
            "$ref":"#/components/schemas/Reference"
        },
        "onBehalfOf":{
            "description":"A reference to an application-usable description of the identity that is represented by the signature.",
            "$ref":"#/components/schemas/Reference"
        },
        "targetFormat":{
            "description":"A mime type that indicates the technical format of the target resources signed by the signature.",
            "$ref":"#/components/schemas/code"
        },
        "_targetFormat":{
            "description":"Extensions for targetFormat",
            "$ref":"#/components/schemas/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":"#/components/schemas/code"
        },
        "_sigFormat":{
            "description":"Extensions for sigFormat",
            "$ref":"#/components/schemas/Element"
        },
        "data":{
            "description":"The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.",
            "$ref":"#/components/schemas/base64Binary"
        },
        "_data":{
            "description":"Extensions for data",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : Timing

Type: object

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.

Show Source

• _event: array _event
  Extensions for event
• code: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• event: array event
  Identifies specific times when the event occurs.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• modifierExtension: array modifierExtension
  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
• repeat: object Timing_Repeat
  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.

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "event":{
            "description":"Identifies specific times when the event occurs.",
            "items":{
                "$ref":"#/components/schemas/dateTime"
            },
            "type":"array"
        },
        "_event":{
            "description":"Extensions for event",
            "items":{
                "$ref":"#/components/schemas/Element"
            },
            "type":"array"
        },
        "repeat":{
            "description":"A set of rules that describe when the event is scheduled.",
            "$ref":"#/components/schemas/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":"#/components/schemas/CodeableConcept"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : TriggerDefinition

Type: object

A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

Show Source

• _name: object Element
  Base definition for all elements in a resource.
• _timingDate: object Element
  Base definition for all elements in a resource.
• _timingDateTime: object Element
  Base definition for all elements in a resource.
• _type: object Element
  Base definition for all elements in a resource.
• code: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• condition: object Expression
  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.
• data: array data
  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.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• name: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• subscriptionTopic: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource
• timingDate: string
  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]))?)?$

  The timing of the event (if this is a periodic trigger).
• timingDateTime: string
  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)?)?)?$

  The timing of the event (if this is a periodic trigger).
• timingReference: object Reference
  A reference from one resource to another.
• timingTiming: object Timing
  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.
• type:
  Allowed Values: [ "named-event", "periodic", "data-changed", "data-added", "data-modified", "data-removed", "data-accessed", "data-access-ended" ]

  The type of triggering event.

{
    "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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_name":{
            "description":"Extensions for name",
            "$ref":"#/components/schemas/Element"
        },
        "code":{
            "description":"A code that identifies the event.",
            "$ref":"#/components/schemas/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":"#/components/schemas/canonical"
        },
        "timingTiming":{
            "description":"The timing of the event (if this is a periodic trigger).",
            "$ref":"#/components/schemas/Timing"
        },
        "timingReference":{
            "description":"The timing of the event (if this is a periodic trigger).",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Expression"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : UsageContext

Type: object

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

Show Source

• code(required): object Coding
  A reference to a code defined by a terminology system.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• valueCodeableConcept: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
• valueQuantity: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• valueRange: object Range
  A set of ordered Quantities defined by a low and high limit.
• valueReference: object Reference
  A reference from one resource to another.

{
    "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":"#/components/schemas/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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "code":{
            "description":"A code that identifies the type of context being specified by this usage context.",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Reference"
        }
    },
    "type":"object",
    "additionalProperties":false,
    "required":[
        "code"
    ]
}

Nested Schema : _line

Type: array

Extensions for line

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for line",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : line

Type: array

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Show Source

• Array of: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/string"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : availableTime

Type: array

Times the {item} is available.

Show Source

• Array of: object Availability_AvailableTime
  Availability data for an {item}.

{
    "description":"Times the {item} is available.",
    "items":{
        "$ref":"#/components/schemas/Availability_AvailableTime"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : notAvailableTime

Type: array

Not available during this time due to provided reason.

Show Source

• Array of: object Availability_NotAvailableTime
  Availability data for an {item}.

{
    "description":"Not available during this time due to provided reason.",
    "items":{
        "$ref":"#/components/schemas/Availability_NotAvailableTime"
    },
    "type":"array"
}

Nested Schema : Availability_AvailableTime

Type: object

Availability data for an {item}.

Show Source

• _allDay: object Element
  Base definition for all elements in a resource.
• _availableEndTime: object Element
  Base definition for all elements in a resource.
• _availableStartTime: object Element
  Base definition for all elements in a resource.
• _daysOfWeek: array _daysOfWeek
  Extensions for daysOfWeek
• allDay: boolean
  Pattern: ^true|false$

  Value of "true" or "false"
• availableEndTime: string
  Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$

  A time during the day, with no date specified
• availableStartTime: string
  Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$

  A time during the day, with no date specified
• daysOfWeek: array daysOfWeek
  mon | tue | wed | thu | fri | sat | sun.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

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

{
    "description":"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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "daysOfWeek":{
            "description":"mon | tue | wed | thu | fri | sat | sun.",
            "items":{
                "$ref":"#/components/schemas/code"
            },
            "type":"array"
        },
        "_daysOfWeek":{
            "description":"Extensions for daysOfWeek",
            "items":{
                "$ref":"#/components/schemas/Element"
            },
            "type":"array"
        },
        "allDay":{
            "description":"Always available? i.e. 24 hour service.",
            "$ref":"#/components/schemas/boolean"
        },
        "_allDay":{
            "description":"Extensions for allDay",
            "$ref":"#/components/schemas/Element"
        },
        "availableStartTime":{
            "description":"Opening time of day (ignored if allDay = true).",
            "$ref":"#/components/schemas/time"
        },
        "_availableStartTime":{
            "description":"Extensions for availableStartTime",
            "$ref":"#/components/schemas/Element"
        },
        "availableEndTime":{
            "description":"Closing time of day (ignored if allDay = true).",
            "$ref":"#/components/schemas/time"
        },
        "_availableEndTime":{
            "description":"Extensions for availableEndTime",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : _daysOfWeek

Type: array

Extensions for daysOfWeek

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for daysOfWeek",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : daysOfWeek

Type: array

mon | tue | wed | thu | fri | sat | sun.

Show Source

• Array of: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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

{
    "description":"mon | tue | wed | thu | fri | sat | sun.",
    "items":{
        "$ref":"#/components/schemas/code"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : Availability_NotAvailableTime

Type: object

Availability data for an {item}.

Show Source

• _description: object Element
  Base definition for all elements in a resource.
• description: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• during: object Period
  A time period defined by a start and end date and optionally time.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

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

{
    "description":"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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "description":{
            "description":"Reason presented to the user explaining why time not available.",
            "$ref":"#/components/schemas/string"
        },
        "_description":{
            "description":"Extensions for description",
            "$ref":"#/components/schemas/Element"
        },
        "during":{
            "description":"Service not available during this period.",
            "$ref":"#/components/schemas/Period"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : coding

Type: array

A reference to a code defined by a terminology system.

Show Source

• Array of: object Coding
  A reference to a code defined by a terminology system.

{
    "description":"A reference to a code defined by a terminology system.",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : telecom

Type: array

The contact details for the individual (if a name was provided) or the organization.

Show Source

• Array of: object ContactPoint
  Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

{
    "description":"The contact details for the individual (if a name was provided) or the organization.",
    "items":{
        "$ref":"#/components/schemas/ContactPoint"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : _mustSupport

Type: array

Extensions for mustSupport

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for mustSupport",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : codeFilter

Type: array

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'ed, not OR'ed.

Show Source

• Array of: object DataRequirement_CodeFilter
  Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

{
    "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'ed, not OR'ed.",
    "items":{
        "$ref":"#/components/schemas/DataRequirement_CodeFilter"
    },
    "type":"array"
}

Nested Schema : dateFilter

Type: array

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'ed, not OR'ed.

Show Source

• Array of: object DataRequirement_DateFilter
  Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

{
    "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'ed, not OR'ed.",
    "items":{
        "$ref":"#/components/schemas/DataRequirement_DateFilter"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : mustSupport

Type: array

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

Show Source

• Array of: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/string"
    },
    "type":"array"
}

Nested Schema : profile

Type: array

The profile of the required data, specified as the uri of the profile definition.

Show Source

• Array of: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource

{
    "description":"The profile of the required data, specified as the uri of the profile definition.",
    "items":{
        "$ref":"#/components/schemas/canonical"
    },
    "type":"array"
}

Nested Schema : sort

Type: array

Specifies the order of the results to be returned.

Show Source

• Array of: object DataRequirement_Sort
  Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

{
    "description":"Specifies the order of the results to be returned.",
    "items":{
        "$ref":"#/components/schemas/DataRequirement_Sort"
    },
    "type":"array"
}

Nested Schema : valueFilter

Type: array

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'ed, not OR'ed).

Show Source

• Array of: object DataRequirement_ValueFilter
  Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

{
    "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'ed, not OR'ed).",
    "items":{
        "$ref":"#/components/schemas/DataRequirement_ValueFilter"
    },
    "type":"array"
}

Nested Schema : DataRequirement_CodeFilter

Type: object

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Show Source

• _path: object Element
  Base definition for all elements in a resource.
• _searchParam: object Element
  Base definition for all elements in a resource.
• code: array code
  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.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

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

  A sequence of Unicode characters
• searchParam: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• valueSet: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_path":{
            "description":"Extensions for path",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_searchParam":{
            "description":"Extensions for searchParam",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Coding"
            },
            "type":"array"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : code

Type: array

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.

Show Source

• Array of: object Coding
  A reference to a code defined by a terminology system.

{
    "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":"#/components/schemas/Coding"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : DataRequirement_DateFilter

Type: object

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Show Source

• _path: object Element
  Base definition for all elements in a resource.
• _searchParam: object Element
  Base definition for all elements in a resource.
• _valueDateTime: object Element
  Base definition for all elements in a resource.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

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

  A sequence of Unicode characters
• searchParam: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• valueDateTime: string
  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)?)?)?$

  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.
• valueDuration: object Duration
  A length of time.
• valuePeriod: object Period
  A time period defined by a start and end date and optionally time.

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_path":{
            "description":"Extensions for path",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_searchParam":{
            "description":"Extensions for searchParam",
            "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/Duration"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : DataRequirement_Sort

Type: object

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Show Source

• _direction: object Element
  Base definition for all elements in a resource.
• _path: object Element
  Base definition for all elements in a resource.
• direction:
  Allowed Values: [ "ascending", "descending" ]

  The direction of the sort, ascending or descending.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

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

  A sequence of Unicode characters

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_path":{
            "description":"Extensions for path",
            "$ref":"#/components/schemas/Element"
        },
        "direction":{
            "description":"The direction of the sort, ascending or descending.",
            "enum":[
                "ascending",
                "descending"
            ]
        },
        "_direction":{
            "description":"Extensions for direction",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : DataRequirement_ValueFilter

Type: object

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Show Source

• _comparator: object Element
  Base definition for all elements in a resource.
• _path: object Element
  Base definition for all elements in a resource.
• _searchParam: object Element
  Base definition for all elements in a resource.
• _valueDateTime: object Element
  Base definition for all elements in a resource.
• comparator: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

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

  A sequence of Unicode characters
• searchParam: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• valueDateTime: string
  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)?)?)?$

  The value of the filter.
• valueDuration: object Duration
  A length of time.
• valuePeriod: object Period
  A time period defined by a start and end date and optionally time.

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_path":{
            "description":"Extensions for path",
            "$ref":"#/components/schemas/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":"#/components/schemas/string"
        },
        "_searchParam":{
            "description":"Extensions for searchParam",
            "$ref":"#/components/schemas/Element"
        },
        "comparator":{
            "description":"The comparator to be used to determine whether the value is matching.",
            "$ref":"#/components/schemas/code"
        },
        "_comparator":{
            "description":"Extensions for comparator",
            "$ref":"#/components/schemas/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":"#/components/schemas/Element"
        },
        "valuePeriod":{
            "description":"The value of the filter.",
            "$ref":"#/components/schemas/Period"
        },
        "valueDuration":{
            "description":"The value of the filter.",
            "$ref":"#/components/schemas/Duration"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : additionalInstruction

Type: array

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

Show Source

• Array of: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

{
    "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":"#/components/schemas/CodeableConcept"
    },
    "type":"array"
}

Nested Schema : asNeededFor

Type: array

Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).

Show Source

• Array of: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

{
    "description":"Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    },
    "type":"array"
}

Nested Schema : doseAndRate

Type: array

Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.

Show Source

• Array of: object Dosage_DoseAndRate
  Indicates how the medication is/was taken or should be taken by the patient.

{
    "description":"Depending on the resource,this is the amount of medication administered, to  be administered or typical amount to be administered.",
    "items":{
        "$ref":"#/components/schemas/Dosage_DoseAndRate"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : maxDosePerPeriod

Type: array

Upper limit on medication per unit of time.

Show Source

• Array of: object Ratio
  A relationship of two Quantity values - expressed as a numerator and a denominator.

{
    "description":"Upper limit on medication per unit of time.",
    "items":{
        "$ref":"#/components/schemas/Ratio"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : Dosage_DoseAndRate

Type: object

Indicates how the medication is/was taken or should be taken by the patient.

Show Source

• doseQuantity: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• doseRange: object Range
  A set of ordered Quantities defined by a low and high limit.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• id: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters
• modifierExtension: array modifierExtension
  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
• rateQuantity: object Quantity
  A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
• rateRange: object Range
  A set of ordered Quantities defined by a low and high limit.
• rateRatio: object Ratio
  A relationship of two Quantity values - expressed as a numerator and a denominator.
• type: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
            },
            "type":"array"
        },
        "type":{
            "description":"The kind of dose or rate specified, for example, ordered or calculated.",
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "doseRange":{
            "description":"Amount of medication per dose.",
            "$ref":"#/components/schemas/Range"
        },
        "doseQuantity":{
            "description":"Amount of medication per dose.",
            "$ref":"#/components/schemas/Quantity"
        },
        "rateRatio":{
            "description":"Amount of medication per unit of time.",
            "$ref":"#/components/schemas/Ratio"
        },
        "rateRange":{
            "description":"Amount of medication per unit of time.",
            "$ref":"#/components/schemas/Range"
        },
        "rateQuantity":{
            "description":"Amount of medication per unit of time.",
            "$ref":"#/components/schemas/Quantity"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : name

Type: array

The name of an individual to contact, some types of contact detail are usually blank.

Show Source

• Array of: object HumanName
  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.

{
    "description":"The name of an individual to contact, some types of contact detail are usually blank.",
    "items":{
        "$ref":"#/components/schemas/HumanName"
    },
    "type":"array"
}

Nested Schema : telecom

Type: array

The contact details application for the purpose defined.

Show Source

• Array of: object ContactPoint
  Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

{
    "description":"The contact details application for the purpose defined.",
    "items":{
        "$ref":"#/components/schemas/ContactPoint"
    },
    "type":"array"
}

Nested Schema : _given

Type: array

Extensions for given

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for given",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : _prefix

Type: array

Extensions for prefix

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for prefix",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : _suffix

Type: array

Extensions for suffix

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for suffix",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : given

Type: array

Given name.

Show Source

• Array of: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "description":"Given name.",
    "items":{
        "$ref":"#/components/schemas/string"
    },
    "type":"array"
}

Nested Schema : prefix

Type: array

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.

Show Source

• Array of: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/string"
    },
    "type":"array"
}

Nested Schema : suffix

Type: array

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.

Show Source

• Array of: string
  Pattern: ^^[\s\S]+$$

  A sequence of Unicode characters

{
    "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":"#/components/schemas/string"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : classifier

Type: array

Provides additional classifiers of the related artifact.

Show Source

• Array of: object CodeableConcept
  A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

{
    "description":"Provides additional classifiers of the related artifact.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : type

Type: array

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.

Show Source

• Array of: object Coding
  A reference to a code defined by a terminology system.

{
    "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":"#/components/schemas/Coding"
    },
    "type":"array"
}

Nested Schema : _event

Type: array

Extensions for event

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for event",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : event

Type: array

Identifies specific times when the event occurs.

Show Source

• Array of: string
  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)?)?)?$

  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.

{
    "description":"Identifies specific times when the event occurs.",
    "items":{
        "$ref":"#/components/schemas/dateTime"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : Timing_Repeat

Type: object

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.

Show Source

• _count: object Element
  Base definition for all elements in a resource.
• _countMax: object Element
  Base definition for all elements in a resource.
• _dayOfWeek: array _dayOfWeek
  Extensions for dayOfWeek
• _duration: object Element
  Base definition for all elements in a resource.
• _durationMax: object Element
  Base definition for all elements in a resource.
• _durationUnit: object Element
  Base definition for all elements in a resource.
• _frequency: object Element
  Base definition for all elements in a resource.
• _frequencyMax: object Element
  Base definition for all elements in a resource.
• _offset: object Element
  Base definition for all elements in a resource.
• _period: object Element
  Base definition for all elements in a resource.
• _periodMax: object Element
  Base definition for all elements in a resource.
• _periodUnit: object Element
  Base definition for all elements in a resource.
• _timeOfDay: array _timeOfDay
  Extensions for timeOfDay
• _when: array _when
  Extensions for when
• boundsDuration: object Duration
  A length of time.
• boundsPeriod: object Period
  A time period defined by a start and end date and optionally time.
• boundsRange: object Range
  A set of ordered Quantities defined by a low and high limit.
• count: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• countMax: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• dayOfWeek: array dayOfWeek
  If one or more days of week is provided, then the action happens only on the specified day(s).
• duration: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• durationMax: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• durationUnit:
  Allowed Values: [ "s", "min", "h", "d", "wk", "mo", "a" ]

  The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
• extension: array extension
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
• frequency: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• frequencyMax: number
  Pattern: ^[1-9][0-9]*$

  An integer with a value that is positive (e.g. >0)
• id: string
  Pattern: ^^[\s\S]+$$

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

  An integer with a value that is not negative (e.g. >= 0)
• period: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• periodMax: number
  Pattern: ^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$

  A rational number with implicit precision
• periodUnit:
  Allowed Values: [ "s", "min", "h", "d", "wk", "mo", "a" ]

  The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
• timeOfDay: array timeOfDay
  Specified time of day for action to take place.
• when: array when
  An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

{
    "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":"#/components/schemas/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":"#/components/schemas/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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/positiveInt"
        },
        "_count":{
            "description":"Extensions for count",
            "$ref":"#/components/schemas/Element"
        },
        "countMax":{
            "description":"If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.",
            "$ref":"#/components/schemas/positiveInt"
        },
        "_countMax":{
            "description":"Extensions for countMax",
            "$ref":"#/components/schemas/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":"#/components/schemas/decimal"
        },
        "_duration":{
            "description":"Extensions for duration",
            "$ref":"#/components/schemas/Element"
        },
        "durationMax":{
            "description":"If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.",
            "$ref":"#/components/schemas/decimal"
        },
        "_durationMax":{
            "description":"Extensions for durationMax",
            "$ref":"#/components/schemas/Element"
        },
        "durationUnit":{
            "description":"The units of time for the duration, in UCUM units\nNormal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.",
            "enum":[
                "s",
                "min",
                "h",
                "d",
                "wk",
                "mo",
                "a"
            ]
        },
        "_durationUnit":{
            "description":"Extensions for durationUnit",
            "$ref":"#/components/schemas/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":"#/components/schemas/positiveInt"
        },
        "_frequency":{
            "description":"Extensions for frequency",
            "$ref":"#/components/schemas/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":"#/components/schemas/positiveInt"
        },
        "_frequencyMax":{
            "description":"Extensions for frequencyMax",
            "$ref":"#/components/schemas/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":"#/components/schemas/decimal"
        },
        "_period":{
            "description":"Extensions for period",
            "$ref":"#/components/schemas/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":"#/components/schemas/decimal"
        },
        "_periodMax":{
            "description":"Extensions for periodMax",
            "$ref":"#/components/schemas/Element"
        },
        "periodUnit":{
            "description":"The units of time for the period in UCUM units\nNormal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.",
            "enum":[
                "s",
                "min",
                "h",
                "d",
                "wk",
                "mo",
                "a"
            ]
        },
        "_periodUnit":{
            "description":"Extensions for periodUnit",
            "$ref":"#/components/schemas/Element"
        },
        "dayOfWeek":{
            "description":"If one or more days of week is provided, then the action happens only on the specified day(s).",
            "items":{
                "$ref":"#/components/schemas/code"
            },
            "type":"array"
        },
        "_dayOfWeek":{
            "description":"Extensions for dayOfWeek",
            "items":{
                "$ref":"#/components/schemas/Element"
            },
            "type":"array"
        },
        "timeOfDay":{
            "description":"Specified time of day for action to take place.",
            "items":{
                "$ref":"#/components/schemas/time"
            },
            "type":"array"
        },
        "_timeOfDay":{
            "description":"Extensions for timeOfDay",
            "items":{
                "$ref":"#/components/schemas/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":"#/components/schemas/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":"#/components/schemas/unsignedInt"
        },
        "_offset":{
            "description":"Extensions for offset",
            "$ref":"#/components/schemas/Element"
        }
    },
    "type":"object",
    "additionalProperties":false
}

Nested Schema : _dayOfWeek

Type: array

Extensions for dayOfWeek

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for dayOfWeek",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : _timeOfDay

Type: array

Extensions for timeOfDay

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for timeOfDay",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : _when

Type: array

Extensions for when

Show Source

• Array of: object Element
  Base definition for all elements in a resource.

{
    "description":"Extensions for when",
    "items":{
        "$ref":"#/components/schemas/Element"
    },
    "type":"array"
}

Nested Schema : dayOfWeek

Type: array

If one or more days of week is provided, then the action happens only on the specified day(s).

Show Source

• Array of: string
  Pattern: ^[^\s]+( [^\s]+)*$

  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

{
    "description":"If one or more days of week is provided, then the action happens only on the specified day(s).",
    "items":{
        "$ref":"#/components/schemas/code"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : modifierExtension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of 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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : timeOfDay

Type: array

Specified time of day for action to take place.

Show Source

• Array of: string
  Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$

  A time during the day, with no date specified

{
    "description":"Specified time of day for action to take place.",
    "items":{
        "$ref":"#/components/schemas/time"
    },
    "type":"array"
}

Nested Schema : when

Type: array

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Show Source

• Array of:
  Allowed Values: [ "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" ]

{
    "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"
}

Nested Schema : data

Type: array

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.

Show Source

• Array of: object DataRequirement
  Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the 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":"#/components/schemas/DataRequirement"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : ResourceList

Type: object

One of FHIR Resource: Ref: FHIR R5 specification.

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : profile

Type: array

A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].

Show Source

• Array of: string
  Pattern: ^\S*$

  A URI that is a reference to a canonical URL on a FHIR resource

{
    "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":"#/components/schemas/canonical"
    },
    "type":"array"
}

Nested Schema : security

Type: array

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Show Source

• Array of: object Coding
  A reference to a code defined by a terminology system.

{
    "description":"Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "type":"array"
}

Nested Schema : tag

Type: array

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.

Show Source

• Array of: object Coding
  A reference to a code defined by a terminology system.

{
    "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":"#/components/schemas/Coding"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Nested Schema : extension

Type: array

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

Show Source

• Array of: object Extension
  Optional Extension Element - found in all resources.

{
    "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":"#/components/schemas/Extension"
    },
    "type":"array"
}

Back to Top