ExpansionProfile - FHIR Resource (stu3)
This ExpansionProfile Resource uses the
FHIR API standard for access and structure.
Validate an ExpansionProfile FHIR Resource (stu3)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
activeOnly | false | boolean | Include or exclude inactive concepts in the expansion
|
contact | true | ContactDetail | Contact details for the publisher
|
date | false | dateTime | Date this was last changed
|
description | false | markdown | Natural language description of the expansion profile
|
designation | false | Data Type | When the expansion profile imposes designation contraints
|
displayLanguage | false | code | Specify the language for the display element of codes in the value set expansion
|
excludeNested | false | boolean | Nested codes in the expansion or not
|
excludeNotForUI | false | boolean | Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
|
excludePostCoordinated | false | boolean | Include or exclude codes which are post coordinated expressions in the value set expansion
|
excludedSystem | false | Data Type | Systems/Versions to be exclude
|
experimental | false | boolean | For testing purposes, not real usage
|
fixedVersion | true | Data Type | Fix use of a code system to a particular version
|
identifier | false | Identifier | Additional identifier for the expansion profile
|
includeDefinition | false | boolean | Include or exclude the value set definition in the expansion
|
includeDesignations | false | boolean | Whether the expansion should include concept designations
|
jurisdiction | true | CodeableConcept | Intended jurisdiction for expansion profile (if applicable)
|
limitedExpansion | false | boolean | Controls behaviour of the value set expand operation when value sets are too large to be completely expanded
|
name | false | string | Name for this expansion profile (computer friendly)
|
publisher | false | string | Name of the publisher (organization or individual)
|
status | false | code | draft | active | retired | unknown
|
url | false | uri | Logical URI to reference this expansion profile (globally unique)
|
useContext | true | UsageContext | Context the content is intended to support
|
version | false | string | Business version of the expansion profile
|
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 the 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 |