Using CQL With FHIR
2.0.0 - STU 2
Using CQL With FHIR
2.0.0 - STU 2
This page is part of the Using CQL with FHIR Implementation Guide (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfosettings | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CQLModelInfoSettings | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.42.11 | ||||
CQL ModelInfo settings expressed using FHIR Parameters
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Parameters |
0..* | Parameters | Operation Request or Response | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for parameter |
ΣC | 0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 |
   parameter:All Slices |
Content/Rules for all slices | |||
   modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 name |
Σ | 1..1 | string | Name from the definition |
 parameter:modelName |
ΣC | 1..1 | BackboneElement | What model Constraints: inv-1 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName |
 value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:modelVersion |
ΣC | 1..1 | BackboneElement | What version Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:modelNamespace |
ΣC | 0..1 | BackboneElement | What namespace Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:modelUrl |
ΣC | 1..1 | BackboneElement | What url Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:patientClassName |
ΣC | 0..1 | BackboneElement | Name of the patient class in the model Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientClassName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:patientBirthDatePropertyName |
ΣC | 0..1 | BackboneElement | Name of the birthdate property of the Patient class in the model Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientBirthDatePropertyName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:targetQualifier |
ΣC | 0..1 | BackboneElement | Model target qualifier Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetQualifier |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:targetUrl |
ΣC | 0..1 | BackboneElement | Model target url Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetUrl |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:useCqlPrimitives |
ΣC | 0..1 | BackboneElement | Map to CQL primitives? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: useCqlPrimitives |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:includeMetadata |
ΣC | 0..1 | BackboneElement | Include definitions, comments, bindings and other metadata? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: includeMetadata |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:createSliceElements |
ΣC | 0..1 | BackboneElement | Create slice and extension elements? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: createSliceElements |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:flatten |
ΣC | 0..1 | BackboneElement | Create flattened classes? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: flatten |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:dependency |
ΣC | 0..* | BackboneElement | Required model information Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: dependency |
 Slices for part |
Σ | 4..4 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
| part:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition |
| part:modelNamespace |
Σ | 1..1 | BackboneElement | Namespace of the required model (i.e. packageId) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:modelName |
Σ | 1..1 | BackboneElement | Name of the required model |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:modelVersion |
Σ | 1..1 | BackboneElement | Version of the required model |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
 part:modelUrl |
Σ | 1..1 | BackboneElement | Url of the required model |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:profile |
ΣC | 0..* | BackboneElement | Profile configuration Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: profile |
| Slices for part |
Σ | 1..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
| part:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition |
| part:url |
Σ | 1..1 | BackboneElement | Url of the profile |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: url |
| value[x] |
ΣC | 1..1 | uri | If parameter is a data type |
| part:isIncluded |
Σ | 0..1 | BackboneElement | Included in the model? |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isIncluded |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| part:isRetrievable |
Σ | 0..1 | BackboneElement | Can be the target of a retrieve expression? |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isRetrievable |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| part:label |
Σ | 0..1 | BackboneElement | Label for the class |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: label |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:primaryCodePath |
Σ | 0..1 | BackboneElement | Primary code path for the class |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: primaryCodePath |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Parameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelVersion, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrl, Parameters.parameter:useCqlPrimitives, Parameters.parameter:includeMetadata, Parameters.parameter:createSliceElements, Parameters.parameter:flatten, Parameters.parameter:dependency, Parameters.parameter:profile | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters | Operation Request or Response | |
| Slices for parameter |
0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name | |
| parameter:modelName |
1..1 | BackboneElement | What model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:modelVersion |
1..1 | BackboneElement | What version | |
| name |
1..1 | string | Name from the definition Fixed Value: modelVersion | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:modelNamespace |
0..1 | BackboneElement | What namespace | |
| name |
1..1 | string | Name from the definition Fixed Value: modelNamespace | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:modelUrl |
1..1 | BackboneElement | What url | |
| name |
1..1 | string | Name from the definition Fixed Value: modelUrl | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:patientClassName |
0..1 | BackboneElement | Name of the patient class in the model | |
| name |
1..1 | string | Name from the definition Fixed Value: patientClassName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:patientBirthDatePropertyName |
0..1 | BackboneElement | Name of the birthdate property of the Patient class in the model | |
| name |
1..1 | string | Name from the definition Fixed Value: patientBirthDatePropertyName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:targetQualifier |
0..1 | BackboneElement | Model target qualifier | |
| name |
1..1 | string | Name from the definition Fixed Value: targetQualifier | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:targetUrl |
0..1 | BackboneElement | Model target url | |
| name |
1..1 | string | Name from the definition Fixed Value: targetUrl | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:useCqlPrimitives |
0..1 | BackboneElement | Map to CQL primitives? | |
| name |
1..1 | string | Name from the definition Fixed Value: useCqlPrimitives | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:includeMetadata |
0..1 | BackboneElement | Include definitions, comments, bindings and other metadata? | |
| name |
1..1 | string | Name from the definition Fixed Value: includeMetadata | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:createSliceElements |
0..1 | BackboneElement | Create slice and extension elements? | |
| name |
1..1 | string | Name from the definition Fixed Value: createSliceElements | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:flatten |
0..1 | BackboneElement | Create flattened classes? | |
| name |
1..1 | string | Name from the definition Fixed Value: flatten | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:dependency |
0..* | BackboneElement | Required model information | |
| name |
1..1 | string | Name from the definition Fixed Value: dependency | |
| Slices for part |
4..4 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
| part:modelNamespace |
1..1 | BackboneElement | Namespace of the required model (i.e. packageId) | |
| name |
1..1 | string | Name from the definition Fixed Value: modelNamespace | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:modelName |
1..1 | BackboneElement | Name of the required model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:modelVersion |
1..1 | BackboneElement | Version of the required model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelVersion | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:modelUrl |
1..1 | BackboneElement | Url of the required model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelUrl | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:profile |
0..* | BackboneElement | Profile configuration | |
| name |
1..1 | string | Name from the definition Fixed Value: profile | |
| Slices for part |
1..5 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
| part:url |
1..1 | BackboneElement | Url of the profile | |
| name |
1..1 | string | Name from the definition Fixed Value: url | |
| value[x] |
1..1 | uri | If parameter is a data type | |
| part:isIncluded |
0..1 | BackboneElement | Included in the model? | |
| name |
1..1 | string | Name from the definition Fixed Value: isIncluded | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| part:isRetrievable |
0..1 | BackboneElement | Can be the target of a retrieve expression? | |
| name |
1..1 | string | Name from the definition Fixed Value: isRetrievable | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| part:label |
0..1 | BackboneElement | Label for the class | |
| name |
1..1 | string | Name from the definition Fixed Value: label | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:primaryCodePath |
0..1 | BackboneElement | Primary code path for the class | |
| name |
1..1 | string | Name from the definition Fixed Value: primaryCodePath | |
| value[x] |
1..1 | string | If parameter is a data type | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Parameters |
0..* | Parameters | Operation Request or Response | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| Slices for parameter |
ΣC | 0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 | ||||
| parameter:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition | ||||
 value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
 valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
 valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelName |
ΣC | 1..1 | BackboneElement | What model Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelVersion |
ΣC | 1..1 | BackboneElement | What version Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelNamespace |
ΣC | 0..1 | BackboneElement | What namespace Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelUrl |
ΣC | 1..1 | BackboneElement | What url Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:patientClassName |
ΣC | 0..1 | BackboneElement | Name of the patient class in the model Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientClassName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:patientBirthDatePropertyName |
ΣC | 0..1 | BackboneElement | Name of the birthdate property of the Patient class in the model Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientBirthDatePropertyName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:targetQualifier |
ΣC | 0..1 | BackboneElement | Model target qualifier Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetQualifier | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:targetUrl |
ΣC | 0..1 | BackboneElement | Model target url Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetUrl | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:useCqlPrimitives |
ΣC | 0..1 | BackboneElement | Map to CQL primitives? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: useCqlPrimitives | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:includeMetadata |
ΣC | 0..1 | BackboneElement | Include definitions, comments, bindings and other metadata? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: includeMetadata | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:createSliceElements |
ΣC | 0..1 | BackboneElement | Create slice and extension elements? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: createSliceElements | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:flatten |
ΣC | 0..1 | BackboneElement | Create flattened classes? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: flatten | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:dependency |
ΣC | 0..* | BackboneElement | Required model information Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: dependency | ||||
 value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
 valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| Slices for part |
Σ | 4..4 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
| part:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelNamespace |
Σ | 1..1 | BackboneElement | Namespace of the required model (i.e. packageId) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelName |
Σ | 1..1 | BackboneElement | Name of the required model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelVersion |
Σ | 1..1 | BackboneElement | Version of the required model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelUrl |
Σ | 1..1 | BackboneElement | Url of the required model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:profile |
ΣC | 0..* | BackboneElement | Profile configuration Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: profile | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| Slices for part |
Σ | 1..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
| part:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:url |
Σ | 1..1 | BackboneElement | Url of the profile | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: url | ||||
| value[x] |
ΣC | 1..1 | uri | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:isIncluded |
Σ | 0..1 | BackboneElement | Included in the model? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isIncluded | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:isRetrievable |
Σ | 0..1 | BackboneElement | Can be the target of a retrieve expression? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isRetrievable | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:label |
Σ | 0..1 | BackboneElement | Label for the class | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: label | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:primaryCodePath |
Σ | 0..1 | BackboneElement | Primary code path for the class | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: primaryCodePath | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Parameters.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Parameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelVersion, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrl, Parameters.parameter:useCqlPrimitives, Parameters.parameter:includeMetadata, Parameters.parameter:createSliceElements, Parameters.parameter:flatten, Parameters.parameter:dependency, Parameters.parameter:profile | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
This structure is derived from Parameters
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters | Operation Request or Response | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for parameter |
ΣC | 0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 |
| parameter:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition |
| parameter:modelName |
ΣC | 1..1 | BackboneElement | What model Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:modelVersion |
ΣC | 1..1 | BackboneElement | What version Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:modelNamespace |
ΣC | 0..1 | BackboneElement | What namespace Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:modelUrl |
ΣC | 1..1 | BackboneElement | What url Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:patientClassName |
ΣC | 0..1 | BackboneElement | Name of the patient class in the model Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientClassName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:patientBirthDatePropertyName |
ΣC | 0..1 | BackboneElement | Name of the birthdate property of the Patient class in the model Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientBirthDatePropertyName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:targetQualifier |
ΣC | 0..1 | BackboneElement | Model target qualifier Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetQualifier |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:targetUrl |
ΣC | 0..1 | BackboneElement | Model target url Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetUrl |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:useCqlPrimitives |
ΣC | 0..1 | BackboneElement | Map to CQL primitives? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: useCqlPrimitives |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:includeMetadata |
ΣC | 0..1 | BackboneElement | Include definitions, comments, bindings and other metadata? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: includeMetadata |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:createSliceElements |
ΣC | 0..1 | BackboneElement | Create slice and extension elements? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: createSliceElements |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:flatten |
ΣC | 0..1 | BackboneElement | Create flattened classes? Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: flatten |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| parameter:dependency |
ΣC | 0..* | BackboneElement | Required model information Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: dependency |
| Slices for part |
Σ | 4..4 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
| part:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition |
| part:modelNamespace |
Σ | 1..1 | BackboneElement | Namespace of the required model (i.e. packageId) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:modelName |
Σ | 1..1 | BackboneElement | Name of the required model |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:modelVersion |
Σ | 1..1 | BackboneElement | Version of the required model |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:modelUrl |
Σ | 1..1 | BackboneElement | Url of the required model |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| parameter:profile |
ΣC | 0..* | BackboneElement | Profile configuration Constraints: inv-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: profile |
| Slices for part |
Σ | 1..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
| part:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition |
| part:url |
Σ | 1..1 | BackboneElement | Url of the profile |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: url |
| value[x] |
ΣC | 1..1 | uri | If parameter is a data type |
| part:isIncluded |
Σ | 0..1 | BackboneElement | Included in the model? |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isIncluded |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| part:isRetrievable |
Σ | 0..1 | BackboneElement | Can be the target of a retrieve expression? |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isRetrievable |
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type |
| part:label |
Σ | 0..1 | BackboneElement | Label for the class |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: label |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| part:primaryCodePath |
Σ | 0..1 | BackboneElement | Primary code path for the class |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: primaryCodePath |
| value[x] |
ΣC | 1..1 | string | If parameter is a data type |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Parameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelVersion, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrl, Parameters.parameter:useCqlPrimitives, Parameters.parameter:includeMetadata, Parameters.parameter:createSliceElements, Parameters.parameter:flatten, Parameters.parameter:dependency, Parameters.parameter:profile | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
Differential View
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters | Operation Request or Response | |
| Slices for parameter |
0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name | |
| parameter:modelName |
1..1 | BackboneElement | What model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:modelVersion |
1..1 | BackboneElement | What version | |
| name |
1..1 | string | Name from the definition Fixed Value: modelVersion | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:modelNamespace |
0..1 | BackboneElement | What namespace | |
| name |
1..1 | string | Name from the definition Fixed Value: modelNamespace | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:modelUrl |
1..1 | BackboneElement | What url | |
| name |
1..1 | string | Name from the definition Fixed Value: modelUrl | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:patientClassName |
0..1 | BackboneElement | Name of the patient class in the model | |
| name |
1..1 | string | Name from the definition Fixed Value: patientClassName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:patientBirthDatePropertyName |
0..1 | BackboneElement | Name of the birthdate property of the Patient class in the model | |
| name |
1..1 | string | Name from the definition Fixed Value: patientBirthDatePropertyName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:targetQualifier |
0..1 | BackboneElement | Model target qualifier | |
| name |
1..1 | string | Name from the definition Fixed Value: targetQualifier | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:targetUrl |
0..1 | BackboneElement | Model target url | |
| name |
1..1 | string | Name from the definition Fixed Value: targetUrl | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:useCqlPrimitives |
0..1 | BackboneElement | Map to CQL primitives? | |
| name |
1..1 | string | Name from the definition Fixed Value: useCqlPrimitives | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:includeMetadata |
0..1 | BackboneElement | Include definitions, comments, bindings and other metadata? | |
| name |
1..1 | string | Name from the definition Fixed Value: includeMetadata | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:createSliceElements |
0..1 | BackboneElement | Create slice and extension elements? | |
| name |
1..1 | string | Name from the definition Fixed Value: createSliceElements | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:flatten |
0..1 | BackboneElement | Create flattened classes? | |
| name |
1..1 | string | Name from the definition Fixed Value: flatten | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| parameter:dependency |
0..* | BackboneElement | Required model information | |
| name |
1..1 | string | Name from the definition Fixed Value: dependency | |
| Slices for part |
4..4 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
| part:modelNamespace |
1..1 | BackboneElement | Namespace of the required model (i.e. packageId) | |
| name |
1..1 | string | Name from the definition Fixed Value: modelNamespace | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:modelName |
1..1 | BackboneElement | Name of the required model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelName | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:modelVersion |
1..1 | BackboneElement | Version of the required model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelVersion | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:modelUrl |
1..1 | BackboneElement | Url of the required model | |
| name |
1..1 | string | Name from the definition Fixed Value: modelUrl | |
| value[x] |
1..1 | string | If parameter is a data type | |
| parameter:profile |
0..* | BackboneElement | Profile configuration | |
| name |
1..1 | string | Name from the definition Fixed Value: profile | |
| Slices for part |
1..5 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
| part:url |
1..1 | BackboneElement | Url of the profile | |
| name |
1..1 | string | Name from the definition Fixed Value: url | |
| value[x] |
1..1 | uri | If parameter is a data type | |
| part:isIncluded |
0..1 | BackboneElement | Included in the model? | |
| name |
1..1 | string | Name from the definition Fixed Value: isIncluded | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| part:isRetrievable |
0..1 | BackboneElement | Can be the target of a retrieve expression? | |
| name |
1..1 | string | Name from the definition Fixed Value: isRetrievable | |
| value[x] |
1..1 | boolean | If parameter is a data type | |
| part:label |
0..1 | BackboneElement | Label for the class | |
| name |
1..1 | string | Name from the definition Fixed Value: label | |
| value[x] |
1..1 | string | If parameter is a data type | |
| part:primaryCodePath |
0..1 | BackboneElement | Primary code path for the class | |
| name |
1..1 | string | Name from the definition Fixed Value: primaryCodePath | |
| value[x] |
1..1 | string | If parameter is a data type | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Parameters |
0..* | Parameters | Operation Request or Response | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| Slices for parameter |
ΣC | 0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 | ||||
| parameter:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelName |
ΣC | 1..1 | BackboneElement | What model Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelVersion |
ΣC | 1..1 | BackboneElement | What version Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelNamespace |
ΣC | 0..1 | BackboneElement | What namespace Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:modelUrl |
ΣC | 1..1 | BackboneElement | What url Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:patientClassName |
ΣC | 0..1 | BackboneElement | Name of the patient class in the model Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientClassName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:patientBirthDatePropertyName |
ΣC | 0..1 | BackboneElement | Name of the birthdate property of the Patient class in the model Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: patientBirthDatePropertyName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:targetQualifier |
ΣC | 0..1 | BackboneElement | Model target qualifier Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetQualifier | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:targetUrl |
ΣC | 0..1 | BackboneElement | Model target url Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: targetUrl | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:useCqlPrimitives |
ΣC | 0..1 | BackboneElement | Map to CQL primitives? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: useCqlPrimitives | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:includeMetadata |
ΣC | 0..1 | BackboneElement | Include definitions, comments, bindings and other metadata? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: includeMetadata | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:createSliceElements |
ΣC | 0..1 | BackboneElement | Create slice and extension elements? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: createSliceElements | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:flatten |
ΣC | 0..1 | BackboneElement | Create flattened classes? Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: flatten | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:dependency |
ΣC | 0..* | BackboneElement | Required model information Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: dependency | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| Slices for part |
Σ | 4..4 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
| part:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelNamespace |
Σ | 1..1 | BackboneElement | Namespace of the required model (i.e. packageId) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelNamespace | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelName |
Σ | 1..1 | BackboneElement | Name of the required model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelName | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelVersion |
Σ | 1..1 | BackboneElement | Version of the required model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelVersion | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:modelUrl |
Σ | 1..1 | BackboneElement | Url of the required model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: modelUrl | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:profile |
ΣC | 0..* | BackboneElement | Profile configuration Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: profile | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| Slices for part |
Σ | 1..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
| part:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition | ||||
| value[x] |
ΣC | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:url |
Σ | 1..1 | BackboneElement | Url of the profile | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: url | ||||
| value[x] |
ΣC | 1..1 | uri | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:isIncluded |
Σ | 0..1 | BackboneElement | Included in the model? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isIncluded | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:isRetrievable |
Σ | 0..1 | BackboneElement | Can be the target of a retrieve expression? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: isRetrievable | ||||
| value[x] |
ΣC | 1..1 | boolean | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:label |
Σ | 0..1 | BackboneElement | Label for the class | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: label | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| part:primaryCodePath |
Σ | 0..1 | BackboneElement | Primary code path for the class | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 1..1 | string | Name from the definition Fixed Value: primaryCodePath | ||||
| value[x] |
ΣC | 1..1 | string | If parameter is a data type | ||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Parameters.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Parameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelVersion, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrl, Parameters.parameter:useCqlPrimitives, Parameters.parameter:includeMetadata, Parameters.parameter:createSliceElements, Parameters.parameter:flatten, Parameters.parameter:dependency, Parameters.parameter:profile | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
This structure is derived from Parameters
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cql#2.0.0 based on FHIR 4.0.1. Generated 2025-07-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change