GET DiagnosticReport Resource Bundle
get
oracle-fhir-server/fhir/DiagnosticReport
This endpoint supports the retrieval of DiagnosticReport resource list.It returns Bundle of DiagnosticReport resource.
Request
Query Parameters
-
_content(optional): STRING
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): URI
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): STRING
Search on the narrative of the resource
-
assessed-condition(optional): REFERENCE
Condition assessed by genetic test
-
based-on(optional): REFERENCE
Reference to the service request.
-
category(optional): TOKEN
Which diagnostic discipline/department created the report
-
code(optional): TOKEN
Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance * [Condition](condition.html): Code for the condition * [DeviceRequest](devicerequest.html): Code for what is being requested/ordered * [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result * [FamilyMemberHistory](familymemberhistory.html): A search by a condition code * [List](list.html): What the purpose of this list is * [Medication](medication.html): Returns medications for a specific code * [MedicationAdministration](medicationadministration.html): Return administrations of this medication code * [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code * [MedicationStatement](medicationstatement.html): Return statements of this medication code * [Observation](observation.html): The code of the observation type * [Procedure](procedure.html): A code to identify a procedure * [ServiceRequest](servicerequest.html): What is being requested/ordered
-
conclusion(optional): TOKEN
A coded conclusion (interpretation/impression) on the report
-
date(optional): DATE
Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded * [CarePlan](careplan.html): Time period plan covers * [CareTeam](careteam.html): Time period team covers * [ClinicalImpression](clinicalimpression.html): When the assessment was documented * [Composition](composition.html): Composition editing time * [Consent](consent.html): When this Consent was created or indexed * [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report * [Encounter](encounter.html): A date within the period the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated * [Flag](flag.html): Time period when flag is active * [Immunization](immunization.html): Vaccination (non)-Administration Date * [List](list.html): When the list was prepared * [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period * [Procedure](procedure.html): When the procedure was performed * [RiskAssessment](riskassessment.html): When was assessment made? * [SupplyRequest](supplyrequest.html): When the request was made
-
encounter(optional): REFERENCE
Multiple Resources: * [Composition](composition.html): Context of the Composition * [DeviceRequest](devicerequest.html): Encounter during which request was created * [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made * [DocumentReference](documentreference.html): Context of the document content * [Flag](flag.html): Alert relevant during encounter * [List](list.html): Context in which list created * [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier * [Observation](observation.html): Encounter related to the observation * [Procedure](procedure.html): Encounter created as part of * [RiskAssessment](riskassessment.html): Where was assessment performed? * [ServiceRequest](servicerequest.html): An encounter in which this request is made * [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
-
identifier(optional): TOKEN
Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): External ids for this item * [CarePlan](careplan.html): External Ids for this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html): Version-independent identifier for the Composition * [Condition](condition.html): A unique identifier of the condition record * [Consent](consent.html): Identifier for this record (external references) * [DetectedIssue](detectedissue.html): Unique id for the detected issue * [DeviceRequest](devicerequest.html): Business identifier for request/order * [DiagnosticReport](diagnosticreport.html): An identifier for the report * [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents * [DocumentReference](documentreference.html): Master Version Specific Identifier * [Encounter](encounter.html): Identifier(s) by which this encounter is known * [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier * [Goal](goal.html): External Ids for this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number * [Immunization](immunization.html): Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier * [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier * [MedicationStatement](medicationstatement.html): Return statements with this external identifier * [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier * [Observation](observation.html): The unique id for a particular observation * [Procedure](procedure.html): A unique identifier for a procedure * [RiskAssessment](riskassessment.html): Unique identifier for the assessment * [ServiceRequest](servicerequest.html): Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html): External identifier * [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest * [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
-
issued(optional): DATE
When the report was issued
-
media(optional): REFERENCE
A reference to the image source.
-
patient(optional): REFERENCE
Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html): Patient or group assessed * [Composition](composition.html): Who and/or what the composition is about * [Condition](condition.html): Who has the condition? * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html): Associated patient * [DeviceRequest](devicerequest.html): Individual the service is ordered for * [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient * [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient * [DocumentManifest](documentmanifest.html): The subject of the set of documents * [DocumentReference](documentreference.html): Who/what is the subject of the document * [Encounter](encounter.html): The patient or group present at the encounter * [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for * [Flag](flag.html): The identity of a subject to list flags for * [Goal](goal.html): Who this goal is intended for * [ImagingStudy](imagingstudy.html): Who the study is about * [Immunization](immunization.html): The patient for the vaccination record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient * [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement * [Observation](observation.html): The subject that the observation is about (if patient) * [Procedure](procedure.html): Search by subject - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment apply to? * [ServiceRequest](servicerequest.html): Search by subject - a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied * [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
-
patientidentifier(optional): TOKEN
Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance * [Condition](condition.html): Code for the condition * [DeviceRequest](devicerequest.html): Code for what is being requested/ordered * [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result * [FamilyMemberHistory](familymemberhistory.html): A search by a condition code * [List](list.html): What the purpose of this list is * [Medication](medication.html): Returns medications for a specific code * [MedicationAdministration](medicationadministration.html): Return administrations of this medication code * [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code * [MedicationUsage](medicationusage.html): Return statements of this medication code * [Observation](observation.html): The code of the observation type * [Procedure](procedure.html): A code to identify a procedure * [ServiceRequest](servicerequest.html): What is being requested/ordered
-
performer(optional): REFERENCE
Who is responsible for the report
-
result(optional): REFERENCE
Link to an atomic result (observation resource)
-
results-interpreter(optional): REFERENCE
Who was the source of the report
-
specimen(optional): REFERENCE
The specimen details
-
status(optional): TOKEN
The status of the report
-
subject(optional): REFERENCE
The subject of the report
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/fhir+json
200 Response
Success
Nested Schema : schema
Type:
Show Source
object
-
_conclusion:
Element
Base definition for all elements in a resource.
-
_effectiveDateTime:
Element
Base definition for all elements in a resource.
-
_implicitRules:
Element
Base definition for all elements in a resource.
-
_issued:
Element
Base definition for all elements in a resource.
-
_language:
Element
Base definition for all elements in a resource.
-
_status:
Element
Base definition for all elements in a resource.
-
basedOn: array
basedOn
Details concerning a service requested.
-
category: array
category
A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
-
code(required):
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
conclusion: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
conclusionCode: array
conclusionCode
One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
-
contained: array
contained
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
-
effectiveDateTime: 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]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$
The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. -
effectivePeriod:
Period
A time period defined by a start and end date and optionally time.
-
encounter:
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 resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier: array
identifier
Identifiers assigned to this report by the performer or other systems.
-
imagingStudy: array
imagingStudy
One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
-
implicitRules: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
issued: 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]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
An instant in time - known at least to the second -
language: string
Pattern:
^[^\s]+(\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 -
media: array
media
A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
-
meta:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
performer: array
performer
The diagnostic service that is responsible for issuing the report.
-
presentedForm: array
presentedForm
Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
-
resourceType(required):
This is a DiagnosticReport resource
-
result: array
result
[Observations](observation.html) that are part of this diagnostic report.
-
resultsInterpreter: array
resultsInterpreter
The practitioner or organization that is responsible for the report's conclusions and interpretations.
-
specimen: array
specimen
Details about the specimens on which this diagnostic report is based.
-
status: string
Pattern:
^[^\s]+(\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 -
subject:
Reference
A reference from one resource to another.
-
text:
Narrative
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : basedOn
Type:
array
Details concerning a service requested.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : category
Type:
array
A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
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.
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:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
text: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : conclusionCode
Type:
array
One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
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.
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, and nor can they have their own independent transaction scope.
Show Source
-
Array of:
object ResourceList
One of FHIR Resource: Ref: FHIR 4.3.0 specification.
Nested Schema : Period
Type:
object
A time period defined by a start and end date and optionally time.
Show Source
-
_end:
Element
Base definition for all elements in a resource.
-
_start:
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]+)?(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 time zone 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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]+)?(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 time zone 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.
Nested Schema : Reference
Type:
object
A reference from one resource to another.
Show Source
-
_display:
Element
Base definition for all elements in a resource.
-
_reference:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
display: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier:
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
reference: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
type: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : identifier
Type:
array
Identifiers assigned to this report by the performer or other systems.
Show Source
-
Array of:
object Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Nested Schema : imagingStudy
Type:
array
One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : media
Type:
array
A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
Show Source
-
Array of:
object DiagnosticReport_Media
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
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:
Element
Base definition for all elements in a resource.
-
_source:
Element
Base definition for all elements in a resource.
-
_versionId:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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]+)?(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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : performer
Type:
array
The diagnostic service that is responsible for issuing the report.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : presentedForm
Type:
array
Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
Show Source
-
Array of:
object Attachment
For referring to data content defined in other formats.
Nested Schema : result
Type:
array
[Observations](observation.html) that are part of this diagnostic report.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : resultsInterpreter
Type:
array
The practitioner or organization that is responsible for the report's conclusions and interpretations.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : specimen
Type:
array
Details about the specimens on which this diagnostic report is based.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
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:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : Extension
Type:
object
Optional Extension Element - found in all resources.
Show Source
-
_url:
Element
Base definition for all elements in a resource.
-
_valueBase64Binary:
Element
Base definition for all elements in a resource.
-
_valueBoolean:
Element
Base definition for all elements in a resource.
-
_valueCanonical:
Element
Base definition for all elements in a resource.
-
_valueCode:
Element
Base definition for all elements in a resource.
-
_valueDate:
Element
Base definition for all elements in a resource.
-
_valueDateTime:
Element
Base definition for all elements in a resource.
-
_valueDecimal:
Element
Base definition for all elements in a resource.
-
_valueId:
Element
Base definition for all elements in a resource.
-
_valueInstant:
Element
Base definition for all elements in a resource.
-
_valueInteger:
Element
Base definition for all elements in a resource.
-
_valueMarkdown:
Element
Base definition for all elements in a resource.
-
_valueOid:
Element
Base definition for all elements in a resource.
-
_valuePositiveInt:
Element
Base definition for all elements in a resource.
-
_valueString:
Element
Base definition for all elements in a resource.
-
_valueTime:
Element
Base definition for all elements in a resource.
-
_valueUnsignedInt:
Element
Base definition for all elements in a resource.
-
_valueUri:
Element
Base definition for all elements in a resource.
-
_valueUrl:
Element
Base definition for all elements in a resource.
-
_valueUuid:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
url: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
valueAddress:
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.
-
valueAge:
Age
A duration of time during which an organism (or a process) has existed.
-
valueAnnotation:
Annotation
A text note which also contains information about who made the statement and when.
-
valueAttachment:
Attachment
For referring to data content defined in other formats.
-
valueBase64Binary: string
Pattern:
^(\s*([0-9a-zA-Z\+/=]){4}\s*)+$
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[^\s]+)*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueCodeableReference:
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
valueCoding:
Coding
A reference to a code defined by a terminology system.
-
valueContactDetail:
ContactDetail
Specifies contact information for a person or organization.
-
valueContactPoint:
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
valueContributor:
Contributor
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
-
valueCount:
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:
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]+)?(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-9]+)?([eE][+-]?[0-9]+)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueDistance:
Distance
A length - a value with a unit that is a physical distance.
-
valueDosage:
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
valueDuration:
Duration
A length of time.
-
valueExpression:
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.
-
valueHumanName:
HumanName
A human's name with the ability to identify parts and usage.
-
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:
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]+)?(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). -
valueMarkdown: string
Pattern:
^[ \r\n\t\S]+$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueMoney:
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:
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:
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:
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:
Range
A set of ordered Quantities defined by a low and high limit.
-
valueRatio:
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
valueRatioRange:
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
valueReference:
Reference
A reference from one resource to another.
-
valueRelatedArtifact:
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
valueSampledData:
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:
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:
^[ \r\n\t\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]+)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueTiming:
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:
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:
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).
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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.
Show Source
-
_city:
Element
Base definition for all elements in a resource.
-
_country:
Element
Base definition for all elements in a resource.
-
_district:
Element
Base definition for all elements in a resource.
-
_line: array
_line
Extensions for line
-
_postalCode:
Element
Base definition for all elements in a resource.
-
_state:
Element
Base definition for all elements in a resource.
-
_text:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
city: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
country: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
district: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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:
Period
A time period defined by a start and end date and optionally time.
-
postalCode: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
state: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
text: string
Pattern:
^[ \r\n\t\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.
Nested Schema : Age
Type:
object
A duration of time during which an organism (or a process) has existed.
Show Source
-
_code:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
Nested Schema : Annotation
Type:
object
A text note which also contains information about who made the statement and when.
Show Source
-
_authorString:
Element
Base definition for all elements in a resource.
-
_text:
Element
Base definition for all elements in a resource.
-
_time:
Element
Base definition for all elements in a resource.
-
authorReference:
Reference
A reference from one resource to another.
-
authorString: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
text: string
Pattern:
^[ \r\n\t\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]+)?(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 time zone 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.
Nested Schema : Attachment
Type:
object
For referring to data content defined in other formats.
Show Source
-
_contentType:
Element
Base definition for all elements in a resource.
-
_creation:
Element
Base definition for all elements in a resource.
-
_data:
Element
Base definition for all elements in a resource.
-
_hash:
Element
Base definition for all elements in a resource.
-
_language:
Element
Base definition for all elements in a resource.
-
_size:
Element
Base definition for all elements in a resource.
-
_title:
Element
Base definition for all elements in a resource.
-
_url:
Element
Base definition for all elements in a resource.
-
contentType: string
Pattern:
^[^\s]+(\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]+)?(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 time zone 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
-
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
hash: string
A stream of bytes
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
language: string
Pattern:
^[^\s]+(\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 -
size: number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0) -
title: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
url: string
Pattern:
^\S*$
A URI that is a literal reference
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:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
reference:
Reference
A reference from one resource to another.
Nested Schema : Coding
Type:
object
A reference to a code defined by a terminology system.
Show Source
-
_code:
Element
Base definition for all elements in a resource.
-
_display:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_userSelected:
Element
Base definition for all elements in a resource.
-
_version:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : ContactDetail
Type:
object
Specifies contact information for a person or organization.
Show Source
-
_name:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
name: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
telecom: array
telecom
The contact details for the individual (if a name was provided) or the organization.
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:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
_value:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
period:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : Contributor
Type:
object
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
Show Source
-
_name:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
contact: array
contact
Contact details to assist a user in finding and communicating with the contributor.
-
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
name: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
type:
Allowed Values:
[ "author", "editor", "reviewer", "endorser" ]
The type of contributor.
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:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
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:
Element
Base definition for all elements in a resource.
-
_mustSupport: array
_mustSupport
Extensions for mustSupport
-
_type:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 resolveable 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:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
subjectReference:
Reference
A reference from one resource to another.
-
type: string
Pattern:
^[^\s]+(\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
Nested Schema : Distance
Type:
object
A length - a value with a unit that is a physical distance.
Show Source
-
_code:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
Nested Schema : Dosage
Type:
object
Indicates how the medication is/was taken or should be taken by the patient.
Show Source
-
_asNeededBoolean:
Element
Base definition for all elements in a resource.
-
_patientInstruction:
Element
Base definition for all elements in a resource.
-
_sequence:
Element
Base definition for all elements in a resource.
-
_text:
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").
-
asNeededBoolean: boolean
Pattern:
^true|false$
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). -
asNeededCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
doseAndRate: array
doseAndRate
The amount of medication 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
maxDosePerAdministration:
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:
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:
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
method:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
route:
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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
timing:
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.
Nested Schema : Duration
Type:
object
A length of time.
Show Source
-
_code:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
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:
Element
Base definition for all elements in a resource.
-
_expression:
Element
Base definition for all elements in a resource.
-
_language:
Element
Base definition for all elements in a resource.
-
_name:
Element
Base definition for all elements in a resource.
-
_reference:
Element
Base definition for all elements in a resource.
-
description: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
expression: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
language:
Allowed Values:
[ "text/cql", "text/fhirpath", "application/x-fhir-query", "text/cql-identifier", "text/cql-expression" ]
The media type of the language for the expression. -
name: 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. -
reference: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
Nested Schema : HumanName
Type:
object
A human's name with the ability to identify parts and usage.
Show Source
-
_family:
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:
Element
Base definition for all elements in a resource.
-
_use:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
given: array
given
Given name.
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
period:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
use:
Allowed Values:
[ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ]
Identifies the purpose for this name.
Nested Schema : Identifier
Type:
object
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Show Source
-
_system:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
assigner:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
period:
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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : Money
Type:
object
An amount of economic utility in some recognized currency.
Show Source
-
_currency:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
currency: string
Pattern:
^[^\s]+(\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
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:
Element
Base definition for all elements in a resource.
-
_max:
Element
Base definition for all elements in a resource.
-
_min:
Element
Base definition for all elements in a resource.
-
_name:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
documentation: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
max: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
min: number
Pattern:
^-?([0]|([1-9][0-9]*))$
A whole number -
name: string
Pattern:
^[^\s]+(\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[^\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[^\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
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:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
high:
Quantity
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
low:
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.
Nested Schema : Ratio
Type:
object
A relationship of two Quantity values - expressed as a numerator and a denominator.
Show Source
-
denominator:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
numerator:
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.
Nested Schema : RatioRange
Type:
object
A range of ratios expressed as a low and high numerator and a denominator.
Show Source
-
denominator:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
lowNumerator:
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.
Nested Schema : RelatedArtifact
Type:
object
Related artifacts such as additional documentation, justification, or bibliographic references.
Show Source
-
_citation:
Element
Base definition for all elements in a resource.
-
_display:
Element
Base definition for all elements in a resource.
-
_label:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
_url:
Element
Base definition for all elements in a resource.
-
citation: string
Pattern:
^[ \r\n\t\S]+$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
display: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
document:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
label: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
resource: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
type:
Allowed Values:
[ "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of" ]
The type of relationship to the related artifact. -
url: string
Pattern:
^\S*$
A URI that is a literal reference
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:
Element
Base definition for all elements in a resource.
-
_dimensions:
Element
Base definition for all elements in a resource.
-
_factor:
Element
Base definition for all elements in a resource.
-
_lowerLimit:
Element
Base definition for all elements in a resource.
-
_period:
Element
Base definition for all elements in a resource.
-
_upperLimit:
Element
Base definition for all elements in a resource.
-
data: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
lowerLimit: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
origin(required):
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.
-
period: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
upperLimit: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision
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:
Element
Base definition for all elements in a resource.
-
_sigFormat:
Element
Base definition for all elements in a resource.
-
_targetFormat:
Element
Base definition for all elements in a resource.
-
_when:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
onBehalfOf:
Reference
A reference from one resource to another.
-
sigFormat: string
Pattern:
^[^\s]+(\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[^\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(required): 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]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
An instant in time - known at least to the second -
who(required):
Reference
A reference from one resource to another.
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:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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:
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.
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:
Element
Base definition for all elements in a resource.
-
_timingDate:
Element
Base definition for all elements in a resource.
-
_timingDateTime:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
condition:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
name: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
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]+)?(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:
Reference
A reference from one resource to another.
-
timingTiming:
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.
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):
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
valueCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueQuantity:
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:
Range
A set of ordered Quantities defined by a low and high limit.
-
valueReference:
Reference
A reference from one resource to another.
Nested Schema : _line
Type:
array
Extensions for line
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : contact
Type:
array
Contact details to assist a user in finding and communicating with the contributor.
Show Source
-
Array of:
object ContactDetail
Specifies contact information for a person or organization.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : _mustSupport
Type:
array
Extensions for mustSupport
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
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.
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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 resolveable 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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
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.
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:
Element
Base definition for all elements in a resource.
-
_searchParam:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
searchParam: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
valueSet: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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:
Element
Base definition for all elements in a resource.
-
_searchParam:
Element
Base definition for all elements in a resource.
-
_valueDateTime:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
searchParam: string
Pattern:
^[ \r\n\t\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]+)?(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:
Duration
A length of time.
-
valuePeriod:
Period
A time period defined by a start and end date and optionally time.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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:
Element
Base definition for all elements in a resource.
-
_path:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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.
Nested Schema : doseAndRate
Type:
array
The amount of medication administered.
Show Source
-
Array of:
object Dosage_DoseAndRate
Indicates how the medication is/was taken or should be taken by the patient.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
Nested Schema : Dosage_DoseAndRate
Type:
object
Indicates how the medication is/was taken or should be taken by the patient.
Show Source
-
doseQuantity:
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:
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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:
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:
Range
A set of ordered Quantities defined by a low and high limit.
-
rateRatio:
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
type:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : _given
Type:
array
Extensions for given
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _prefix
Type:
array
Extensions for prefix
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _suffix
Type:
array
Extensions for suffix
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : given
Type:
array
Given name.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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.
Nested Schema : _event
Type:
array
Extensions for event
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
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]+)?(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 time zone 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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:
Element
Base definition for all elements in a resource.
-
_countMax:
Element
Base definition for all elements in a resource.
-
_dayOfWeek: array
_dayOfWeek
Extensions for dayOfWeek
-
_duration:
Element
Base definition for all elements in a resource.
-
_durationMax:
Element
Base definition for all elements in a resource.
-
_durationUnit:
Element
Base definition for all elements in a resource.
-
_frequency:
Element
Base definition for all elements in a resource.
-
_frequencyMax:
Element
Base definition for all elements in a resource.
-
_offset:
Element
Base definition for all elements in a resource.
-
_period:
Element
Base definition for all elements in a resource.
-
_periodMax:
Element
Base definition for all elements in a resource.
-
_periodUnit:
Element
Base definition for all elements in a resource.
-
_timeOfDay: array
_timeOfDay
Extensions for timeOfDay
-
_when: array
_when
Extensions for when
-
boundsDuration:
Duration
A length of time.
-
boundsPeriod:
Period
A time period defined by a start and end date and optionally time.
-
boundsRange:
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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
durationMax: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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. -
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
periodMax: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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. -
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.
Nested Schema : _dayOfWeek
Type:
array
Extensions for dayOfWeek
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _timeOfDay
Type:
array
Extensions for timeOfDay
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _when
Type:
array
Extensions for when
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
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[^\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
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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]+)?$
A time during the day, with no date specified
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", "HS", "WAKE", "C", "CM", "CD", "CV", "AC", "ACM", "ACD", "ACV", "PC", "PCM", "PCD", "PCV" ]
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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : ResourceList
Type:
object
One of FHIR Resource: Ref: FHIR 4.3.0 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
Nested Schema : DiagnosticReport_Media
Type:
object
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
Show Source
-
_comment:
Element
Base definition for all elements in a resource.
-
comment: string
Pattern:
^[ \r\n\t\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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
link(required):
Reference
A reference from one resource to another.
-
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.
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
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.
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.
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.