Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

5.4.6 Resource OperationDefinition - Detailed Descriptions

Extension: Patient Proficiency

FHIR Infrastructure Patient Administration Work Group   Maturity Level : N 1   Normative (from v4.0.0) Trial Use Security Category : Anonymous Compartments Use Context : Not linked to any defined compartments Any
Detailed Descriptions for the elements in the OperationDefinition resource. Definition A formal computable definition Invariants
Official URL : http://hl7.org/fhir/StructureDefinition/patient-proficiency Element Id OperationDefinition Version : 5.0.0-snapshot3
draft as of an operation (on the RESTful interface) or a named query (using the search interaction). Cardinality 0..* 2021-01-02 Type DomainResource Computable Name : PatProficiency
Defined on this element opd-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation Flags : Non-Modifier name.matches('[A-Z]([A-Za-z0-9_]){0,254}') OID : 2.16.840.1.113883.4.642.5.1345

OperationDefinition.url Context of Use : Use on Element Id OperationDefinition.url ID Patient.communication, Element ID RelatedPerson.communication or Element ID Person.communication

Definition

An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target Proficiency level of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers. communication.

Cardinality

Extension Content

0..1 Type uri Requirements Allows the operation definition to be referenced by a single globally unique identifier.
  • Summary
  • true Full Structure
  • Comments XML
  • Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions . In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source JSON element to indicate where the current master source of the resource can be found.
  • All

OperationDefinition.version Summary Element Id OperationDefinition.version Definition The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Note 0..1 Comments There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version]. Element Id Definition A natural language name identifying the operation definition. This name should be usable as an identifier for Type Requirements true Comments The name is not expected to be globally unique. Type string true Comments Definition Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) true Comments
This is a business versionId, not a resource version id (see discussion Name ) Cardinality Flags Card. Type string Description & Constraints doco Summary true
. . PatProficiency OperationDefinition.name OperationDefinition.name 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
PatProficiency: Proficiency level of the module by machine processing applications such as code generation. Cardinality communication.

1..1
Use on Element ID Patient.communication, Element ID RelatedPerson.communication or Element ID Person.communication
. . string . level Support human navigation and code generation. 0..1 Summary Coding The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Invariants Affect this element inv-0 Warning Name should be usable as an identifier for proficiency level of the module by machine processing applications such as code generation communication

name.matches('[A-Z]([A-Za-z0-9_]){0,254}') Binding: LanguageAbilityProficiency OperationDefinition.title Element Id OperationDefinition.title Definition A short, descriptive, user-friendly title ( preferred ): The proficiency level for the operation definition. communication.
Cardinality

0..1
. . Summary . type This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. 0..* Coding OperationDefinition.status Element Id OperationDefinition.status The status of this operation definition. Enables tracking the life-cycle proficiency type of the content. Cardinality 1..1 Terminology Binding communication

Binding: PublicationStatus LanguageAbilityMode ( Required ) Type preferred ): The proficiency type for the communication.

code

Summary doco Documentation for this format

Allows filtering of operation definitions that are appropriate for use versus not. OperationDefinition.kind Full Structure Element Id OperationDefinition.kind Definition Whether this is an operation or a named query.

Comments Named queries are invoked differently, and have different capabilities. Element Id OperationDefinition.experimental A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Cardinality Type boolean OperationDefinition.date The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive Type true Comments Definition 0..1 true Comments Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact OperationDefinition.contact Cardinality true Comments Definition Type Comments This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language Type true Comments Definition A legal or geographic region in which 0..* CodeableConcept true Comments It may be possible for the operation definition to be used in jurisdictions other than those Cardinality Comments Definition boolean true Comments Definition Summary Cardinality Type
Cardinality Name 1..1 Terminology Binding Flags OperationKind ( Required Card. ) Type code Description & Constraints doco Summary true
. . extension OperationDefinition.experimental Definition 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
PatProficiency: Proficiency level of the communication.

