Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: DeclaredProfile

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile

Version: 5.0.0-ballot

Name: DeclaredProfile

Title: Declared Profile

Modifier: This extension is not a modifier extension

Status: draft

Definition: This extension identifies a profile the system will recognize if it is declared in [`meta.profile`](resource.html#profile-tags). If the system supports the [`_profile`](search.html#profile) search parameter, it will be capable of searching on the profile. The system may support validation against the profile.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

This extension identifies a profile the system will recognize if it is declared in meta.profile. If the system supports the _profile search parameter, it will be capable of searching on the profile. The system may support validation against the profile.

Comment:

For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required.

Context of Use: Use on Element ID CapabilityStatement.rest.resource

Summary

Name	Flags	Card.	Type	Description & Constraints
DeclaredProfile		0..*	canonical(StructureDefinition)	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile DeclaredProfile: This extension identifies a profile the system will recognize if it is declared in meta.profile. If the system supports the _profile search parameter, it will be capable of searching on the profile. The system may support validation against the profile. Use on Element ID CapabilityStatement.rest.resource
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile DeclaredProfile: This extension identifies a profile the system will recognize if it is declared in meta.profile. If the system supports the _profile search parameter, it will be capable of searching on the profile. The system may support validation against the profile. Use on Element ID CapabilityStatement.rest.resource
extension	0..0
url	1..1	uri	"capabilitystatement-declared-profile"
value[x]	1..1	canonical(StructureDefinition)	Value of extension
Documentation for this format

XML Template

<!-- DeclaredProfile -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile" >
  <!-- from Element: extension -->
 <valueCanonical value="[canonical]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // DeclaredProfile
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "capabilitystatement-declared-profile", // R! 
    "valueCanonical" : "<canonical>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
DeclaredProfile		0..*	canonical(StructureDefinition)	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile DeclaredProfile: This extension identifies a profile the system will recognize if it is declared in meta.profile. If the system supports the _profile search parameter, it will be capable of searching on the profile. The system may support validation against the profile. Use on Element ID CapabilityStatement.rest.resource
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile DeclaredProfile: This extension identifies a profile the system will recognize if it is declared in meta.profile. If the system supports the _profile search parameter, it will be capable of searching on the profile. The system may support validation against the profile. Use on Element ID CapabilityStatement.rest.resource
extension	0..0
url	1..1	uri	"capabilitystatement-declared-profile"
value[x]	1..1	canonical(StructureDefinition)	Value of extension
Documentation for this format

XML Template

<!-- DeclaredProfile -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-declared-profile" >
  <!-- from Element: extension -->
 <valueCanonical value="[canonical]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // DeclaredProfile
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "capabilitystatement-declared-profile", // R! 
    "valueCanonical" : "<canonical>" // 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

No examples found.