DAF Research, Release 1 Ballot

This page is part of the Data Access Framework (v1.8.0: STU 2 Ballot 2) based on FHIR v1.8.0. . 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: 6 elements (+4 nested mandatory elements)
Must-Support: 19 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition 0..*
... url S0..1uri
... name S1..1string
... status S1..1code
... kind S1..1code
... description S0..1markdown
... code S1..1code
... comment S0..1string
... base S0..1Reference(OperationDefinition)
... system S1..1boolean
... instance S1..1boolean
... parameter S0..*BackboneElement
.... name S1..1code
.... use S1..1code
.... min S1..1integer
.... max S1..1string
.... documentation S0..1string
.... type S0..1code
... daf-data-models S0..1CodeableConceptData Models (e.g PCORNet CDM, i2b2, OMOP etc) upon which queries can be composed to execute on the data mart.
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-data-models
Binding: DAF Research Data Models (extensible)
... daf-query-formats S0..1CodeableConceptQuery Formats such as (SAS,SQL,JSON etc) that are supported by the Data Mart
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-query-formats
Binding: DAF Research Query Formats (extensible)

doco Documentation for this format
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-models SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-data-models
Binding: DAF Research Data Models (extensible)
... daf-query-formats SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-query-formats
Binding: DAF Research Query Formats (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S0..1uriLogical uri to reference this operation definition (globally unique)
... version ∑0..1stringBusiness version of the operation definition
... name S1..1stringName for this operation definition (Computer friendly)
... status ?!S1..1codedraft | active | retired
Binding: PublicationStatus (required)
... kind S1..1codeoperation | query
Binding: OperationKind (required)
... experimental ?!∑0..1booleanIf for 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..*UsageContextContent intends to support these contexts
... 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 S1..1codeName used to invoke the operation
... comment S0..1stringAdditional information about use
... base S0..1Reference(OperationDefinition)Marks this as a profile of the base
... resource 0..*codeTypes this operation applies to
Binding: ResourceType (required)
... system S1..1booleanInvoke at the system level?
... type 1..1booleanInvole at the type level?
... instance S1..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..*BackboneElementFor generating overloaded methods in 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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition 0..*
... url S0..1uri
... name S1..1string
... status S1..1code
... kind S1..1code
... description S0..1markdown
... code S1..1code
... comment S0..1string
... base S0..1Reference(OperationDefinition)
... system S1..1boolean
... instance S1..1boolean
... parameter S0..*BackboneElement
.... name S1..1code
.... use S1..1code
.... min S1..1integer
.... max S1..1string
.... documentation S0..1string
.... type S0..1code
... daf-data-models S0..1CodeableConceptData Models (e.g PCORNet CDM, i2b2, OMOP etc) upon which queries can be composed to execute on the data mart.
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-data-models
Binding: DAF Research Data Models (extensible)
... daf-query-formats S0..1CodeableConceptQuery Formats such as (SAS,SQL,JSON etc) that are supported by the Data Mart
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-query-formats
Binding: DAF Research Query Formats (extensible)

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-models SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-data-models
Binding: DAF Research Data Models (extensible)
... daf-query-formats SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-query-formats
Binding: DAF Research Query Formats (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S0..1uriLogical uri to reference this operation definition (globally unique)
... version ∑0..1stringBusiness version of the operation definition
... name S1..1stringName for this operation definition (Computer friendly)
... status ?!S1..1codedraft | active | retired
Binding: PublicationStatus (required)
... kind S1..1codeoperation | query
Binding: OperationKind (required)
... experimental ?!∑0..1booleanIf for 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..*UsageContextContent intends to support these contexts
... 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 S1..1codeName used to invoke the operation
... comment S0..1stringAdditional information about use
... base S0..1Reference(OperationDefinition)Marks this as a profile of the base
... resource 0..*codeTypes this operation applies to
Binding: ResourceType (required)
... system S1..1booleanInvoke at the system level?
... type 1..1booleanInvole at the type level?
... instance S1..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..*BackboneElementFor generating overloaded methods in 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