0..1
Use on Element ID Patient.communication, Element ID RelatedPerson.communication or Element ID Person.communication
Requirements . . Enables experimental content to be developed following the same lifecycle that would be used . Slices for a production-level operation definition. Summary extension true Comments Allows filtering of operation definitions that are appropriate for use versus not. OperationDefinition.date Element Id 0..* Extension Definition Additional content of the operation definition changes. Cardinality defined by implementations
Slice: Unordered, Open by value:url
0..1
. . dateTime . extension:level Alternate Names Revision Date Summary Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. 0..1 Extension OperationDefinition.publisher Element Id OperationDefinition.publisher The name proficiency level of the organization or individual that published the operation definition. Cardinality communication
Type . . . string . id Requirements Helps establish the "authority/credibility" of the operation definition. May also allow for contact. 0..1 Summary id Unique id for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context. inter-element referencing
. . Element Id . OperationDefinition.contact . extension Definition Contact details to assist a user in finding and communicating with the publisher. 0..0 0..*
Type . . . ContactDetail . url Summary May be a web site, an email address, a telephone number, etc. 1..1 uri OperationDefinition.description Element Id "level" OperationDefinition.description
A free text natural language description of the operation definition from a consumer's perspective. . . . Cardinality . value[x] 0..1 1..1 markdown Coding Value of the operation definition is presumed to be the predominant language in the place the operation definition was created). extension
Binding: LanguageAbilityProficiency OperationDefinition.useContext Element Id OperationDefinition.useContext Definition ( preferred ): The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching proficiency level for appropriate operation definition instances. Cardinality the communication.

0..*
. . UsageContext . extension:type Requirements Assist in searching for appropriate content. Summary When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. 0..* Extension OperationDefinition.jurisdiction Element Id OperationDefinition.jurisdiction The proficiency type of the operation definition is intended to be used. Cardinality communication
Terminology Binding . . . Jurisdiction ( Extensible . id ) Type 0..1 Summary id Unique id for which it was originally designed or intended. inter-element referencing
. OperationDefinition.purpose . . . extension Element Id OperationDefinition.purpose Definition 0..0 Explanation of why this operation definition is needed and why it has been designed as it has.
0..1 . . . Type . url markdown This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition. 1..1 uri OperationDefinition.affectsState Element Id "type" OperationDefinition.affectsState
Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'. . . . Cardinality . value[x] 0..1 Type 1..1 Summary Coding Value of extension
Binding: What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex: Servers SHALL support POST method for all operations. Servers SHALL support GET method if all the parameters LanguageAbilityMode ( preferred ): The proficiency type for the operation are primitive or there are no parameters and the operation has affectsState = false. OperationDefinition.code communication.
Element Id
OperationDefinition.code
true . . . value[x] OperationDefinition.comment Element Id OperationDefinition.comment 0 Definition .. 0 Additional information about how to use this operation or named query. 0..1

markdown doco Documentation for this format

OperationDefinition.base XML Template Element Id OperationDefinition.base Definition Indicates that this operation definition is a constraining profile on the base.

Cardinality 0..1 Type canonical ( OperationDefinition ) Summary true Comments 
<!-- PatProficiency -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-proficiency" >
 <-- extension sliced by value:url  in the specified orderOpen-->

 <extension url="level"> I 0..1 Extension  <!-- I 0..1 The proficiency level of the communication -->
  <valueCoding><!-- I 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="type"> I 0..* Extension  <!-- I 0..* The proficiency type of the communication -->
  <valueCoding><!-- I 1..1 Coding Value of extension --></valueCoding>
 </extension>
</extension>

A constrained profile can make optional parameters required or not used and clarify documentation. JSON Template 

{ // PatProficiency
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The proficiency level of the communication // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "level", // R! 
        "valueCoding" : { Coding } // I R! Value of extension
      },
      { // The proficiency type of the communication // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCoding" : { Coding } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IThe proficiency level of the communication
    "extension" : [{ Extension }], // IThe proficiency type of the communication
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-proficiency" // R! 
  // value[x]: Value of extension: Prohibited

  }

OperationDefinition.resource Summary Element Id OperationDefinition.resource Definition The types on which this operation can be executed.

