FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Modeling and Methodology icon Work GroupMaturity Level: 4Standards Status: Partially Normative

Table of Contents

ContactDetail DataRequirement ParameterDefinition RelatedArtifact
TriggerDefinition Expression UsageContext ExtendedContactDetail
VirtualServiceDetail Availability MonetaryComponent

See also Base Definition, Examples and Mappings.

ContactDetail
Standards StatusThis element has a standards status of "Normative"
Element IdContactDetail
Definition

Specifies contact information for a person or organization.

Short DisplayContact information
Cardinality0..*
TypeDataType
Requirements

Need to track contact information in the same way across multiple resources.

Summarytrue
ContactDetail.name
Element IdContactDetail.name
Definition

The name of an individual to contact.

Short DisplayName of an individual to contact
Cardinality0..1
Typestring
Summarytrue
Comments

If there is no named individual, the telecom information is for the organization as a whole.

ContactDetail.telecom
Element IdContactDetail.telecom
Definition

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

Short DisplayContact details for individual or organization
Cardinality0..*
TypeContactPoint
Summarytrue

See also Base Definition, Examples and Mappings.

DataRequirement
Standards StatusThis element has a standards status of "Trial Use"
Element IdDataRequirement
Definition

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

Short DisplayDescribes a required data item
Cardinality0..*
TypeDataType
Summarytrue
DataRequirement.type
Element IdDataRequirement.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

Short DisplayThe type of the required data
Cardinality1..1
Terminology BindingAll FHIR Types (Required)
Typecode
Summarytrue
DataRequirement.profile
Element IdDataRequirement.profile
Definition

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

Short DisplayThe profile of the required data
Cardinality0..*
Typecanonical(StructureDefinition)
Summarytrue
DataRequirement.subject[x]
Element IdDataRequirement.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

Short DisplayE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Cardinality0..1
Terminology BindingParticipant Resource Types (Extensible)
TypeCodeableConcept|Reference(Group)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Meaning if MissingPatient
Summarytrue
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

DataRequirement.mustSupport
Element IdDataRequirement.mustSupport
Definition

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 for full details).

Short DisplayIndicates specific structure elements that are referenced by the knowledge module
Cardinality0..*
Typestring
Summarytrue
DataRequirement.codeFilter
Element IdDataRequirement.codeFilter
Definition

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.

Short DisplayWhat codes are expected
Cardinality0..*
Summarytrue
Invariants
Defined on this element
drq-1Rule Either a path or a searchParam must be provided, but not bothpath.exists() xor searchParam.exists()
DataRequirement.codeFilter.path
Element IdDataRequirement.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

Short DisplayA code-valued attribute to filter on
Cardinality0..1
Typestring
Summarytrue
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

DataRequirement.codeFilter.searchParam
Element IdDataRequirement.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

Short DisplayA coded (token) parameter to search on
Cardinality0..1
Typestring
Summarytrue
DataRequirement.codeFilter.valueSet
Element IdDataRequirement.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

Short DisplayValueset for the filter
Cardinality0..1
Typecanonical(ValueSet)
Summarytrue
DataRequirement.codeFilter.code
Element IdDataRequirement.codeFilter.code
Definition

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.

Short DisplayWhat code is expected
Cardinality0..*
TypeCoding
Summarytrue
DataRequirement.dateFilter
Element IdDataRequirement.dateFilter
Definition

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.

Short DisplayWhat dates/date ranges are expected
Cardinality0..*
Summarytrue
Invariants
Defined on this element
drq-2Rule Either a path or a searchParam must be provided, but not bothpath.exists() xor searchParam.exists()
DataRequirement.dateFilter.path
Element IdDataRequirement.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

Short DisplayA date-valued attribute to filter on
Cardinality0..1
Typestring
Summarytrue
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

DataRequirement.dateFilter.searchParam
Element IdDataRequirement.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

Short DisplayA date valued parameter to search on
Cardinality0..1
Typestring
Summarytrue
DataRequirement.dateFilter.value[x]
Element IdDataRequirement.dateFilter.value[x]
Definition

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.

Short DisplayThe value of the filter, as a Period, DateTime, or Duration value
Cardinality0..1
TypedateTime|Period|Duration
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
DataRequirement.valueFilter
Element IdDataRequirement.valueFilter
Definition

Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).

Short DisplayWhat values are expected
Cardinality0..*
Summarytrue
DataRequirement.valueFilter.path
Element IdDataRequirement.valueFilter.path
Definition

The attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.

Short DisplayAn attribute to filter on
Cardinality0..1
Typestring
Summarytrue
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

DataRequirement.valueFilter.searchParam
Element IdDataRequirement.valueFilter.searchParam
Definition

A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.

Short DisplayA parameter to search on
Cardinality0..1
Typestring
Summarytrue
DataRequirement.valueFilter.comparator
Element IdDataRequirement.valueFilter.comparator
Definition

The comparator to be used to determine whether the value is matching.

Short Displayeq | gt | lt | ge | le | sa | eb
Cardinality0..1
Terminology BindingValue Filter Comparator (Required)
Typecode
Summarytrue
DataRequirement.valueFilter.value[x]
Element IdDataRequirement.valueFilter.value[x]
Definition

The value of the filter.

Short DisplayThe value of the filter, as a Period, DateTime, or Duration value
Cardinality0..1
TypedateTime|Period|Duration
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
DataRequirement.limit
Element IdDataRequirement.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

Short DisplayNumber of results
Cardinality0..1
TypepositiveInt
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Summarytrue
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

DataRequirement.sort
Element IdDataRequirement.sort
Definition

Specifies the order of the results to be returned.

Short DisplayOrder of the results
Cardinality0..*
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Summarytrue
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

DataRequirement.sort.path
Element IdDataRequirement.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

Short DisplayThe name of the attribute to perform the sort
Cardinality1..1
Typestring
Summarytrue
DataRequirement.sort.direction
Element IdDataRequirement.sort.direction
Definition

The direction of the sort, ascending or descending.

Short Displayascending | descending
Cardinality1..1
Terminology BindingSortDirection (Required)
Typecode
Summarytrue

See also Base Definition, Examples and Mappings.

ParameterDefinition
Standards StatusThis element has a standards status of "Trial Use"
Element IdParameterDefinition
Definition

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.

Short DisplayDefinition of a parameter to a module
Cardinality0..*
TypeDataType
Summarytrue
ParameterDefinition.name
Element IdParameterDefinition.name
Definition

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

Short DisplayName used to access the parameter value
Cardinality0..1
Typecode
Summarytrue
ParameterDefinition.use
Element IdParameterDefinition.use
Definition

Whether the parameter is input or output for the module.

Short Displayin | out
Cardinality1..1
Terminology BindingOperationParameterUse (Required)
Typecode
Summarytrue
ParameterDefinition.min
Element IdParameterDefinition.min
Definition

The minimum number of times this parameter SHALL appear in the request or response.

Short DisplayMinimum cardinality
Cardinality0..1
Typeinteger
Summarytrue
ParameterDefinition.max
Element IdParameterDefinition.max
Definition

The maximum number of times this element is permitted to appear in the request or response.

Short DisplayMaximum cardinality (a number of *)
Cardinality0..1
Typestring
Summarytrue
ParameterDefinition.documentation
Element IdParameterDefinition.documentation
Definition

A brief discussion of what the parameter is for and how it is used by the module.

Short DisplayA brief description of the parameter
Cardinality0..1
Typestring
Summarytrue
ParameterDefinition.type
Element IdParameterDefinition.type
Definition

The type of the parameter.

