Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Extension: security-category

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: security-category

Title: Security Category

Modifier: This extension is not a modifier extension

Status: draft

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

Committee: FHIR Infrastructure Work Group

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

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	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
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]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // security-category
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", // R! 
    "valueCode" : "<code>" // I 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	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
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]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // security-category
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", // R! 
    "valueCode" : "<code>" // I 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)

Search

No Search Extensions defined for this resource

Examples of this extension