{ "description": "A container for a single allowable parameter combination.", "_filename": "StructureDefinition-capabilitystatement-search-parameter-combination.json", "package_name": "hl7.fhir.core", "date": "2014-04-12", "derivation": "constraint", "publisher": "Health Level Seven, Inc. - [WG Name] WG", "fhirVersion": "3.2.0", "name": "search-parameter-combination", "mapping": [ { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" } ], "abstract": false, "type": "Extension", "experimental": null, "resourceType": "StructureDefinition", "title": "Search Parameter Combination", "package_version": "3.2.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fhir" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "snapshot": { "element": [ { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension", "min": 0, "definition": "A container for a single allowable parameter combination.", "isModifier": false, "short": "An allowable parameter combination", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A", "identity": "rim" } ], "max": "*", "id": "Extension", "condition": [ "ele-1" ], "comment": "If a search combination is specified, clients should expect that they must submit that required combination or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations.", "base": { "max": "*", "min": 0, "path": "Extension" } }, { "path": "Extension.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Extension.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Extension.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension", "min": 1, "definition": "A search parameter name in the combination which is required.", "isModifier": false, "short": "A required search parameter name", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "sliceName": "required", "max": "*", "id": "Extension.extension:required", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:required.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Extension.extension.extension", "min": 0, "definition": "An Extension", "short": "Extension", "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "max": "0", "id": "Extension.extension:required.extension", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "required", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "uri" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:required.url", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "path": "Extension.extension.valueString", "min": 0, "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "short": "Value of extension", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Extension.extension:required.valueString", "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "path": "Extension.extension", "min": 0, "definition": "A search parameter name in the combination which is optional.", "isModifier": false, "short": "An optional search parameter name", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "sliceName": "optional", "max": "*", "id": "Extension.extension:optional", "comment": "If a defined parameter is not listed as a required or optional parameter, the implication is that the parameter is not supported with this combination. Servers may ignore It, though some may return an error if it is used.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:optional.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Extension.extension.extension", "min": 0, "definition": "An Extension", "short": "Extension", "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "max": "0", "id": "Extension.extension:optional.extension", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "optional", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "uri" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:optional.url", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "path": "Extension.extension.valueString", "min": 0, "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "short": "Value of extension", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Extension.extension:optional.valueString", "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "path": "Extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "uri" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.url", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "path": "Extension.value[x]", "min": 0, "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "short": "Value of extension", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Dosage" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Meta" } ], "max": "0", "id": "Extension.value[x]", "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } } ] }, "status": "draft", "id": "767e280e-faa6-47bc-8b39-945817e9cfeb", "kind": "complex-type", "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "context": [ "CapabilityStatement.rest.resource" ], "version": null, "differential": { "element": [ { "path": "Extension", "min": 0, "definition": "A container for a single allowable parameter combination.", "isModifier": false, "short": "An allowable parameter combination", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A", "identity": "rim" } ], "max": "*", "id": "Extension", "comment": "If a search combination is specified, clients should expect that they must submit that required combination or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations." }, { "path": "Extension.extension", "min": 1, "definition": "A search parameter name in the combination which is required.", "isModifier": false, "short": "A required search parameter name", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "sliceName": "required", "max": "*", "id": "Extension.extension:required" }, { "id": "Extension.extension:required.extension", "max": "0", "path": "Extension.extension.extension" }, { "id": "Extension.extension:required.url", "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "required" }, { "id": "Extension.extension:required.valueString", "path": "Extension.extension.valueString", "type": [ { "code": "string" } ] }, { "path": "Extension.extension", "min": 0, "definition": "A search parameter name in the combination which is optional.", "isModifier": false, "short": "An optional search parameter name", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "sliceName": "optional", "max": "*", "id": "Extension.extension:optional", "comment": "If a defined parameter is not listed as a required or optional parameter, the implication is that the parameter is not supported with this combination. Servers may ignore It, though some may return an error if it is used." }, { "id": "Extension.extension:optional.extension", "max": "0", "path": "Extension.extension.extension" }, { "id": "Extension.extension:optional.url", "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "optional" }, { "id": "Extension.extension:optional.valueString", "path": "Extension.extension.valueString", "type": [ { "code": "string" } ] }, { "id": "Extension.url", "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "id": "Extension.value[x]", "max": "0", "min": 0, "path": "Extension.value[x]" } ] }, "contact": [ { "telecom": [ { "value": "http://hl7.org/special/committees/fhir.htm", "system": "url" } ] } ], "contextType": "resource", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension" }