Summary
Request & Response
Diagnostics
Care Provision
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Terminology
Documents
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CanonicalResource
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
DocumentReference
Encounter
EpisodeOfCare
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
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
cnl-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
opd-5 [error]
A query operation cannot be defined at the instance level
opd-6 [error]
A query operation requires input parameters to have a search type
opd-7 [error]
Named queries always have a single output parameter named 'result' of type Bundle
url
Canonical identifier for this operation definition, represented as an absolute URI (globally unique)
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 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
cnl-1 [warning]
URL should not contain | or # - these characters make processing canonical references problematic
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier
Id
OperationDefinition.identifier
Type
Cardinality
0 - *
Definition
A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.
Comment
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.type.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.identifier.Identifier.type.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 be an absolute 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.identifier.Identifier.type.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.identifier.Identifier.type.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
Condition
cod-1
Path
OperationDefinition.identifier.Identifier.type.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
Condition
cod-1
Path
OperationDefinition.identifier.Identifier.type.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.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
OperationDefinition.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.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.identifier.Identifier.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 end 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.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
OperationDefinition.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
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 definitions that have the same url 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. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.versionAlgorithm[x]
Id
OperationDefinition.versionAlgorithm[x]
Type
Cardinality
0 - 1
Definition
Indicates the mechanism used to compare versions to determine which is more current.
Comment
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
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 no-whitespace name to ensure that it is machine-processing friendly.
Requirements
Support code generation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cnl-0
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 current state of this operation definition.
Comment
A nominal state-transition diagram can be found in the] documentation
Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
Requirements
Enables tracking the lifecycle of the content and filtering of operation definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
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
Condition
opd-5
opd-6
opd-7
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 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 last significantly changed. 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
The date is often not tracked until the resource is published, but may be present on draft content. 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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
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 responsible for the release and ongoing maintenance of 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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
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
Telecommunications form for contact point.
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
Condition
cpt-2
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.
Binding
Strength
required
Description
Use of contact point.
ValueSet
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.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
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 end 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 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.
Comment
When multiple useContexts are specified, there is no expectation that all or even 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
Binding
Strength
extensible
Description
A code that specifies a type of context being specified by a usage context.
ValueSet
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 be an absolute 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
Condition
cod-1
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
Condition
cod-1
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
Binding
Strength
example
Description
A code that defines the specific value for the context being specified.
ValueSet
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 be an absolute 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
Condition
cod-1
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
Condition
cod-1
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.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
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 be an absolute 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
Condition
cod-1
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
Condition
cod-1
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.copyright
Id
OperationDefinition.copyright
Type
Cardinality
0 - 1
Definition
A copyright statement relating to the operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation definition.
Comment
Requirements
Consumers of the operation definition must be able to determine any legal restrictions on the use of the artifact and/or its content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationDefinition.copyrightLabel
Id
OperationDefinition.copyrightLabel
Type
Cardinality
0 - 1
Definition
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Comment
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Requirements
Defines the content expected to be rendered in all representations of the artifact.
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 the GET method when the operation has affectsState = false and all required parameters for the operation are primitive.
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 label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code.
Comment
For maximum compatibility, use only lowercase ASCII characters. Note that HL7 will never define multiple operations with the same code. See [Naming Rules & Guidelines](https://confluence.hl7.org/display/FHIR/Guide+to+Designing+Resources#GuidetoDesigningResources-NamingRules&Guidelines) for the internal HL7 rules around codes, which are useful additional advice for all implementers
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, introduce new parameters (required or optional), 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
A type of resource, or a Reference (from all versions)
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
Condition
opd-5
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
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, Canonical, or a Resource
opd-4 [error]
SearchParamType can only be specified on in parameters
Condition
opd-7
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
Condition
opd-7
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
Condition
opd-6
opd-7
opd-4
Path
OperationDefinition.parameter.scope
Id
OperationDefinition.parameter.scope
Type
Cardinality
0 - *
Definition
If present, indicates that the parameter applies when the operation is being invoked at the specified level.
Comment
Binding
Strength
required
Description
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 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-7
opd-1
opd-2
opd-3
Path
OperationDefinition.parameter.allowedType
Id
OperationDefinition.parameter.allowedType
Type
Cardinality
0 - *
Definition
Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.
Comment
In previous versions of FHIR, there was an extension for this: http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type
Binding
Strength
required
Description
A list of all the 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
targetProfile
If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types
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
Condition
opd-3
Path
OperationDefinition.parameter.searchType
Id
OperationDefinition.parameter.searchType
Type
Cardinality
0 - 1
Definition
How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.
Comment
Parameters that are search parameter usually - but not always - are also defined for use with general searches, and function in the operation to filter the set of resources in scope for the operation just like the do when searching. The searchType describes how the server processes the value. For an example, see the [Evaluate Measure Operation](measure-operation-evaluate-measure.html)
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-6
opd-2
opd-4
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
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
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
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