STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

??.?? Logical Model definition - Content

A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.

??.??.1 Scope and Usage

This is NOT a resource. It is not part of the FHIR schema and cannot appear directly in FHIR instances. It is a logical model that defines a pattern adhered to by other resources. This pattern serves two purposes:

  • It offers guidance to work groups designing resources and helps ensure consistency of content created by different work groups
  • It provides a standard "view" that might be useful for implementers in processing and manipulating all resources that adhere to the same pattern. (Tooling that supports this may become available in a future release.)

??.??.2 Boundaries and Relationships

This logical model is one of three common workflow patterns. The other two patterns are Event and Request. This pattern is followed by (or is intended to be followed by a number of other FHIR resources/

??.??.3 Background and Context

This resource represents a pattern. It provides a standard list of data elements with cardinalities, data types, definitions, rationale and usage notes that will ideally be adhered to by resources that fall into the "definition" workflow category. However, adherence to this pattern is not mandatory. Not all healthcare domains are the same. Concepts that may be generally applicable (and thus are included in this standard pattern) might still not be relevant everywhere or may be sufficiently uncommon that they are more appropriate to include as extensions than as core properties of the resource. Work groups are encouraged to adjust descriptions, usage notes and rationale to be specific to their resource (e.g. use the term "protocol" or "questionnaire" rather than "definition"). As well, design notes in the comments column marked with [square brackets] identifies areas where domain variation is expected and encouraged. Other variation, including differences in names, cardinalities, data types and the decision to omit an element outright are also possible, but should be discussed with the FHIR Infrastructure work group's Workflow project to ensure the rationale for non-alignment is understood, to confirm that the deviation is necessary and to identify whether any adjustments to the pattern are appropriate.

Unlike the request and event patterns, this pattern has not yet been formally reviewed, nor applied to any of its candidate resources. It should therefore be treated as a draft for comment. Alignment with this pattern (and the content of the pattern) will be discussed by work groups as part of ballot reconciliation.

This pattern provides a linkage to the W5 list of standard data elements. Resources that adhere to this pattern should ensure their w5 mappings are consistent, as is their data element ordering.

??.??.4 Logical Model Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Definition LogicalDefinition Pattern
... identifier Σ0..1IdentifierBusiness Identifer for definition/protocol
... definition Σ0..*Reference(Definition)Instantiates protocol or definition
... parent Σ0..*Reference(Definition)Part of referenced definition
... replaces Σ0..*Reference(Definition)Request(s) replaced by this request
... status ?!Σ1..1codedraft | active | withdrawn
DefinitionStatus (Required)
... subject[x] Σ0..1Type of individual the defined service is for
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... author Σ0..1Reference(Practitioner | Organization)Who/what is requesting service
... performerType Σ0..1CodeableConceptDesired kind of service performer

doco Documentation for this format

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Definition LogicalDefinition Pattern
... identifier Σ0..1IdentifierBusiness Identifer for definition/protocol
... definition Σ0..*Reference(Definition)Instantiates protocol or definition
... parent Σ0..*Reference(Definition)Part of referenced definition
... replaces Σ0..*Reference(Definition)Request(s) replaced by this request
... status ?!Σ1..1codedraft | active | withdrawn
DefinitionStatus (Required)
... subject[x] Σ0..1Type of individual the defined service is for
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... author Σ0..1Reference(Practitioner | Organization)Who/what is requesting service
... performerType Σ0..1CodeableConceptDesired kind of service performer

doco Documentation for this format

 

??.??.4.1 Terminology Bindings

PathDefinitionTypeReference
Definition.status Codes identifying the stage lifecycle stage of a definitionRequiredDefinitionStatus
Definition.subject[x] Codes identifying the type of subject intended to be the recpient or focus of the defined action. These should ideally be consistent across definition resources.UnknownNo details provided yet
Definition.performerType Identifies types of practitioners, devices or others that are intended to perform a defined action. While the detailed constraints of relevant providers will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirableUnknownNo details provided yet