Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: category

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/structuredefinition-category

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

The category under which the resource type is presented on the official resource list.

Comment :

To allow tools to follow the same structure for user convenience.

Context of Use: Use on Element ID StructureDefinition

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . category 0..1 string URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-category
category: The category under which the resource type is presented on the official resource list.


Use on Element ID StructureDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-category
category: The category under which the resource type is presented on the official resource list.


Use on Element ID StructureDefinition
. . . Slices for extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/structuredefinition-category"
. . . value[x] I 1..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- category -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // category
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", // R! 
    "

    "valueString" : "<string>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . category 0..1 string URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-category
category: The category under which the resource type is presented on the official resource list.


Use on Element ID StructureDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-category
category: The category under which the resource type is presented on the official resource list.


Use on Element ID StructureDefinition
. . . Slices for extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/structuredefinition-category"
. . . value[x] I 1..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- category -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // category
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", // R! 
    "

    "valueString" : "<string>" // C? R! Value of extension

  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )

Examples of this extension