Short DisplayWhat type of value
Cardinality1..1
Terminology BindingAll FHIR Types (Required)
Typecode
Summarytrue
ParameterDefinition.profile
Element IdParameterDefinition.profile
Definition

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

Short DisplayWhat profile the value is expected to be
Cardinality0..1
Typecanonical(StructureDefinition)
Summarytrue

See also Base Definition, Examples and Mappings.

RelatedArtifact
Standards StatusThis element has a standards status of "Trial Use"
Element IdRelatedArtifact
Definition

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

Short DisplayRelated artifacts for a knowledge resource
Cardinality0..*
TypeDataType
Requirements

Knowledge resources must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Summarytrue
Comments

Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.

RelatedArtifact.type
Element IdRelatedArtifact.type
Definition

The type of relationship to the related artifact.

Short Displaydocumentation | 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
Cardinality1..1
Terminology BindingRelatedArtifactType (Required)
Typecode
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

RelatedArtifact.classifier
Element IdRelatedArtifact.classifier
Definition

Provides additional classifiers of the related artifact.

Short DisplayAdditional classifiers
Cardinality0..*
Terminology BindingCitationArtifactClassifier (Example)
TypeCodeableConcept
Summarytrue
RelatedArtifact.label
Element IdRelatedArtifact.label
Definition

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Short DisplayShort label
Cardinality0..1
Typestring
Summarytrue
RelatedArtifact.display
Element IdRelatedArtifact.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Short DisplayBrief description of the related artifact
Cardinality0..1
Typestring
Summarytrue
RelatedArtifact.citation
Element IdRelatedArtifact.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Short DisplayBibliographic citation for the artifact
Cardinality0..1
Typemarkdown
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

RelatedArtifact.document
Element IdRelatedArtifact.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Short DisplayWhat document is being referenced
Cardinality0..1
TypeAttachment
Summarytrue
RelatedArtifact.resource
Element IdRelatedArtifact.resource
Definition

The related artifact, such as a library, value set, profile, or other knowledge resource.

Short DisplayWhat artifact is being referenced
Cardinality0..1
Typecanonical(Any)
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

RelatedArtifact.resourceReference
Element IdRelatedArtifact.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Short DisplayWhat artifact, if not a conformance resource
Cardinality0..1
TypeReference(Any)
Summarytrue
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

RelatedArtifact.publicationStatus
Element IdRelatedArtifact.publicationStatus
Definition

The publication status of the artifact being referred to.

Short Displaydraft | active | retired | unknown
Cardinality0..1
Terminology BindingPublicationStatus (Required)
Typecode
Summarytrue
RelatedArtifact.publicationDate
Element IdRelatedArtifact.publicationDate
Definition

The date of publication of the artifact being referred to.

Short DisplayDate of publication of the artifact being referred to
Cardinality0..1
Typedate
Summarytrue

See also Base Definition, Examples and Mappings.

TriggerDefinition
Standards StatusThis element has a standards status of "Trial Use"
Element IdTriggerDefinition
Definition

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

Short DisplayDefines an expected trigger for a module
Cardinality0..*
TypeDataType
Summarytrue
Comments

If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements.

Invariants
Defined on this element
trd-1Rule Either timing, or a data requirement, but not bothdata.empty() or timing.empty()
trd-2Rule A condition only if there is a data requirementcondition.exists() implies data.exists()
trd-3Rule A named event requires a name, a periodic event requires timing, and a data event requires data(type = 'named-event' implies name.exists()) and (type = 'periodic' implies timing.exists()) and (type.startsWith('data-') implies data.exists())
TriggerDefinition.type
Element IdTriggerDefinition.type
Definition

The type of triggering event.

Short Displaynamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Cardinality1..1
Terminology BindingTriggerType (Required)
Typecode
Summarytrue
TriggerDefinition.name
Element IdTriggerDefinition.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

Short DisplayName or URI that identifies the event
Cardinality0..1
Typestring
Summarytrue
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

TriggerDefinition.code
Element IdTriggerDefinition.code
Definition

A code that identifies the event.

Short DisplayCoded definition of the event
Cardinality0..1
TypeCodeableConcept
Summarytrue
TriggerDefinition.subscriptionTopic
Element IdTriggerDefinition.subscriptionTopic
Definition

A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.

Short DisplayWhat event
Cardinality0..1
Typecanonical(SubscriptionTopic)
Summarytrue
TriggerDefinition.timing[x]
Element IdTriggerDefinition.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

Short DisplayTiming of the event
Cardinality0..1
TypeTiming|Reference(Schedule)|date|dateTime
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
TriggerDefinition.data
Element IdTriggerDefinition.data
Definition

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.

Short DisplayTriggering data of the event (multiple = 'and')
Cardinality0..*
TypeDataRequirement
Summarytrue
Comments

This element shall be present for any data type trigger.

TriggerDefinition.condition
Element IdTriggerDefinition.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

Short DisplayWhether the event triggers (boolean expression)
Cardinality0..1
TypeExpression
Requirements

Need to be able to formally describe the triggering criteria.

Summarytrue
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

See also Base Definition, Examples and Mappings.

Expression
Standards StatusThis element has a standards status of "Trial Use"
Element IdExpression
Definition

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.

Short DisplayAn expression that can be used to generate a value
Cardinality0..*
TypeDataType
Summarytrue
Invariants
Defined on this element
exp-1Rule An expression or a reference must be providedexpression.exists() or reference.exists()
Expression.description
Element IdExpression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

Short DisplayNatural language description of the condition
Cardinality0..1
Typestring
Summarytrue
Expression.name
Element IdExpression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

Short DisplayShort name assigned to expression for reuse
Cardinality0..1
Typeid
Summarytrue
Expression.language
Element IdExpression.language
Definition

The media type of the language for the expression.

Short Displaytext/cql | text/fhirpath | application/x-fhir-query | etc.
Cardinality0..1
Terminology BindingExpression Language (Extensible but limited to ??)
Typecode
Requirements

The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified.

Summarytrue
Expression.expression
Element IdExpression.expression
Definition

An expression in the specified language that returns a value.

Short DisplayExpression in specified language
Cardinality0..1
Typestring
Summarytrue
Comments

If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.

Expression.reference
Element IdExpression.reference
Definition

A URI that defines where the expression is found.

Short DisplayWhere the expression is found
Cardinality0..1
Typeuri
Summarytrue
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

See also Base Definition, Examples and Mappings.

UsageContext
Standards StatusThis element has a standards status of "Trial Use"
Element IdUsageContext
Definition

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

Short DisplayDescribes the context of use for a conformance or knowledge resource
Cardinality0..*
TypeDataType
Requirements

Consumers of the resource must be able to determine the intended applicability for the resource. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.

Summarytrue
UsageContext.code
Element IdUsageContext.code
Definition

A code that identifies the type of context being specified by this usage context.

Short DisplayType of context being specified
Cardinality1..1
Terminology BindingUsageContextType (Extensible)
TypeCoding
Summarytrue
UsageContext.value[x]
Element IdUsageContext.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Short DisplayValue that defines the context
Cardinality1..1
Terminology BindingContext of Use ValueSet (Example)
TypeCodeableConcept|Quantity|Range|Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue

See also Base Definition, Examples and Mappings.

ExtendedContactDetail
Standards StatusThis element has a standards status of "Trial Use"
Element IdExtendedContactDetail
Definition

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

Short DisplayContact information
Cardinality0..*
TypeDataType
Requirements

Need to track contact and address information in the same way across multiple resources.

Summarytrue
Comments

This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.

ExtendedContactDetail.purpose
Element IdExtendedContactDetail.purpose
Definition

The purpose/type of contact.

Short DisplayThe type of contact
Cardinality0..1
Terminology BindingContact entity type icon (Preferred)
TypeCodeableConcept
Summarytrue
Comments

If no purpose is defined, then these contact details may be used for any purpose.

ExtendedContactDetail.name
Element IdExtendedContactDetail.name
Definition

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

Short DisplayName of an individual to contact
Cardinality0..*
TypeHumanName
Summarytrue
Comments

If there is no named individual, the telecom/address information is not generally monitored by a specific individual.

ExtendedContactDetail.telecom
Element IdExtendedContactDetail.telecom
Definition

The contact details application for the purpose defined.

Short DisplayContact details (e.g.phone/fax/url)
Cardinality0..*
TypeContactPoint
Summarytrue
ExtendedContactDetail.address
Element IdExtendedContactDetail.address
Definition

Address for the contact.

Short DisplayAddress for the contact
Cardinality0..1
TypeAddress
Summarytrue
Comments

More than 1 address would be for different purposes, and thus should be entered as a different entry,.

ExtendedContactDetail.organization
Element IdExtendedContactDetail.organization
Definition

This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.

Short DisplayThis contact detail is handled/monitored by a specific organization
Cardinality0..1
TypeReference(Organization)
Requirements

Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).

Summarytrue
ExtendedContactDetail.period
Element IdExtendedContactDetail.period
Definition

Period that this contact was valid for usage.

Short DisplayPeriod that this contact was valid for usage
Cardinality0..1
TypePeriod
Summarytrue
Comments

If the details have multiple periods, then enter in a new ExtendedContact with the new period.

See also Base Definition, Examples and Mappings.

VirtualServiceDetail
Standards StatusThis element has a standards status of "Trial Use"
Element IdVirtualServiceDetail
Definition

Virtual Service Contact Details.

Short DisplayVirtual Service Contact Details
Cardinality0..*
TypeDataType
Summarytrue
VirtualServiceDetail.channelType
Element IdVirtualServiceDetail.channelType
Definition

The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp).

Short DisplayChannel Type
Cardinality0..1
Terminology BindingVirtualServiceType (Example)
TypeCoding
Summarytrue
Comments

As this type defines what the virtual service is, it then defines what address and additional information might be relevant.

Some profiles could be used for specific types to define what the other values could/should be.

VirtualServiceDetail.address[x]
Element IdVirtualServiceDetail.address[x]
Definition

What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).

Short DisplayContact address/number
Cardinality0..1
Typeurl|string|ContactPoint|ExtendedContactDetail
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
VirtualServiceDetail.additionalInfo
Element IdVirtualServiceDetail.additionalInfo
Definition

Address to see alternative connection details.

Short DisplayAddress to see alternative connection details
Cardinality0..*
Typeurl
Summarytrue
Comments

This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services.

VirtualServiceDetail.maxParticipants
Element IdVirtualServiceDetail.maxParticipants
Definition

Maximum number of participants supported by the virtual service.

Short DisplayMaximum number of participants supported by the virtual service
Cardinality0..1
TypepositiveInt
Summarytrue
Comments

Some services have only a limitted number of participants permitted to connect at a time, this is typically used in "shared" virtual services that you might find on location resources.

Typically on-demand services might not have these restrictions.

VirtualServiceDetail.sessionKey
Element IdVirtualServiceDetail.sessionKey
Definition

Session Key required by the virtual service.

Short DisplaySession Key required by the virtual service
Cardinality0..1
Typestring
Summarytrue
Comments

Some services require a session key to be able to access the service once connected.

This could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call.

See also Base Definition, Examples and Mappings.

Availability
Standards StatusThis element has a standards status of "Trial Use"
Element IdAvailability
Definition

Availability data for an {item}.

Short DisplayAvailability data for an {item}
Cardinality0..*
TypeDataType
Summarytrue
Availability.availableTime
Element IdAvailability.availableTime
Definition

Times the {item} is available.

