This is the set of resources that conform to either of the profiles CRMI Operation Profile: Canonical Version Bindable (http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-canonical-version-bindable-operation) and CRMI Operation Profile: Canonical Version Bindable (http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-canonical-version-bindable-operation). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OperationDefinition | C | 0..* | Definition of an operation or a named query dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | Σ | 0..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Business version of the operation definition ele-1: All FHIR elements must have a @value or children |
name | Σ | 1..1 | string | Name for this operation definition (computer friendly) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Name for this operation definition (human friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
kind | Σ | 1..1 | code | operation | query Binding: ?? (required): Whether an operation is a normal operation or a query. ele-1: All FHIR elements must have a @value or children |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | 0..1 | markdown | Natural language description of the operation definition ele-1: All FHIR elements must have a @value or children | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for operation definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
purpose | 0..1 | markdown | Why this operation definition is defined ele-1: All FHIR elements must have a @value or children | |
affectsState | Σ | 0..1 | boolean | Whether content is changed by the operation ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | code | Name used to invoke the operation ele-1: All FHIR elements must have a @value or children |
comment | 0..1 | markdown | Additional information about use ele-1: All FHIR elements must have a @value or children | |
base | Σ | 0..1 | canonical(OperationDefinition) | Marks this as a profile of the base ele-1: All FHIR elements must have a @value or children |
resource | Σ | 0..* | code | Types this operation applies to Binding: ?? (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | boolean | Invoke at the system level? ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | boolean | Invoke at the type level? ele-1: All FHIR elements must have a @value or children |
instance | Σ | 1..1 | boolean | Invoke on an instance? ele-1: All FHIR elements must have a @value or children |
inputProfile | 0..1 | canonical(StructureDefinition) | Validation information for in parameters ele-1: All FHIR elements must have a @value or children | |
outputProfile | 0..1 | canonical(StructureDefinition) | Validation information for out parameters ele-1: All FHIR elements must have a @value or children | |
parameter | C | 0..* | BackboneElement | Parameters for the operation/query ele-1: All FHIR elements must have a @value or children opd-1: Either a type must be provided, or parts opd-2: A search type can only be specified for parameters of type string opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | 1..1 | code | Name in Parameters.parameter.name or in URL ele-1: All FHIR elements must have a @value or children | |
use | 1..1 | code | in | out Binding: ?? (required): Whether an operation parameter is an input or an output parameter. ele-1: All FHIR elements must have a @value or children | |
min | 1..1 | integer | Minimum Cardinality ele-1: All FHIR elements must have a @value or children | |
max | 1..1 | string | Maximum Cardinality (a number or *) ele-1: All FHIR elements must have a @value or children | |
documentation | 0..1 | string | Description of meaning/use ele-1: All FHIR elements must have a @value or children | |
type | 0..1 | code | What type this parameter has Binding: ?? (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. ele-1: All FHIR elements must have a @value or children | |
targetProfile | 0..* | canonical(StructureDefinition) | If type is Reference | canonical, allowed targets ele-1: All FHIR elements must have a @value or children | |
searchType | 0..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: ?? (required): Data types allowed to be used for search parameters. ele-1: All FHIR elements must have a @value or children | |
binding | 0..1 | BackboneElement | ValueSet details if this is coded ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
strength | 1..1 | code | required | extensible | preferred | example Binding: ?? (required): Indication of the degree of conformance expectations associated with a binding. ele-1: All FHIR elements must have a @value or children | |
valueSet | 1..1 | canonical(ValueSet) | Source of value set ele-1: All FHIR elements must have a @value or children | |
referencedFrom | 0..* | BackboneElement | References to this parameter ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
source | 1..1 | string | Referencing parameter ele-1: All FHIR elements must have a @value or children | |
sourceId | 0..1 | string | Element id of reference ele-1: All FHIR elements must have a @value or children | |
part | 0..* | Parts of a nested Parameter ele-1: All FHIR elements must have a @value or children | ||
overload | 0..* | BackboneElement | Define overloaded variants for when generating code ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
parameterName | 0..* | string | Name of parameter to include in overload ele-1: All FHIR elements must have a @value or children | |
comment | 0..1 | string | Comments to go on overload ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |