Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Element | «A» N | Base | Base for all elements
+ Rule: All FHIR elements must have a @value or children Elements defined in Ancestors: |
|
id | C | 0..1 | string | Unique id for inter-element referencing
|
extension | 0..* | Extension | Additional content defined by implementations
|
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BackboneElement | «A» N | Element | Base for elements defined inside a resource
Elements defined in Ancestors: id, extension |
|
modifierExtension | ?! Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | Σ N | Element | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Elements defined in Ancestors: id, extension |
|
use | ?! Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address
Binding: AddressUse ( Required) |
type | Σ | 0..1 | code | postal | physical | both
Binding: AddressType ( Required) |
text | Σ | 0..1 | string | Text representation of the address
|
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label |
city | Σ | 0..1 | string | Name of city, town etc.
|
district | Σ | 0..1 | string | District name (aka county)
|
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
|
postalCode | Σ | 0..1 | string | Postal code for area
|
country | Σ | 0..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code)
|
period | Σ | 0..1 | Period | Time period when address was/is in use
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Age | Σ TU | Quantity | A duration of time during which an organism (or a process) has existed
Binding: Common UCUM Codes for Age ( Extensible)
+ Rule: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive. Elements defined in Ancestors: id, extension, value, comparator, unit, system, code |
|||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Annotation | N | Element | Text node with attribution
Elements defined in Ancestors: id, extension |
|
author[x] | Σ | 0..1 | Individual responsible for the annotation
|
|
authorReference | Reference( Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made
|
text | Σ | 1..1 | markdown | The annotation - text content (as markdown)
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Attachment | N | Element | Content in a format defined elsewhere
+ Rule: If the Attachment has data, it SHALL have a contentType Elements defined in Ancestors: id, extension |
|||||
contentType | Σ C | 0..1 | code | Mime type of the content, with charset etc.
Binding: Mime Types ( Required) |
||||
language | Σ | 0..1 | code | Human language of the content (BCP-47)
Binding: All Languages ( Required)
|
||||
data | C | 0..1 | base64Binary | Data inline, base64ed
|
||||
url | Σ | 0..1 | url | Uri where the data can be found
|
||||
size | Σ | 0..1 | integer64 | Number of bytes of content (if url provided)
|
||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
|
||||
title | Σ T | 0..1 | string | Label to display in place of the data
|
||||
creation | Σ | 0..1 | dateTime | Date attachment was first created
|
||||
height | TU | 0..1 | positiveInt | Height of the image in pixels (photo/video)
|
||||
width | TU | 0..1 | positiveInt | Width of the image in pixels (photo/video)
|
||||
frames | TU | 0..1 | positiveInt | Number of frames if > 1 (photo)
|
||||
duration | TU | 0..1 | decimal | Length in seconds (audio / video)
|
||||
pages | TU | 0..1 | positiveInt | Number of printed pages
|
||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Availability | Σ TU | Element | Availability data for an {item}
Elements defined in Ancestors: id, extension |
|
availableTime | Σ C | 0..* | Element | Times the {item} is available
+ Rule: Cannot include start/end times when selecting all day availability. |
daysOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun
Binding: Days Of Week ( Required) |
allDay | Σ C | 0..1 | boolean | Always available? i.e. 24 hour service
|
availableStartTime | Σ C | 0..1 | time | Opening time of day (ignored if allDay = true)
|
availableEndTime | Σ C | 0..1 | time | Closing time of day (ignored if allDay = true)
|
notAvailableTime | Σ | 0..* | Element | Not available during this time due to provided reason
|
description | Σ | 0..1 | string | Reason presented to the user explaining why time not available
|
during | Σ | 0..1 | Period | Service not available during this period
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BackboneType | «A» N | Element | Base for datatypes that can carry modifier extensions
Elements defined in Ancestors: id, extension |
|
modifierExtension | ?! Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Base | «A» N | Base for all types and resources
|
||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeableConcept | Σ N | Element | Concept - reference to a terminology or just text
Elements defined in Ancestors: id, extension |
|
coding | Σ | 0..* | Coding | Code defined by a terminology system
|
text | Σ T | 0..1 | string | Plain text representation of the concept
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeableReference | Σ D | Element | Reference to a resource or a concept
Elements defined in Ancestors: id, extension |
|
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class)
|
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance)
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | Σ N | Element | A reference to a code defined by a terminology system
+ Warning: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text Elements defined in Ancestors: id, extension |
|
system | Σ | 0..1 | uri | Identity of the terminology system
|
version | Σ | 0..1 | string | Version of the system - if relevant
|
code | Σ C | 0..1 | code | Symbol in syntax defined by the system
|
display | Σ T C | 0..1 | string | Representation defined by the system
|
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ContactDetail | Σ N | Element | Contact information
Elements defined in Ancestors: id, extension |
|
name | Σ | 0..1 | string | Name of an individual to contact
|
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ContactPoint | Σ N | Element | Details of a Technology mediated contact point (phone, fax, email, etc.)
+ Rule: A system is required if a value is provided. Elements defined in Ancestors: id, extension |
|
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem ( Required) |
value | Σ C | 0..1 | string | The actual contact point details
|
use | ?! Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse ( Required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
|
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contributor | Σ TU | Element | Contributor information
Elements defined in Ancestors: id, extension |
|
type | Σ | 1..1 | code | author | editor | reviewer | endorser
Binding: ContributorType ( Required) |
name | Σ | 1..1 | string | Who contributed the content
|
contact | Σ | 0..* | ContactDetail | Contact details of the contributor
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Count | Σ TU | Quantity | A measured or measurable amount
+ Rule: There SHALL be a code with a value of "1" if there is a value. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number. Elements defined in Ancestors: id, extension, value, comparator, unit, system, code |
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DataRequirement | Σ TU | Element | Describes a required data item
Elements defined in Ancestors: id, extension |
|
type | Σ | 1..1 | code | The type of the required data
Binding: All FHIR Types ( Required) |
profile | Σ | 0..* | canonical( StructureDefinition) | The profile of the required data
|
subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Participant Resource Types ( Extensible) |
|
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference( Group) | |||
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
|
codeFilter | Σ C | 0..* | Element | What codes are expected
+ Rule: Either a path or a searchParam must be provided, but not both |
path | Σ C | 0..1 | string | A code-valued attribute to filter on
|
searchParam | Σ C | 0..1 | string | A coded (token) parameter to search on
|
valueSet | Σ | 0..1 | canonical( ValueSet) | ValueSet for the filter
|
code | Σ | 0..* | Coding | What code is expected
|
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected
+ Rule: Either a path or a searchParam must be provided, but not both |
path | Σ C | 0..1 | string | A date-valued attribute to filter on
|
searchParam | Σ C | 0..1 | string | A date valued parameter to search on
|
value[x] | Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value
|
|
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
valueFilter | Σ | 0..* | Element | What values are expected
|
path | Σ | 0..1 | string | An attribute to filter on
|
searchParam | Σ | 0..1 | string | A parameter to search on
|
comparator | Σ | 0..1 | code | eq | gt | lt | ge | le | sa | eb
Binding: Value Filter Comparator ( Required) |
value[x] | Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value
|
|
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | Σ | 0..1 | positiveInt | Number of results
|
sort | Σ | 0..* | Element | Order of the results
|
path | Σ | 1..1 | string | The name of the attribute to perform the sort
|
direction | Σ | 1..1 | code | ascending | descending
Binding: SortDirection ( Required) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Distance | Σ TU | Quantity | A length - a value with a unit that is a physical distance
Binding: Common UCUM Codes for Distance ( Extensible)
+ Rule: There SHALL be a code if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. Elements defined in Ancestors: id, extension, value, comparator, unit, system, code |
|||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | Σ TU | Element | How the medication is/was taken or should be taken
+ Rule: AsNeededFor can only be set if AsNeeded is empty or true Elements defined in Ancestors: id, extension, modifierExtension |
|
sequence | Σ | 0..1 | integer | The order of the dosage instructions
|
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG
|
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMED CT Additional Dosage Instructions ( Example) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions
|
timing | Σ | 0..1 | Timing | When medication should be administered
|
asNeeded | Σ C | 0..1 | boolean | Take "as needed"
|
asNeededFor | Σ C | 0..* | CodeableConcept | Take "as needed" (for x)
Binding: SNOMED CT Medication As Needed Reason Codes ( Example) |
site | Σ | 0..1 | CodeableConcept | Body site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes ( Example) |
route | Σ | 0..1 | CodeableConcept | How drug should enter body
Binding: SNOMED CT Route Codes ( Example) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication
Binding: SNOMED CT Administration Method Codes ( Example) |
doseAndRate | Σ | 0..* | Element | Amount of medication administered, to be administered or typical amount to be administered
|
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified
Binding: DoseAndRateType ( Example) |
dose[x] | Σ | 0..1 | Amount of medication per dose
|
|
doseRange | Range | |||
doseQuantity | SimpleQuantity | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time
|
|
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | SimpleQuantity | |||
maxDosePerPeriod | Σ | 0..* | Ratio | Upper limit on medication per unit of time
|
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration
|
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Duration | Σ N | Quantity | A length of time
Binding: Common UCUM Codes for Duration ( Extensible)
+ Rule: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. Elements defined in Ancestors: id, extension, value, comparator, unit, system, code |
|||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ElementDefinition | Σ N | Element | Definition of an element in a resource or extension
+ Rule: Min <= Max + Rule: if the element definition has a contentReference, it cannot have type, defaultValue, fixed, pattern, example, minValue, maxValue, maxLength, or binding + Rule: Fixed value may only be specified if there is one type + Rule: Pattern may only be specified if there is one type + Rule: Pattern and fixed are mutually exclusive + Rule: Binding can only be present for coded elements, string, and uri if using FHIR-defined types + Rule: Types must be unique by code + Rule: Constraints must be unique by key + Rule: default value and meaningWhenMissing are mutually exclusive + Rule: sliceName must be composed of proper tokens separated by "/" + Rule: Must have a modifier reason if isModifier = true + Rule: Element path SHALL be expressed as a set of '.'-separated components with each component restricted to a maximum of 64 characters and with some limits on the allowed choice of characters + Warning: The first component of the path should be UpperCamelCase. Additional components (following a '.') should be lowerCamelCase. If this syntax is not adhered to, code generation tools may be broken. Logical models may be less concerned about this implication. + Rule: sliceIsConstraining can only appear if slicename is present + Guideline: pattern[x] should be used rather than fixed[x] + Warning: Order has no meaning (and cannot be asserted to have meaning), so enforcing rules on order is improper + Warning: Mappings SHOULD be unique by key + Rule: Can't have valueAlternatives if mustHaveValue is true Elements defined in Ancestors: id, extension, modifierExtension |
|
path | Σ C | 1..1 | string | Path of the element in the hierarchy of elements
|
representation | Σ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtml
Binding: PropertyRepresentation ( Required) |
sliceName | Σ C | 0..1 | string | Name for this particular element (in a set of slices)
|
sliceIsConstraining | Σ C TU | 0..1 | boolean | If this slice definition constrains an inherited slice definition (or not)
|
label | Σ T | 0..1 | string | Name for element to display with or prompt for element
|
code | Σ | 0..* | Coding | Corresponding codes in terminologies
Binding: ElementDefinitionCode ( Example) |
slicing | Σ C | 0..1 | Element | This element is sliced - slices follow
|
discriminator | Σ | 0..* | Element | Element values that are used to distinguish the slices
|
type | Σ | 1..1 | code | value | exists | type | profile | position
Binding: DiscriminatorType ( Required) |
path | Σ | 1..1 | string | Path to element value
|
description | Σ T | 0..1 | string | Text description of how slicing works (or not)
|
ordered | Σ C | 0..1 | boolean | If elements must be in same order as slices
|
rules | Σ C | 1..1 | code | closed | open | openAtEnd
Binding: SlicingRules ( Required) |
short | Σ T | 0..1 | string | Concise definition for space-constrained presentation
|
definition | Σ T | 0..1 | markdown | Full formal definition as narrative text
|
comment | Σ T | 0..1 | markdown | Comments about the use of this element
|
requirements | Σ T | 0..1 | markdown | Why this resource has been created
|
alias | Σ T | 0..* | string | Other names
|
min | Σ C | 0..1 | unsignedInt | Minimum Cardinality
|
max | Σ C | 0..1 | string | Maximum Cardinality (a number or *)
+ Rule: Max SHALL be a number or "*" |
base | Σ | 0..1 | Element | Base definition information for tools
|
path | Σ | 1..1 | string | Path that identifies the base element
|
min | Σ | 1..1 | unsignedInt | Min cardinality of the base element
|
max | Σ | 1..1 | string | Max cardinality of the base element
|
contentReference | Σ C | 0..1 | uri | Reference to definition of content for the element
|
type | Σ C | 0..* | Element | Data type and Profile for this element
+ Rule: Aggregation may only be specified if one of the allowed types for the element is a reference + Rule: targetProfile is only allowed if the type is Reference or canonical |
code | Σ C | 1..1 | uri | Data type or Resource (reference to definition)
Binding: Element Definition Types ( Extensible) |
profile | Σ | 0..* | canonical( StructureDefinition | ImplementationGuide) | Profiles (StructureDefinition or IG) - one must apply
|
targetProfile | Σ C | 0..* | canonical( StructureDefinition | ImplementationGuide) | Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
|
aggregation | Σ C | 0..* | code | contained | referenced | bundled - how aggregated
Binding: AggregationMode ( Required) |
versioning | Σ | 0..1 | code | either | independent | specific
Binding: ReferenceVersionRules ( Required) |
defaultValue[x] | Σ C | 0..1 | * | Specified value if missing from instance
|
meaningWhenMissing | Σ T C | 0..1 | markdown | Implicit meaning when this element is missing
|
orderMeaning | Σ C | 0..1 | string | What the order of the elements means
|
fixed[x] | Σ C | 0..1 | * | Value must be exactly this
|
pattern[x] | Σ C | 0..1 | * | Value must have at least these property values
|
example | Σ C | 0..* | Element | Example value (as defined for type)
|
label | Σ T | 1..1 | string | Describes the purpose of this example
|
value[x] | Σ | 1..1 | * | Value of Example (one of allowed types)
|
minValue[x] | Σ C | 0..1 | Minimum Allowed Value (for some types)
|
|
minValueDate | date | |||
minValueDateTime | dateTime | |||
minValueInstant | instant | |||
minValueTime | time | |||
minValueDecimal | decimal | |||
minValueInteger | integer | |||
minValueInteger64 | integer64 | |||
minValuePositiveInt | positiveInt | |||
minValueUnsignedInt | unsignedInt | |||
minValueQuantity | Quantity | |||
maxValue[x] | Σ C | 0..1 | Maximum Allowed Value (for some types)
|
|
maxValueDate | date | |||
maxValueDateTime | dateTime | |||
maxValueInstant | instant | |||
maxValueTime | time | |||
maxValueDecimal | decimal | |||
maxValueInteger | integer | |||
maxValueInteger64 | integer64 | |||
maxValuePositiveInt | positiveInt | |||
maxValueUnsignedInt | unsignedInt | |||
maxValueQuantity | Quantity | |||
maxLength | Σ C | 0..1 | integer | Max length for string type data
|
condition | Σ | 0..* | id | Reference to invariant about presence
|
constraint | Σ C | 0..* | Element | Condition that must evaluate to true
+ Warning: Constraints should have an expression or else validators will not be able to enforce them + Rule: Errors cannot be suppressed |
key | Σ C | 1..1 | id | Target of 'condition' reference above
|
requirements | Σ | 0..1 | markdown | Why this constraint is necessary or appropriate
|
severity | Σ C | 1..1 | code | error | warning
Binding: ConstraintSeverity ( Required) |
suppress | Σ C TU | 0..1 | boolean | Suppress warning or hint in profile
|
human | Σ T | 1..1 | string | Human description of constraint
|
expression | Σ C | 0..1 | string | FHIRPath expression of constraint
|
source | Σ | 0..1 | canonical( StructureDefinition) | Reference to original source of constraint
|
mustHaveValue | Σ C TU | 0..1 | boolean | For primitives, that a value must be present - not replaced by an extension
|
valueAlternatives | Σ C TU | 0..* | canonical( StructureDefinition) | Extensions that are allowed to replace a primitive value
|
mustSupport | Σ | 0..1 | boolean | If the element must be supported (discouraged - see obligations)
|
isModifier | Σ C | 0..1 | boolean | If this modifies the meaning of other elements
|
isModifierReason | Σ C | 0..1 | string | Reason that this element is marked as a modifier
|
isSummary | Σ | 0..1 | boolean | Include when _summary = true?
|
binding | Σ C | 0..1 | Element | ValueSet details if this is coded
+ Rule: ValueSet SHALL start with http:// or https:// or urn: or # + Rule: binding SHALL have either description or valueSet |
strength | Σ | 1..1 | code | required | extensible | preferred | example
Binding: BindingStrength ( Required) |
description | Σ T C | 0..1 | markdown | Intended use of codes in the bound value set
|
valueSet | Σ C | 0..1 | canonical( ValueSet) | Source of value set
|
additional | Σ TU | 0..* | Element | Additional Bindings - more rules about the binding
|
purpose | Σ | 1..1 | code | maximum | minimum | required | extensible | candidate | current | preferred | ui | starter | component
Binding: Additional Binding Purpose ValueSet ( Required) |
valueSet | Σ | 1..1 | canonical( ValueSet) | The value set for the additional binding
|
documentation | Σ | 0..1 | markdown | Documentation of the purpose of use of the binding
|
shortDoco | Σ | 0..1 | string | Concise documentation - for summary tables
|
usage | Σ | 0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc.
|
any | Σ | 0..1 | boolean | Whether binding can applies to all repeats, or just one
|
mapping | Σ C | 0..* | Element | Map element to another set of definitions
|
identity | Σ C | 1..1 | id | Reference to mapping declaration
|
language | Σ | 0..1 | code | Computable language of mapping
Binding: Mime Types ( Required) |
map | Σ | 1..1 | string | Details of the mapping
|
comment | Σ | 0..1 | markdown | Comments about the mapping or its use
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Expression | Σ TU | Element | An expression that can be used to generate a value
+ Rule: An expression or a reference must be provided + Rule: The name must be a valid variable name in most computer languages Elements defined in Ancestors: id, extension |
|||||
description | Σ | 0..1 | string | Natural language description of the condition
|
||||
name | Σ C | 0..1 | code | Short name assigned to expression for reuse
|
||||
language | Σ | 0..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: Expression Language ( Extensible)
|
||||
expression | Σ C | 0..1 | string | Expression in specified language
|
||||
reference | Σ C | 0..1 | uri | Where the expression is found
|
||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExtendedContactDetail | Σ TU | Element | Contact information
Elements defined in Ancestors: id, extension |
|
purpose | Σ | 0..1 | CodeableConcept | The type of contact
Binding: Contact entity type ( Preferred) |
name | Σ | 0..* | HumanName | Name of an individual to contact
|
telecom | Σ | 0..* | ContactPoint | Contact details (e.g.phone/fax/url)
|
address | Σ | 0..1 | Address | Address for the contact
|
organization | Σ | 0..1 | Reference( Organization) | This contact detail is handled/monitored by a specific organization
|
period | Σ | 0..1 | Period | Period that this contact was valid for usage
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | N | Element | Optional Extensions Element
+ Rule: Must have either extensions or value[x], not both Elements defined in Ancestors: id, extension |
|
url | 1..1 | uri | identifies the meaning of the extension
|
|
value[x] | C | 0..1 | * | Value of extension
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | Σ N | Element | Name of a human or other living entity - parts and usage
Elements defined in Ancestors: id, extension |
|
use | ?! Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse ( Required) |
text | Σ | 0..1 | string | Text representation of the full name
|
family | Σ | 0..1 | string | Family name (often called 'Surname')
|
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | Σ | 0..* | string | Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | Σ N | Element | An identifier intended for computation
+ Warning: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason Elements defined in Ancestors: id, extension |
|
use | ?! Σ | 0..1 | code | usual | official | temp | secondary | old (If known)
Binding: IdentifierUse ( Required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier
Binding: Identifier Type Codes ( Extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value
|
value | Σ C | 0..1 | string | The value that is unique
|
period | Σ | 0..1 | Period | Time period when id is/was valid for use
|
assigner | Σ | 0..1 | Reference( Organization) | Organization that issued id (may be just text)
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MarketingStatus | Σ D | Element | 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
Elements defined in Ancestors: id, extension, modifierExtension |
|
country | Σ | 0..1 | CodeableConcept | The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
|
jurisdiction | Σ | 0..1 | CodeableConcept | Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
|
status | Σ | 1..1 | CodeableConcept | This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
|
dateRange | Σ | 0..1 | Period | The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
|
restoreDate | Σ | 0..1 | dateTime | The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Meta | Σ N | Element | Metadata about a resource
Elements defined in Ancestors: id, extension |
|
versionId | Σ | 0..1 | id | Version specific identifier
|
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
|
source | Σ | 0..1 | uri | Identifies where the resource comes from
|
profile | Σ | 0..* | canonical( StructureDefinition) | Profiles this resource claims to conform to
|
security | Σ | 0..* | Coding | Security Labels applied to this resource
Binding: All Security Labels ( Extensible) |
tag | Σ | 0..* | Coding | Tags applied to this resource
Binding: Common Tags ( Example) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MonetaryComponent | Σ TU | Element | Availability data for an {item}
Elements defined in Ancestors: id, extension |
|
type | Σ | 1..1 | code | base | surcharge | deduction | discount | tax | informational
Binding: Price Component Type ( Required) |
code | Σ | 0..1 | CodeableConcept | Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
|
factor | Σ | 0..1 | decimal | Factor used for calculating this component
|
amount | Σ | 0..1 | Money | Explicit value amount to be used
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Money | Σ N | Element | An amount of economic utility in some recognized currency
Elements defined in Ancestors: id, extension |
|
value | Σ | 0..1 | decimal | Numerical value (with implicit precision)
|
currency | Σ | 0..1 | code | ISO 4217 Currency Code
Binding: Currencies ( Required) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Narrative | N | Element | Human-readable summary of the resource (essential clinical and business information)
Elements defined in Ancestors: id, extension |
|
status | 1..1 | code | generated | extensions | additional | empty
Binding: NarrativeStatus ( Required) |
|
div | C | 1..1 | xhtml | Limited xhtml content
+ Rule: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes + Rule: The narrative SHALL have some non-whitespace content |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ParameterDefinition | Σ TU | Element | Definition of a parameter to a module
Elements defined in Ancestors: id, extension |
|
name | Σ | 0..1 | code | Name used to access the parameter value
|
use | Σ | 1..1 | code | in | out
Binding: Operation Parameter Use ( Required) |
min | Σ | 0..1 | integer | Minimum cardinality
|
max | Σ | 0..1 | string | Maximum cardinality (a number of *)
|
documentation | Σ | 0..1 | string | A brief description of the parameter
|
type | Σ | 1..1 | code | What type of value
Binding: All FHIR Types ( Required) |
profile | Σ | 0..1 | canonical( StructureDefinition) | What profile the value is expected to be
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Period | Σ N | Element | Time range defined by start and end date/time
+ Rule: If present, start SHALL have a lower or equal value than end Elements defined in Ancestors: id, extension |
|
start | Σ C | 0..1 | dateTime | Starting time with inclusive boundary
|
end | Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PrimitiveType | «A» N | DataType | Parent type for DataTypes with a simple value
Elements defined in Ancestors: id, extension |
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductShelfLife | Σ D | Element | The shelf-life and storage information for a medicinal product item or container can be described using this class
Elements defined in Ancestors: id, extension, modifierExtension |
|
type | Σ | 0..1 | CodeableConcept | This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
|
period[x] | Σ | 0..1 | The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
|
|
periodDuration | Duration | |||
periodString | string | |||
specialPrecautionsForStorage | Σ | 0..* | CodeableConcept | Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Quantity | Σ N | Element | A measured or measurable amount
+ Rule: If a code for the unit is present, the system SHALL also be present Elements defined in Ancestors: id, extension |
|
value | Σ | 0..1 | decimal | Numerical value (with implicit precision)
|
comparator | ?! Σ | 0..1 | code | < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator ( Required) |
unit | Σ T | 0..1 | string | Unit representation
|
system | Σ C | 0..1 | uri | System that defines coded unit form
|
code | Σ C | 0..1 | code | Coded form of the unit
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Range | Σ N | Element | Set of values bounded by low and high
+ Rule: If present, low SHALL have a lower value than high Elements defined in Ancestors: id, extension |
|
low | Σ C | 0..1 | SimpleQuantity | Low limit
|
high | Σ C | 0..1 | SimpleQuantity | High limit
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Ratio | Σ N | Element | A ratio of two Quantity values - a numerator and a denominator
+ Rule: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present Elements defined in Ancestors: id, extension |
|
numerator | Σ C | 0..1 | Quantity | Numerator value
|
denominator | Σ C | 0..1 | SimpleQuantity | Denominator value
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RatioRange | Σ TU | Element | Range of ratio values
+ Rule: One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present + Rule: If present, lowNumerator SHALL have a lower value than highNumerator Elements defined in Ancestors: id, extension |
|
lowNumerator | Σ C | 0..1 | SimpleQuantity | Low Numerator limit
|
highNumerator | Σ C | 0..1 | SimpleQuantity | High Numerator limit
|
denominator | Σ C | 0..1 | SimpleQuantity | Denominator value
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Reference | Σ N | Element | A reference from one resource to another
+ Rule: SHALL have a contained resource if a local reference is provided + Rule: At least one of reference, identifier and display SHALL be present (unless an extension is provided). Elements defined in Ancestors: id, extension |
|
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
|
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: Resource Types ( Extensible) |
identifier | Σ C | 0..1 | Identifier | Logical reference, when literal reference is not known
|
display | Σ T C | 0..1 | string | Text alternative for the resource
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedArtifact | Σ TU | Element | Related artifacts for a knowledge resource
Elements defined in Ancestors: id, extension |
|
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType ( Required) |
classifier | Σ | 0..* | CodeableConcept | Additional classifiers
Binding: Citation Artifact Classifier ( Example) |
label | Σ | 0..1 | string | Short label
|
display | Σ | 0..1 | string | Brief description of the related artifact
|
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
|
document | Σ | 0..1 | Attachment | What document is being referenced
|
resource | Σ | 0..1 | canonical( Any) | What artifact is being referenced
|
resourceReference | Σ | 0..1 | Reference( Any) | What artifact, if not a conformance resource
|
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown
Binding: PublicationStatus ( Required) |
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SampledData | TU | Element | A series of measurements taken by a device
+ Rule: A SampledData SAHLL have either an interval and offsets but not both Elements defined in Ancestors: id, extension |
|
origin | Σ | 1..1 | SimpleQuantity | Zero value and units
|
interval | Σ C | 0..1 | decimal | Number of intervalUnits between samples
|
intervalUnit | Σ | 1..1 | code | The measurement unit of the interval between samples
Binding: UCUM Codes ( Required) |
factor | Σ | 0..1 | decimal | Multiply data by this before adding to origin
|
lowerLimit | Σ | 0..1 | decimal | Lower limit of detection
|
upperLimit | Σ | 0..1 | decimal | Upper limit of detection
|
dimensions | Σ | 1..1 | positiveInt | Number of sample points at each time point
|
codeMap | 0..1 | canonical( ConceptMap) | Defines the codes used in the data
|
|
offsets | C | 0..1 | string | Offsets, typically in time, at which data values were taken
|
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L", or another code
|
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Signature | TU | Element | A Signature - XML DigSig, JWS, Graphical image of signature, etc.
Elements defined in Ancestors: id, extension |
|
type | Σ | 0..* | Coding | Indication of the reason the entity signed the object(s)
Binding: Signature Type Codes ( Preferred) |
when | Σ | 0..1 | instant | When the signature was created
|
who | Σ | 0..1 | Reference( Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who signed
|
onBehalfOf | Σ | 0..1 | Reference( Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented
|
targetFormat | 0..1 | code | The technical format of the signed resources
Binding: Mime Types ( Required) |
|
sigFormat | 0..1 | code | The technical format of the signature
Binding: Mime Types ( Required) |
|
data | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.)
|
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | Σ N | Element | A timing schedule that specifies an event that may occur multiple times
Elements defined in Ancestors: id, extension, modifierExtension |
|
event | Σ | 0..* | dateTime | When the event occurs
|
repeat | Σ C | 0..1 | Element | When the event is to occur
+ Rule: if there's a duration, there needs to be duration units + Rule: if there's a period, there needs to be period units + Rule: duration SHALL be a non-negative value + Rule: period SHALL be a non-negative value + Rule: If there's a periodMax, there must be a period + Rule: If there's a durationMax, there must be a duration + Rule: If there's a countMax, there must be a count + Rule: If there's an offset, there must be a when (and not C, CM, CD, CV) + Rule: If there's a timeOfDay, there cannot be a when, or vice versa |
bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits
|
|
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
count | Σ C | 0..1 | positiveInt | Number of times to repeat
|
countMax | Σ C | 0..1 | positiveInt | Maximum number of times to repeat
|
duration | Σ C | 0..1 | decimal | How long when it happens
|
durationMax | Σ C | 0..1 | decimal | How long when it happens (Max)
|
durationUnit | Σ C | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime ( Required) |
frequency | Σ | 0..1 | positiveInt | Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
|
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period
|
period | Σ C | 0..1 | decimal | The duration to which the frequency applies. I.e. Event occurs frequency times per period
|
periodMax | Σ C | 0..1 | decimal | Upper limit of period (3-4 hours)
|
periodUnit | Σ C | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime ( Required) |
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun
Binding: Days Of Week ( Required) |
timeOfDay | Σ C | 0..* | time | Time of day for action
|
when | Σ C | 0..* | code | Code for time period of occurrence
Binding: EventTiming ( Required) |
offset | Σ C | 0..1 | unsignedInt | Minutes from event (before or after)
|
code | Σ | 0..1 | CodeableConcept | C | BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation ( Preferred) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
TriggerDefinition | Σ TU | Element | Defines an expected trigger for a module
+ Rule: Either timing, or a data requirement, but not both + Rule: A condition only if there is a data requirement + Rule: A named event requires a name, a periodic event requires timing, and a data event requires data Elements defined in Ancestors: id, extension |
|
type | Σ C | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType ( Required) |
name | Σ C | 0..1 | string | Name or URI that identifies the event
|
code | Σ | 0..1 | CodeableConcept | Coded definition of the event
|
subscriptionTopic | Σ | 0..1 | canonical( SubscriptionTopic) | What event
|
timing[x] | Σ C | 0..1 | Timing of the event
|
|
timingTiming | Timing | |||
timingReference | Reference( Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | Σ C | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
|
condition | Σ C | 0..1 | Expression | Whether the event triggers (boolean expression)
|
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
UsageContext | Σ TU | Element | Describes the context of use for a conformance or knowledge resource
Elements defined in Ancestors: id, extension |
|
code | Σ | 1..1 | Coding | Type of context being specified
Binding: UsageContextType ( Extensible) |
value[x] | Σ | 1..1 | Value that defines the context
Binding: Context of Use ValueSet ( Example) |
|
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference( PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VirtualServiceDetail | Σ TU | Element | Virtual Service Contact Details
Elements defined in Ancestors: id, extension |
|
channelType | Σ | 0..1 | Coding | Channel Type
Binding: Virtual Service Type ( Example) |
address[x] | Σ | 0..1 | Contact address/number
|
|
addressUrl | url | |||
addressString | string | |||
addressContactPoint | ContactPoint | |||
addressExtendedContactDetail | ExtendedContactDetail | |||
additionalInfo | Σ | 0..* | url | Address to see alternative connection details
|
maxParticipants | Σ | 0..1 | positiveInt | Maximum number of participants supported by the virtual service
|
sessionKey | Σ | 0..1 | string | Session Key required by the virtual service
|
Documentation for this format |
An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)
There SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
Expression:
(code.exists() or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')
A fixed quantity (no comparator)
The comparator is not used on a SimpleQuantity
Expression:
comparator.empty()