Short DisplayTimes the {item} is available
Cardinality0..*
Requirements

A collection of times that the {item} is available.

Summarytrue
Invariants
Defined on this element
av-1Rule Cannot include start/end times when selecting all day availability.allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())
Availability.availableTime.daysOfWeek
Element IdAvailability.availableTime.daysOfWeek
Definition

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

Short Displaymon | tue | wed | thu | fri | sat | sun
Cardinality0..*
Terminology BindingDaysOfWeek (Required)
Typecode
Requirements

Indicates which days of the week are available between the start and end Times.

Summarytrue
Availability.availableTime.allDay
Element IdAvailability.availableTime.allDay
Definition

Always available? i.e. 24 hour service.

Short DisplayAlways available? i.e. 24 hour service
Cardinality0..1
Typeboolean
Requirements

Is this always available? (hence times are irrelevant) i.e. 24 hour service.

Summarytrue
Availability.availableTime.availableStartTime
Element IdAvailability.availableTime.availableStartTime
Definition

Opening time of day (ignored if allDay = true).

Short DisplayOpening time of day (ignored if allDay = true)
Cardinality0..1
Typetime
Requirements

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Summarytrue
Comments

The time zone is expected to be specified or implied by the context this datatype is used.

Availability.availableTime.availableEndTime
Element IdAvailability.availableTime.availableEndTime
Definition

Closing time of day (ignored if allDay = true).

Short DisplayClosing time of day (ignored if allDay = true)
Cardinality0..1
Typetime
Requirements

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Summarytrue
Comments

The time zone is expected to be specified or implied by the context this datatype is used.

Availability.notAvailableTime
Element IdAvailability.notAvailableTime
Definition

Not available during this time due to provided reason.

Short DisplayNot available during this time due to provided reason
Cardinality0..*
Requirements

The {item} is not available during this period of time due to the provided reason.

Summarytrue
Availability.notAvailableTime.description
Element IdAvailability.notAvailableTime.description
Definition

Reason presented to the user explaining why time not available.

Short DisplayReason presented to the user explaining why time not available
Cardinality0..1
Typestring
Requirements

The reason that can be presented to the user as to why this time is not available.

Summarytrue
Comments

The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the during might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year).

e.g.2: 'Closed for maintenance over the summer' for this example you would want to include the during period, unless this was a university hospital and the "summer" period was well known, but would recommend its inclusion anyway.

Availability.notAvailableTime.during
Element IdAvailability.notAvailableTime.during
Definition

Service not available during this period.

Short DisplayService not available during this period
Cardinality0..1
TypePeriod
Requirements

The {item} is not available (seasonally or for a public holiday) during this period.

Summarytrue

See also Base Definition, Examples and Mappings.

MonetaryComponent
Standards StatusThis element has a standards status of "Trial Use"
Element IdMonetaryComponent
Definition

Availability data for an {item}.

Short DisplayAvailability data for an {item}
Cardinality0..*
TypeDataType
Summarytrue
MonetaryComponent.type
Element IdMonetaryComponent.type
Definition

base | surcharge | deduction | discount | tax | informational.

Short Displaybase | surcharge | deduction | discount | tax | informational
Cardinality1..1
Terminology BindingPriceComponentType (Required)
Typecode
Summarytrue
MonetaryComponent.code
Element IdMonetaryComponent.code
Definition

Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

Short DisplayCodes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
Cardinality0..1
Terminology BindingPriceComponentCode:
TypeCodeableConcept
Summarytrue
MonetaryComponent.factor
Element IdMonetaryComponent.factor
Definition

Factor used for calculating this component.

Short DisplayFactor used for calculating this component
Cardinality0..1
Typedecimal
Summarytrue
MonetaryComponent.amount
Element IdMonetaryComponent.amount
Definition

Explicit value amount to be used.

Short DisplayExplicit value amount to be used
Cardinality0..1
TypeMoney
Summarytrue