This page is part of the FHIR Specification (v4.3.0-snapshot1: Release 4B 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: security-category

URL for this extension:

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

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

Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete the resource.

Comment:

This is only guidance; applications must perform their own analysis to meet their own requirements.

Context of Use: Use on Element ID StructureDefinition

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
security-category		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category security-category: Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete the resource. Binding: ResourceSecurityCategory (required): Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete a resource. Use on Element ID StructureDefinition
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category security-category: Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete the resource. Use on Element ID StructureDefinition
Slices for extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category"
value[x]		1..1	code	Value of extension Binding: ResourceSecurityCategory (required): Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete a resource.
Documentation for this format

XML Template

<!-- security-category -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // security-category
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", // R! 
    "valueCode" : "<code>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
security-category		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category security-category: Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete the resource. Binding: ResourceSecurityCategory (required): Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete a resource. Use on Element ID StructureDefinition
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category security-category: Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete the resource. Use on Element ID StructureDefinition
Slices for extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category"
value[x]		1..1	code	Value of extension Binding: ResourceSecurityCategory (required): Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete a resource.
Documentation for this format

XML Template

<!-- security-category -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // security-category
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", // R! 
    "valueCode" : "<code>" // C? R! Value of extension
  }

Constraints

• ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
• 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)