1. REST APIs for Oracle Healthcare Data Repository FHIR R4B
  2. Tasks
  3. DocumentManifest

Create DocumentManifest Resource

post

oracle-fhir-server/fhir/DocumentManifest

This api lets you create a new instance of the DocumentManifest resource.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/fhir+json ()
Root Schema : schema
Type: object
Show Source
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • author
    Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
  • 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.
  • content
    The list of Resources that consist of the parts of this manifest.
  • 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • identifier
    Other identifiers associated with the document manifest, including version independent identifiers.
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • 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
  • Identifier
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
  • 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
    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).
  • recipient
    A patient, practitioner, or organization for which this set of documents is intended.
  • related
    Related identifiers or resources associated with the DocumentManifest.
  • This is a DocumentManifest resource
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • 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
  • Reference
    A reference from one resource to another.
  • Narrative
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : Element
Type: object
Base definition for all elements in a resource.
Show Source
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
Nested Schema : author
Type: array
Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
Show Source
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
Nested Schema : content
Type: array
The list of Resources that consist of the parts of this manifest.
Show Source
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
Nested Schema : identifier
Type: array
Other identifiers associated with the document manifest, including version independent identifiers.
Show Source
  • Identifier
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Nested Schema : Identifier
Type: object
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Show Source
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Reference
    A reference from one resource to another.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Period
    A time period defined by a start and end date and optionally time.
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • Allowed Values: [ "usual", "official", "temp", "secondary", "old" ]
    The purpose of this identifier.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
  • security
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • 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.
  • 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
Nested Schema : recipient
Type: array
A patient, practitioner, or organization for which this set of documents is intended.
Show Source
Nested Schema : related
Type: array
Related identifiers or resources associated with the DocumentManifest.
Show Source
Nested Schema : Reference
Type: object
A reference from one resource to another.
Show Source
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Identifier
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
Nested Schema : Narrative
Type: object
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
Show Source
  • Element
    Base definition for all elements in a resource.
  • xhtml - escaped html (see specfication)
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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 : 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
  • Element
    Base definition for all elements in a resource.
  • coding
    A reference to a code defined by a terminology system.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
Nested Schema : Extension
Type: object
Optional Extension Element - found in all resources.
Show Source
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • 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.
  • Age
    A duration of time during which an organism (or a process) has existed.
  • Annotation
    A text note which also contains information about who made the statement and when.
  • Attachment
    For referring to data content defined in other formats.
  • 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).
  • Pattern: ^true|false$
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
  • Pattern: ^\S*$
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
  • 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).
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • CodeableReference
    A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
  • Coding
    A reference to a code defined by a terminology system.
  • ContactDetail
    Specifies contact information for a person or organization.
  • ContactPoint
    Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
  • Contributor
    A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
  • 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.
  • 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.
  • 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).
  • 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).
  • 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).
  • Distance
    A length - a value with a unit that is a physical distance.
  • Dosage
    Indicates how the medication is/was taken or should be taken by the patient.
  • Duration
    A length of time.
  • 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.
  • HumanName
    A human's name with the ability to identify parts and usage.
  • 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).
  • Identifier
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
  • 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).
  • 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).
  • 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).
  • Money
    An amount of economic utility in some recognized currency.
  • 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).
  • 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.
  • Period
    A time period defined by a start and end date and optionally time.
  • 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).
  • 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.
  • Range
    A set of ordered Quantities defined by a low and high limit.
  • Ratio
    A relationship of two Quantity values - expressed as a numerator and a denominator.
  • RatioRange
    A range of ratios expressed as a low and high numerator and a denominator.
  • Reference
    A reference from one resource to another.
  • RelatedArtifact
    Related artifacts such as additional documentation, justification, or bibliographic references.
  • SampledData
    A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
  • 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.
  • 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).
  • 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).
  • 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.
  • TriggerDefinition
    A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
  • 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).
  • Pattern: ^\S*$
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
  • Pattern: ^\S*$
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
  • 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).
  • 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
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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • _line
    Extensions for line
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • line
    This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
  • Period
    A time period defined by a start and end date and optionally time.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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.
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Reference
    A reference from one resource to another.
  • Pattern: ^[ \r\n\t\S]+$
    The individual responsible for making the annotation.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • 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.
  • A stream of bytes
  • extension
    May be 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.
  • A stream of bytes
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Pattern: ^[0]|([1-9][0-9]*)$
    An integer with a value that is not negative (e.g. >= 0)
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • Pattern: ^true|false$
    Value of "true" or "false"
  • 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
  • Element
    Base definition for all elements in a resource.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Period
    A time period defined by a start and end date and optionally time.
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • 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.
  • Allowed Values: [ "home", "work", "temp", "old", "mobile" ]
    Identifies the purpose for the contact point.
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • contact
    Contact details to assist a user in finding and communicating with the contributor.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • _mustSupport
    Extensions for mustSupport
  • Element
    Base definition for all elements in a resource.
  • 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
    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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • 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
    The profile of the required data, specified as the uri of the profile definition.
  • sort
    Specifies the order of the results to be returned.
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • Reference
    A reference from one resource to another.
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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").
  • 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).
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • doseAndRate
    The amount of medication administered.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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.
  • 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.
  • Ratio
    A relationship of two Quantity values - expressed as a numerator and a denominator.
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • 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).
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • Pattern: ^-?([0]|([1-9][0-9]*))$
    A whole number
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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.
  • 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.
  • 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
  • Element
    Base definition for all elements in a resource.
  • _given
    Extensions for given
  • _prefix
    Extensions for prefix
  • _suffix
    Extensions for suffix
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • given
    Given name.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Period
    A time period defined by a start and end date and optionally time.
  • 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
    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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Allowed Values: [ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ]
    Identifies the purpose for this name.
Nested Schema : Money
Type: object
An amount of economic utility in some recognized currency.
Show Source
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^-?([0]|([1-9][0-9]*))$
    A whole number
  • 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
  • Pattern: ^\S*$
    A URI that is a reference to a canonical URL on a FHIR resource
  • 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
  • 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 : Period
Type: object
A time period defined by a start and end date and optionally time.
Show Source
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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 : 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    String of characters used to identify a name or a resource
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
    May be 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.
  • 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • 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
    May be 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.
  • 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Pattern: ^[ \r\n\t\S]+$
    A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Attachment
    For referring to data content defined in other formats.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^\S*$
    A URI that is a reference to a canonical URL on a FHIR resource
  • Allowed Values: [ "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of" ]
    The type of relationship to the related artifact.
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • extension
    May be 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.
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • 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.
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • A stream of bytes
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Reference
    A reference from one resource to another.
  • 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
  • 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
    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.
  • 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
  • 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
    Extensions for event
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • event
    Identifies specific times when the event occurs.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • 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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
    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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • 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).
  • Reference
    A reference from one resource to another.
  • 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.
  • 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
  • Coding
    A reference to a code defined by a terminology system.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • CodeableConcept
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  • 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.
  • Range
    A set of ordered Quantities defined by a low and high limit.
  • Reference
    A reference from one resource to another.
Nested Schema : _line
Type: array
Extensions for line
Show Source
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
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
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
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
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
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
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
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
Nested Schema : telecom
Type: array
The contact details for the individual (if a name was provided) or the organization.
Show Source
  • 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
Nested Schema : contact
Type: array
Contact details to assist a user in finding and communicating with the contributor.
Show Source
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
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
Nested Schema : _mustSupport
Type: array
Extensions for mustSupport
Show Source
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
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
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
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
Nested Schema : profile
Type: array
The profile of the required data, specified as the uri of the profile definition.
Show Source
  • 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
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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • 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
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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
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
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
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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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.
  • Duration
    A length of time.
  • 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
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
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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Allowed Values: [ "ascending", "descending" ]
    The direction of the sort, ascending or descending.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • 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
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
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
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
Nested Schema : doseAndRate
Type: array
The amount of medication administered.
Show Source
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
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
Nested Schema : Dosage_DoseAndRate
Type: object
Indicates how the medication is/was taken or should be taken by the patient.
Show Source
  • 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.
  • Range
    A set of ordered Quantities defined by a low and high limit.
  • extension
    May be 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.
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • 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.
  • Range
    A set of ordered Quantities defined by a low and high limit.
  • Ratio
    A relationship of two Quantity values - expressed as a numerator and a denominator.
  • 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
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
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
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
Nested Schema : _given
Type: array
Extensions for given
Show Source
Nested Schema : _prefix
Type: array
Extensions for prefix
Show Source
Nested Schema : _suffix
Type: array
Extensions for suffix
Show Source
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
Nested Schema : given
Type: array
Given name.
Show Source
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
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
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : _event
Type: array
Extensions for event
Show Source
Nested Schema : event
Type: array
Identifies specific times when the event occurs.
Show Source
  • 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
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
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
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • _dayOfWeek
    Extensions for dayOfWeek
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • Element
    Base definition for all elements in a resource.
  • _timeOfDay
    Extensions for timeOfDay
  • _when
    Extensions for when
  • Duration
    A length of time.
  • Period
    A time period defined by a start and end date and optionally time.
  • Range
    A set of ordered Quantities defined by a low and high limit.
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • dayOfWeek
    If one or more days of week is provided, then the action happens only on the specified day(s).
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • Allowed Values: [ "s", "min", "h", "d", "wk", "mo", "a" ]
    The units of time for the duration, in UCUM units.
  • extension
    May be 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.
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • Pattern: ^[1-9][0-9]*$
    An integer with a value that is positive (e.g. >0)
  • Pattern: ^[ \r\n\t\S]+$
    A sequence of Unicode characters
  • 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).
  • Pattern: ^[0]|([1-9][0-9]*)$
    An integer with a value that is not negative (e.g. >= 0)
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
    A rational number with implicit precision
  • Allowed Values: [ "s", "min", "h", "d", "wk", "mo", "a" ]
    The units of time for the period in UCUM units.
  • timeOfDay
    Specified time of day for action to take place.
  • 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
Nested Schema : _timeOfDay
Type: array
Extensions for timeOfDay
Show Source
Nested Schema : _when
Type: array
Extensions for when
Show Source
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
  • 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
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
Nested Schema : timeOfDay
Type: array
Specified time of day for action to take place.
Show Source
  • 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
  • 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
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
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
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
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
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
  • 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
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
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
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
Nested Schema : coding
Type: array
A reference to a code defined by a terminology system.
Show Source
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
Back to Top

Response

201 Response

Created
Back to Top