ExpansionProfile - FHIR Resource (stu3)
This ExpansionProfile Resource uses the FHIR API standard for access and structure.
Validate an ExpansionProfile FHIR Resource (stu3)
ExpansionProfile Attributes
AttributeField is listTypeDescription
Description: Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"excludeNotForUI": Learn more about the (ExpansionProfile) excludeNotForUI FHIR attribute
Description: Controls behaviour of the value set expand operation when value sets are too large to be completely expanded
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"limitedExpansion": Learn more about the (ExpansionProfile) limitedExpansion FHIR attribute
Description: Intended jurisdiction for expansion profile (if applicable)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
}
]
}
]Learn more about the (ExpansionProfile) jurisdiction FHIR attribute
Description: Include or exclude inactive concepts in the expansion
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"activeOnly": Learn more about the (ExpansionProfile) activeOnly FHIR attribute
Description: Business version of the expansion profile
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "0.1"Learn more about the (ExpansionProfile) version FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (ExpansionProfile) status FHIR attribute
Description: Natural language description of the expansion profile
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "exanple ExpansionProfile for publication"Learn more about the (ExpansionProfile) description FHIR attribute
Description: Systems/Versions to be exclude
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"excludedSystem": Learn more about the (ExpansionProfile) excludedSystem FHIR attribute
Description: Context the content is intended to support
FHIR Version: stu3
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (ExpansionProfile) useContext FHIR attribute
Description: Date this was last changed
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2016-12-23"Learn more about the (ExpansionProfile) date FHIR attribute
Description: Whether the expansion should include concept designations
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"includeDesignations": Learn more about the (ExpansionProfile) includeDesignations FHIR attribute
Description: Fix use of a code system to a particular version
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fixedVersion": Learn more about the (ExpansionProfile) fixedVersion FHIR attribute
Description: Include or exclude codes which are post coordinated expressions in the value set expansion
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"excludePostCoordinated": Learn more about the (ExpansionProfile) excludePostCoordinated FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "HL7 International"Learn more about the (ExpansionProfile) publisher FHIR attribute
Description: Name for this expansion profile (computer friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "Example Expansion Profile"Learn more about the (ExpansionProfile) name FHIR attribute
Description: When the expansion profile imposes designation contraints
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"designation": Learn more about the (ExpansionProfile) designation FHIR attribute
Description: Logical URI to reference this expansion profile (globally unique)
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://hl7.org/fhir/ExpansionProfile/example"Learn more about the (ExpansionProfile) url FHIR attribute
Description: Specify the language for the display element of codes in the value set expansion
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"displayLanguage": Learn more about the (ExpansionProfile) displayLanguage FHIR attribute
Description: Include or exclude the value set definition in the expansion
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"includeDefinition": Learn more about the (ExpansionProfile) includeDefinition FHIR attribute
Description: Contact details for the publisher
FHIR Version: stu3
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"name": "FHIR project team"
}
]Learn more about the (ExpansionProfile) contact FHIR attribute
Description: Nested codes in the expansion or not
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"excludeNested": trueLearn more about the (ExpansionProfile) excludeNested FHIR attribute
Description: Additional identifier for the expansion profile
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": {
"system": "http://example.org/profiles",
"value": "example"
}Learn more about the (ExpansionProfile) identifier FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": trueLearn more about the (ExpansionProfile) experimental FHIR attribute
ExpansionProfile Example
{
"status": "draft",
"publisher": "HL7 International",
"name": "Example Expansion Profile",
"resourceType": "ExpansionProfile",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[ Provide Rendering ]</div>"
},
"jurisdiction": [
{
"coding": [
{
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
}
]
}
],
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"name": "FHIR project team"
}
],
"url": "http://hl7.org/fhir/ExpansionProfile/example",
"version": "0.1",
"date": "2016-12-23",
"excludeNested": true,
"identifier": {
"system": "http://example.org/profiles",
"value": "example"
},
"id": "example",
"experimental": true,
"description": "exanple ExpansionProfile for publication"
}ExpansionProfile Structure
{
"resourceType" : "ExpansionProfile",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical URI to reference this expansion profile (globally unique)
"identifier" : { Identifier }, // Additional identifier for the expansion profile
"version" : "<string>", // Business version of the expansion profile
"name" : "<string>", // Name for this expansion profile (computer friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date this was last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the expansion profile
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for expansion profile (if applicable)
"fixedVersion" : [{ // Fix use of a code system to a particular version
"system" : "<uri>", // R! System to have its version fixed
"version" : "<string>", // R! Specific version of the code system referred to
"mode" : "<code>" // R! default | check | override
}],
"excludedSystem" : { // Systems/Versions to be exclude
"system" : "<uri>", // R! The specific code system to be excluded
"version" : "<string>" // Specific version of the code system referred to
},
"includeDesignations" : <boolean>, // Whether the expansion should include concept designations
"designation" : { // When the expansion profile imposes designation contraints
"include" : { // Designations to be included
"designation" : [{ // The designation to be included
"language" : "<code>", // Human language of the designation to be included
"use" : { Coding } // What kind of Designation to include
}]
},
"exclude" : { // Designations to be excluded
"designation" : [{ // The designation to be excluded
"language" : "<code>", // Human language of the designation to be excluded
"use" : { Coding } // What kind of Designation to exclude
}]
}
},
"includeDefinition" : <boolean>, // Include or exclude the value set definition in the expansion
"activeOnly" : <boolean>, // Include or exclude inactive concepts in the expansion
"excludeNested" : <boolean>, // Nested codes in the expansion or not
"excludeNotForUI" : <boolean>, // Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
"excludePostCoordinated" : <boolean>, // Include or exclude codes which are post coordinated expressions in the value set expansion
"displayLanguage" : "<code>", // Specify the language for the display element of codes in the value set expansion
"limitedExpansion" : <boolean> // Controls behaviour of the value set expand operation when value sets are too large to be completely expanded
}
ExpansionProfile Search Parameters
The following search parameters can be used to query ExpansionProfile resources. Just submit them like so:
https://api.1up.health/fhir/stu3/ExpansionProfile?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | date |
description | text | description |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
status | text | status |
url | uri | url |
version | text | version |