Comments If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization. Element Id Definition Indicates whether this operation or named query can be invoked at the system Type Summary Element Id OperationDefinition.instance Definition Indicates whether this operation can be invoked on a particular instance of one Type Definition Additional validation information for the out parameters - a single profile that covers all the parameters. Element Id OperationDefinition.parameter 0..* Comments
Cardinality Name 0..* Terminology Binding Flags Any defined Resource Type name Card. Type code Description & Constraints doco Summary true
. . PatProficiency OperationDefinition.system OperationDefinition.system 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
PatProficiency: Proficiency level (e.g. without needing to choose a resource type for of the context). Cardinality 1..1 Type boolean Summary true OperationDefinition.type communication.


Use on Element Id OperationDefinition.type Definition Indicates whether this operation ID Patient.communication, Element ID RelatedPerson.communication or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context). Cardinality 1..1 Element ID Person.communication
. . boolean . level true 0..1 Coding OperationDefinition.instance The proficiency level of the given types. Cardinality 1..1 Type boolean communication

Binding: Summary LanguageAbilityProficiency true ( preferred OperationDefinition.inputProfile Element Id OperationDefinition.inputProfile Definition Additional validation information for the in parameters - a single profile that covers all the parameters. ): The profile is a constraint on proficiency level for the parameters resource as a whole. communication.
Cardinality

0..1
. . canonical ( StructureDefinition . type ) Comments If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not. 0..* Coding OperationDefinition.outputProfile Element Id OperationDefinition.outputProfile The profile is a constraint on proficiency type of the parameters resource. Cardinality 0..1 Type communication

Binding: canonical LanguageAbilityMode ( StructureDefinition preferred ) Comments If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. ): The constraints expressed in the profile apply whether proficiency type for the operation is invoked by a POST wih parameters or not. communication.

OperationDefinition.parameter
Definition
The parameters doco Documentation for the operation/query. Cardinality this format

Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined. Invariants Defined on this element Full Structure opd-1

Definition Type This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type Cardinality Comments If a parameter name is used for both an input and an output parameter, the parameter should be defined twice. OperationDefinition.parameter.min 1..1 1..1 OperationDefinition.parameter.documentation Cardinality string Definition Terminology Binding opd-1 OperationDefinition.parameter.targetProfile Used when the Element Id OperationDefinition.parameter.searchType Definition 0..1 Terminology Binding Affect this element Definition OperationDefinition.parameter.binding.strength Indicates the degree Type Definition 1..1 Type OperationDefinition.parameter.referencedFrom Element Id OperationDefinition.parameter.referencedFrom 0..* Comments Resolution applies if the referenced parameter exists.
Rule Name Either a type must be provided, or parts type.exists() or part.exists() opd-2 Rule Flags A search type can only be specified for parameters of type string searchType.exists() implies type = 'string' opd-3 Rule Card. A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical') Type OperationDefinition.parameter.name Element Id OperationDefinition.parameter.name Description & Constraints The name of used to identify the parameter. doco Cardinality 1..1
. code . extension Comments 0..* Extension URL = string, with a search type), the name may be altered by http://hl7.org/fhir/StructureDefinition/patient-proficiency
PatProficiency: Proficiency level of the search modifiers. OperationDefinition.parameter.use communication.


Use on Element Id OperationDefinition.parameter.use Definition Whether this is an input ID Patient.communication, Element ID RelatedPerson.communication or an output parameter. Element ID Person.communication
1..1 . . . Slices for extension Terminology Binding OperationParameterUse ( Required ) 0..* Type Extension Additional content defined by implementations
code Slice: Unordered, Open by value:url
. . . extension:level OperationDefinition.parameter.min Element Id 0..1 Extension Definition The minimum number proficiency level of times this parameter SHALL appear in the request or response. Cardinality communication
Type . . . integer . id OperationDefinition.parameter.max Element Id OperationDefinition.parameter.max Definition The maximum number of times this element is permitted to appear in the request or response. 0..1 Cardinality id Unique id for inter-element referencing
Type . . . string . extension OperationDefinition.parameter.documentation Element Id Definition 0..0 Describes the meaning or use of this parameter.
. 0..1 . . . url Type 1..1 uri OperationDefinition.parameter.type Element Id "level" OperationDefinition.parameter.type
The type for this parameter. . . . Cardinality . value[x] 0..1 1..1 Any defined Resource or Data Type name (including "Any" and "Type") Coding Value of extension
Binding: Type LanguageAbilityProficiency code ( preferred Comments if there is no stated parameter, then ): The proficiency level for the parameter is a multi-part parameter; type and must have at least one part defined. Invariants communication.
Affect this element
. . Rule . extension:type Either a type must be provided, or parts type.exists() or part.exists() OperationDefinition.parameter.targetProfile Element Id 0..* Extension Definition The proficiency type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide. Cardinality communication
0..*
Type . . . canonical ( StructureDefinition . id ) Comments Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient). OperationDefinition.parameter.searchType How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'. 0..1 Cardinality id Unique id for inter-element referencing
SearchParamType ( Required ) . . . Type . extension code Invariants 0..0
opd-2 . . . Rule . url A search type can only be specified for parameters of type string searchType.exists() implies type = 'string' 1..1 uri OperationDefinition.parameter.binding Element Id "type" OperationDefinition.parameter.binding
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept). . . . Cardinality . value[x] 0..1 OperationDefinition.parameter.binding.strength Element Id 1..1 Coding Definition Value of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances. extension
Binding: Cardinality LanguageAbilityMode 1..1 Terminology Binding ( preferred ): The proficiency type for the communication.

BindingStrength ( Required )
Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. . . . value[x] Cardinality canonical ( ValueSet ) 0 Comments .. 0 For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.
Definition
Identifies other resource parameters within the operation invocation that are expected to resolve to doco Documentation for this resource. Cardinality format

OperationDefinition.parameter.referencedFrom.source XML Template Element Id OperationDefinition.parameter.referencedFrom.source Definition The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

Cardinality 1..1 Type string 
<!-- PatProficiency -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-proficiency" >
 <-- extension sliced by value:url  in the specified orderOpen-->

 <extension url="level"> I 0..1 Extension  <!-- I 0..1 The proficiency level of the communication -->
  <valueCoding><!-- I 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="type"> I 0..* Extension  <!-- I 0..* The proficiency type of the communication -->
  <valueCoding><!-- I 1..1 Coding Value of extension --></valueCoding>
 </extension>
</extension>

OperationDefinition.parameter.referencedFrom.sourceId JSON Template Element Id OperationDefinition.parameter.referencedFrom.sourceId Definition 

{ // PatProficiency
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The proficiency level of the communication // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "level", // R! 
        "valueCoding" : { Coding } // I R! Value of extension
      },
      { // The proficiency type of the communication // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCoding" : { Coding } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IThe proficiency level of the communication
    "extension" : [{ Extension }], // IThe proficiency type of the communication
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-proficiency" // R! 
  // value[x]: Value of extension: Prohibited

  }

The id of the element in the referencing resource that is expected to resolve to this resource.  

Cardinality 0..1 Type string

OperationDefinition.parameter.part Constraints Element Id OperationDefinition.parameter.part Definition The parts of a nested Parameter.

    Cardinality
  • ele-1 : All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()) )
    • 0..*
  • ext-1 : Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists() )
  • Type ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists() )
    • See OperationDefinition.parameter
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()) )
  • Comments ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists() )
  • Query Definitions only ele-1 : On Extension.extension.extension: All FHIR elements must have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined. @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()) )
  • Invariants ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()) )
  • Affect this element ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists() )
  • opd-1 ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists() )
    • Rule
  • Either a type ele-1 : On Extension.extension.value[x]: All FHIR elements must be provided, have a @value or parts children (xpath on Extension.extension.value[x]: type.exists() hasValue() or part.exists() (children().count() > id.count()) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()) )

OperationDefinition.overload Search Element Id OperationDefinition.overload

Comments
Definition Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets No Search Extensions defined for this operation. Cardinality 0..* resource

The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative. OperationDefinition.overload.parameterName Element Id OperationDefinition.overload.parameterName Definition Name Examples of parameter to include in overload. Cardinality 0..* Type string OperationDefinition.overload.comment this extension Element Id OperationDefinition.overload.comment Definition

Comments to go on overload. No examples found.

Cardinality 0..1 Type string