ExpansionProfile - FHIR Resource (stu3)


This ExpansionProfile Resource uses the FHIR API standard for access and structure.

Validate an ExpansionProfile FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activeOnlyfalseboolean Include or exclude inactive concepts in the expansion
contacttrueContactDetail Contact details for the publisher
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the expansion profile
designationfalseData Type When the expansion profile imposes designation contraints
displayLanguagefalsecode Specify the language for the display element of codes in the value set expansion
excludeNestedfalseboolean Nested codes in the expansion or not
excludeNotForUIfalseboolean Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
excludePostCoordinatedfalseboolean Include or exclude codes which are post coordinated expressions in the value set expansion
excludedSystemfalseData Type Systems/Versions to be exclude
experimentalfalseboolean For testing purposes, not real usage
fixedVersiontrueData Type Fix use of a code system to a particular version
identifierfalseIdentifier Additional identifier for the expansion profile
includeDefinitionfalseboolean Include or exclude the value set definition in the expansion
includeDesignationsfalseboolean Whether the expansion should include concept designations
jurisdictiontrueCodeableConcept Intended jurisdiction for expansion profile (if applicable)
limitedExpansionfalseboolean Controls behaviour of the value set expand operation when value sets are too large to be completely expanded
namefalsestring Name for this expansion profile (computer friendly)
publisherfalsestring Name of the publisher (organization or individual)
statusfalsecode draft | active | retired | unknown
urlfalseuri Logical URI to reference this expansion profile (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring 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 ParameterField TypeResource Fields Searched
datedatedate
descriptiontextdescription
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
urluriurl
versiontextversion