FHIR IG Statistics: StructureDefinition/capabilitystatement-expectation

Resources that use this resource

No resources found

Resources that this resource uses

Examples of Use for Extension

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition capabilitystatement-expectation

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1	Extension	SHALL | SHOULD | MAY |SHOULD-NOT
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
value[x]		1..1	code	Value of extension Binding: ConformanceExpectation (required): Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification.
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "capabilitystatement-expectation",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-bind"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.5.1049"
    }
  ],
  "version": "5.3.0-ballot-tc1",
  "name": "CSExpectation",
  "title": "CapabilityStatement Expectation",
  "status": "active",
  "experimental": false,
  "date": "2022-08-14",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "Defines the level of expectation associated with a given system capability.  See the capabilitystatement-prohibited modifier extension to set expectations to *not* support a feature.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "5.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.acceptLanguage"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.document"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.format"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.implementationGuide"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.imports"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.patchFormat"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.interaction"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.operation"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.extension"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.conditionalCreate"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.conditionalDelete"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.conditionalRead"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.conditionalUpdate"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "5.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.conditionalPatch"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.interaction"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.operation"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.readHistory"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.referencePolicy"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.searchInclude"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.searchParam"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.searchRevInclude"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.supportedProfile"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.updateCreate"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.resource.versioning"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.searchParam"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.security"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.security.cors"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement.rest.security.service"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "5.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.messaging.reliableCache"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "5.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "CapabilityStatement.messaging.supportedMessage"
    },
    {
      "type": "extension",
      "expression": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "SHALL | SHOULD | MAY |SHOULD-NOT",
        "definition": "Defines the level of expectation associated with a given system capability.",
        "comment": "If \"SHALL NOT\" is desired, use the \"prohibited\" modifier extension.  This extension should only be used with CapabilityStatements documenting requirements, not those documenting actual system capabilities.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "id"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a 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.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Value of extension",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "condition": [
          "ext-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "ConformanceExpectation"
            }
          ],
          "strength": "required",
          "description": "Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification.",
          "valueSet": "http://terminology.hl7.org/ValueSet/conformance-expectation"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "SHALL | SHOULD | MAY |SHOULD-NOT",
        "definition": "Defines the level of expectation associated with a given system capability.",
        "comment": "If \"SHALL NOT\" is desired, use the \"prohibited\" modifier extension.  This extension should only be used with CapabilityStatements documenting requirements, not those documenting actual system capabilities.",
        "min": 0,
        "max": "1",
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "ConformanceExpectation"
            }
          ],
          "strength": "required",
          "description": "Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification.",
          "valueSet": "http://terminology.hl7.org/ValueSet/conformance-expectation"
        }
      }
    ]
  }
}