Module types

Module types 

Source

Structs§

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.
BackboneElement
Base definition for all elements that are defined inside a resource - but not those in a data type.
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
DataRequirementCodeFilter
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.
DataRequirementDateFilter
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.
DataRequirementSort
Specifies the order of the results to be returned.
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.
DosageDoseAndRate
The amount of medication administered.
Duration
A length of time.
Element
Base definition for all elements in a resource.
ElementDefinition
Captures constraints on each element within the resource, profile, or extension.
ElementDefinitionBase
Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.
ElementDefinitionBinding
Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
ElementDefinitionConstraint
Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
ElementDefinitionExample
A sample value for this element demonstrating the type of information that would typically be found in the element.
ElementDefinitionMapping
Identifies a concept from an external specification that roughly corresponds to this element.
ElementDefinitionSlicing
Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
ElementDefinitionSlicingDiscriminator
Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
ElementDefinitionType
The data type or resource that the value of this element is permitted to be.
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.
Extension
Optional Extension Element - found in all resources.
FHIRBase64Binary
A stream of bytes
FHIRBoolean
Value of “true” or “false”
FHIRCanonical
A URI that is a reference to a canonical URL on a FHIR resource
FHIRCode
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
FHIRDate
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
FHIRDateTime
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.
FHIRDecimal
A rational number with implicit precision
FHIRId
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.
FHIRInstant
An instant in time - known at least to the second
FHIRInteger
A whole number
FHIRMarkdown
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
FHIROid
An OID represented as a URI
FHIRPositiveInt
An integer with a value that is positive (e.g. >0)
FHIRString
A sequence of Unicode characters
FHIRTime
A time during the day, with no date specified
FHIRUnsignedInt
An integer with a value that is not negative (e.g. >= 0)
FHIRUri
String of characters used to identify a name or a resource
FHIRUrl
A URI that is a literal reference
FHIRUuid
A UUID, represented as a URI
FHIRXhtml
XHTML
HumanName
A human’s name with the ability to identify parts and usage.
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
MarketingStatus
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
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.
MetadataResource
Common Ancestor declaration for conformance and knowledge artifact resources.
Money
An amount of economic utility in some recognized currency.
Narrative
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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.
Population
A populatioof people with some set of grouping criteria.
ProdCharacteristic
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
ProductShelfLife
The shelf-life and storage information for a medicinal product item or container can be described using this class.
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.
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.
SubstanceAmount
Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
SubstanceAmountReferenceRange
Reference range of possible or expected values.
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.
TimingRepeat
A set of rules that describe when the event is scheduled.
TriggerDefinition
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
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).

Enums§

AnnotationAuthorTypeChoice
DataRequirementDateFilterValueTypeChoice
DataRequirementSubjectTypeChoice
DosageAsNeededTypeChoice
DosageDoseAndRateDoseTypeChoice
DosageDoseAndRateRateTypeChoice
ElementDefinitionDefaultValueTypeChoice
ElementDefinitionExampleValueTypeChoice
ElementDefinitionFixedTypeChoice
ElementDefinitionMaxValueTypeChoice
ElementDefinitionMinValueTypeChoice
ElementDefinitionPatternTypeChoice
ExtensionValueTypeChoice
PopulationAgeTypeChoice
SubstanceAmountAmountTypeChoice
TimingRepeatBoundsTypeChoice
TriggerDefinitionTimingTypeChoice
UsageContextValueTypeChoice