DAF Research Implementation Guide v2.0.0 (STU2)

This page is part of the Data Access Framework (v2.0.0: STU 2) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-daf-operationdefinition

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-operationdefinition

This profile builds on OperationDefinition.

This profile was published on Fri Aug 12 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR Infrastructure WG - Data Access Framework).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary

Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 19 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition I0..*Definition of an operation or a named query
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... daf-data-model SI1..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-data-model
Binding: DAF Research Data Models (extensible)
... daf-query-format SI1..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-query-format
Binding: DAF Research Query Formats (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriLogical URI to reference this operation definition (globally unique)
... version Σ0..1stringBusiness version of the operation definition
... name SΣ1..1stringName for this operation definition (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... kind S1..1codeoperation | query
Binding: OperationKind (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S0..1markdownNatural language description of the operation definition
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose 0..1markdownWhy this operation definition is defined
... idempotent Σ0..1booleanWhether content is unchanged by the operation
... code SΣ1..1codeName used to invoke the operation
... comment S0..1stringAdditional information about use
... base SΣ0..1Reference(OperationDefinition)Marks this as a profile of the base
... resource Σ0..*codeTypes this operation applies to
Binding: ResourceType (required)
... system SΣ1..1booleanInvoke at the system level?
... type Σ1..1booleanInvole at the type level?
... instance SΣ1..1booleanInvoke on an instance?
... parameter SI0..*BackboneElementParameters for the operation/query
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name S1..1codeName in Parameters.parameter.name or in URL
.... use S1..1codein | out
Binding: OperationParameterUse (required)
.... min S1..1integerMinimum Cardinality
.... max S1..1stringMaximum Cardinality (a number or *)
.... documentation S0..1stringDescription of meaning/use
.... type SI0..1codeWhat type this parameter has
Binding: FHIRAllTypes (required)
.... searchType I0..1codenumber | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required)
.... profile 0..1Reference(StructureDefinition)Profile on the type
.... binding I0..1BackboneElementValueSet details if this is coded
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... strength 1..1coderequired | extensible | preferred | example
Binding: BindingStrength (required)
..... valueSet[x] 1..1uri, Reference(ValueSet)Source of value set
.... part I0..*Unknown reference to #OperationDefinition:dafoperationdefinition.parameter
Parts of a nested Parameter
... overload I0..*BackboneElementDefine overloaded variants for when generating code
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... parameterName 0..*stringName of parameter to include in overload
.... comment 0..1stringComments to go on overload

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition I0..*Definition of an operation or a named query
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... daf-data-model SI1..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-data-model
Binding: DAF Research Data Models (extensible)
... daf-query-format SI1..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-query-format
Binding: DAF Research Query Formats (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriLogical URI to reference this operation definition (globally unique)
... version Σ0..1stringBusiness version of the operation definition
... name SΣ1..1stringName for this operation definition (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... kind S1..1codeoperation | query
Binding: OperationKind (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S0..1markdownNatural language description of the operation definition
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose 0..1markdownWhy this operation definition is defined
... idempotent Σ0..1booleanWhether content is unchanged by the operation
... code SΣ1..1codeName used to invoke the operation
... comment S0..1stringAdditional information about use
... base SΣ0..1Reference(OperationDefinition)Marks this as a profile of the base
... resource Σ0..*codeTypes this operation applies to
Binding: ResourceType (required)
... system SΣ1..1booleanInvoke at the system level?
... type Σ1..1booleanInvole at the type level?
... instance SΣ1..1booleanInvoke on an instance?
... parameter SI0..*BackboneElementParameters for the operation/query
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name S1..1codeName in Parameters.parameter.name or in URL
.... use S1..1codein | out
Binding: OperationParameterUse (required)
.... min S1..1integerMinimum Cardinality
.... max S1..1stringMaximum Cardinality (a number or *)
.... documentation S0..1stringDescription of meaning/use
.... type SI0..1codeWhat type this parameter has
Binding: FHIRAllTypes (required)
.... searchType I0..1codenumber | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required)
.... profile 0..1Reference(StructureDefinition)Profile on the type
.... binding I0..1BackboneElementValueSet details if this is coded
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... strength 1..1coderequired | extensible | preferred | example
Binding: BindingStrength (required)
..... valueSet[x] 1..1uri, Reference(ValueSet)Source of value set
.... part I0..*Unknown reference to #OperationDefinition:dafoperationdefinition.parameter
Parts of a nested Parameter
... overload I0..*BackboneElementDefine overloaded variants for when generating code
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... parameterName 0..*stringName of parameter to include in overload
.... comment 0..1stringComments to go on overload

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron