Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
OperationDefinition
Path
OperationDefinition
Id
OperationDefinition
Cardinality
0 - *
Definition
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
opd-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
Path
OperationDefinition.url
Id
OperationDefinition.url
Type
Cardinality
0 - 1
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 of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
Comment
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](resource.html#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](resource.html#meta) element to indicate where the current master source of the resource can be found.
Requirements
Allows the operation definition to be referenced by a single globally unique identifier.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.version
Id
OperationDefinition.version
Type
Cardinality
0 - 1
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.
Comment
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].
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.name
Id
OperationDefinition.name
Type
Cardinality
1 - 1
Definition
A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Comment
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Requirements
Support human navigation and code generation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.title
Id
OperationDefinition.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the operation definition.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.status
Id
OperationDefinition.status
Type
Cardinality
1 - 1
Definition
The status of this operation definition. Enables tracking the life-cycle of the content.
Comment
Allows filtering of operation definitions that are appropriate for use versus not.
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.kind
Id
OperationDefinition.kind
Type
Cardinality
1 - 1
Definition
Whether this is an operation or a named query.
Comment
Named queries are invoked differently, and have different capabilities.
Binding
Strength
required
Description
Whether an operation is a normal operation or a query.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.experimental
Id
OperationDefinition.experimental
Type
Cardinality
0 - 1
Definition
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.
Comment
Allows filtering of operation definitions that are appropriate for use versus not.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.date
Id
OperationDefinition.date
Type
Cardinality
0 - 1
Definition
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 content of the operation definition changes.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.publisher
Id
OperationDefinition.publisher
Type
Cardinality
0 - 1
Definition
The name of the organization or individual that published the operation definition.
Comment
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 for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.
Requirements
Helps establish the "authority/credibility" of the operation definition. May also allow for contact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact
Id
OperationDefinition.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
OperationDefinition.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
OperationDefinition.description
Id
OperationDefinition.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the operation definition from a consumer's perspective.
Comment
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 of the operation definition is presumed to be the predominant language in the place the operation definition was created).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext
Id
OperationDefinition.useContext
Type
Cardinality
0 - *
Definition
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 for appropriate operation definition instances.
Comment
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction
Id
OperationDefinition.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the operation definition is intended to be used.
Comment
It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.
Binding
Strength
extensible
Description
Countries and regions within which this artifact is targeted for use.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.purpose
Id
OperationDefinition.purpose
Type
Cardinality
0 - 1
Definition
Explanation of why this operation definition is needed and why it has been designed as it has.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.affectsState
Id
OperationDefinition.affectsState
Type
Cardinality
0 - 1
Definition
Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
Comment
What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:
1. Servers SHALL support POST method for all operations.
2. Servers SHALL support GET method if all the parameters for the operation are primitive or there are no parameters and the operation has affectsState = false.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.code
Id
OperationDefinition.code
Type
Cardinality
1 - 1
Definition
The name used to invoke the operation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.comment
Id
OperationDefinition.comment
Type
Cardinality
0 - 1
Definition
Additional information about how to use this operation or named query.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.base
Id
OperationDefinition.base
Type
Cardinality
0 - 1
Definition
Indicates that this operation definition is a constraining profile on the base.
Comment
A constrained profile can make optional parameters required or not used and clarify documentation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.resource
Id
OperationDefinition.resource
Type
Cardinality
0 - *
Definition
The types on which this operation can be executed.
Comment
If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization.
Binding
Strength
required
Description
One of the resource types defined as part of this version of FHIR.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.system
Id
OperationDefinition.system
Type
Cardinality
1 - 1
Definition
Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.type
Id
OperationDefinition.type
Type
Cardinality
1 - 1
Definition
Indicates whether this operation 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).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.instance
Id
OperationDefinition.instance
Type
Cardinality
1 - 1
Definition
Indicates whether this operation can be invoked on a particular instance of one of the given types.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.inputProfile
Id
OperationDefinition.inputProfile
Type
Cardinality
0 - 1
Definition
Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.outputProfile
Id
OperationDefinition.outputProfile
Type
Cardinality
0 - 1
Definition
Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter
Id
OperationDefinition.parameter
Type
Cardinality
0 - *
Definition
The parameters for the operation/query.
Comment
Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
opd-1 [error]
Either a type must be provided, or parts
opd-2 [error]
A search type can only be specified for parameters of type string
opd-3 [error]
A targetProfile can only be specified for parameters of type Reference or Canonical
Path
OperationDefinition.parameter.name
Id
OperationDefinition.parameter.name
Type
Cardinality
1 - 1
Definition
The name of used to identify the parameter.
Comment
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 = string, with a search type), the name may be altered by the search modifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.use
Id
OperationDefinition.parameter.use
Type
Cardinality
1 - 1
Definition
Whether this is an input or an output parameter.
Comment
If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.
Binding
Strength
required
Description
Whether an operation parameter is an input or an output parameter.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.min
Id
OperationDefinition.parameter.min
Type
Cardinality
1 - 1
Definition
The minimum number of times this parameter SHALL appear in the request or response.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.max
Id
OperationDefinition.parameter.max
Type
Cardinality
1 - 1
Definition
The maximum number of times this element is permitted to appear in the request or response.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.documentation
Id
OperationDefinition.parameter.documentation
Type
Cardinality
0 - 1
Definition
Describes the meaning or use of this parameter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.type
Id
OperationDefinition.parameter.type
Type
Cardinality
0 - 1
Definition
The type for this parameter.
Comment
if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.
Binding
Strength
required
Description
A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
opd-1
Path
OperationDefinition.parameter.targetProfile
Id
OperationDefinition.parameter.targetProfile
Type
Cardinality
0 - *
Definition
Used when the 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.
Comment
Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.searchType
Id
OperationDefinition.parameter.searchType
Type
Cardinality
0 - 1
Definition
How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
Comment
Binding
Strength
required
Description
Data types allowed to be used for search parameters.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
opd-2
Path
OperationDefinition.parameter.binding
Id
OperationDefinition.parameter.binding
Type
Cardinality
0 - 1
Definition
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
OperationDefinition.parameter.binding.strength
Id
OperationDefinition.parameter.binding.strength
Type
Cardinality
1 - 1
Definition
Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
Comment
For further discussion, see [Using Terminologies](terminologies.html).
Binding
Strength
required
Description
Indication of the degree of conformance expectations associated with a binding.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.binding.valueSet
Id
OperationDefinition.parameter.binding.valueSet
Type
Cardinality
1 - 1
Definition
Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
Comment
For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.referencedFrom
Id
OperationDefinition.parameter.referencedFrom
Type
Cardinality
0 - *
Definition
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.
Comment
Resolution applies if the referenced parameter exists.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
OperationDefinition.parameter.referencedFrom.source
Id
OperationDefinition.parameter.referencedFrom.source
Type
Cardinality
1 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.referencedFrom.sourceId
Id
OperationDefinition.parameter.referencedFrom.sourceId
Type
Cardinality
0 - 1
Definition
The id of the element in the referencing resource that is expected to resolve to this resource.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.parameter.part
Id
OperationDefinition.parameter.part
Type
Cardinality
0 - *
Definition
The parts of a nested Parameter.
Comment
Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
opd-1
Path
OperationDefinition.overload
Id
OperationDefinition.overload
Type
Cardinality
0 - *
Definition
Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
Comment
The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
OperationDefinition.overload.parameterName
Id
OperationDefinition.overload.parameterName
Type
Cardinality
0 - *
Definition
Name of parameter to include in overload.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.overload.comment
Id
OperationDefinition.overload.comment
Type
Cardinality
0 - 1
Definition
Comments to go on overload.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children